The Microsoft Azure Definitions File is a configuration file that contains information about resources and services within the Azure cloud computing platform. It includes definitions for various components such as virtual machines, databases, storage accounts, and networking setups. This file helps users define and manage their resources in a structured and organized manner, ensuring consistency and accuracy in their Azure environments.
swagger: '2.0'
info:
version: 2023-05-01-preview
description: A spec file containing all the definitions
title: Microsoft Azure Definitions file
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow.
scopes:
user_impersonation: impersonate your user account
paths: {}
definitions:
AccessInformationCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/AccessInformationContract'
description: Page values.
readOnly: true
count:
type: integer
format: int64
description: Total record count number across all pages.
nextLink:
type: string
description: Next page link if any.
readOnly: true
description: Paged AccessInformation list representation.
AccessInformationContract:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/AccessInformationContractProperties'
description: AccessInformation entity contract properties.
allOf:
- $ref: >-
./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
description: Tenant Settings.
AccessInformationContractProperties:
type: object
properties:
id:
type: string
description: Access Information type ('access' or 'gitAccess')
principalId:
type: string
description: Principal (User) Identifier.
enabled:
type: boolean
description: Determines whether direct access is enabled.
description: Tenant access information contract of the API Management service.
AccessInformationSecretsContract:
type: object
properties:
id:
type: string
description: Access Information type ('access' or 'gitAccess')
principalId:
type: string
description: Principal (User) Identifier.
primaryKey:
type: string
x-ms-secret: true
description: >-
Primary access key. This property will not be filled on 'GET'
operations! Use '/listSecrets' POST request to get the value.
secondaryKey:
type: string
x-ms-secret: true
description: >-
Secondary access key. This property will not be filled on 'GET'
operations! Use '/listSecrets' POST request to get the value.
enabled:
type: boolean
description: Determines whether direct access is enabled.
description: Tenant access information contract of the API Management service.
AccessInformationCreateParameters:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/AccessInformationCreateParameterProperties'
description: Tenant access information update parameter properties.
description: Tenant access information update parameters.
AccessInformationCreateParameterProperties:
type: object
properties:
principalId:
type: string
description: Principal (User) Identifier.
primaryKey:
type: string
x-ms-secret: true
description: >-
Primary access key. This property will not be filled on 'GET'
operations! Use '/listSecrets' POST request to get the value.
secondaryKey:
type: string
x-ms-secret: true
description: >-
Secondary access key. This property will not be filled on 'GET'
operations! Use '/listSecrets' POST request to get the value.
enabled:
type: boolean
description: Determines whether direct access is enabled.
description: Tenant access information update parameters of the API Management service
AccessInformationUpdateParameters:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/AccessInformationUpdateParameterProperties'
description: Tenant access information update parameter properties.
description: Tenant access information update parameters.
AccessInformationUpdateParameterProperties:
type: object
properties:
enabled:
type: boolean
description: Determines whether direct access is enabled.
description: Tenant access information update parameters of the API Management service
TenantSettingsCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/TenantSettingsContract'
description: Page values.
readOnly: true
nextLink:
type: string
description: Next page link if any.
readOnly: true
description: Paged AccessInformation list representation.
TenantSettingsContract:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/TenantSettingsContractProperties'
description: TenantSettings entity contract properties.
allOf:
- $ref: >-
./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
description: Tenant Settings.
TenantSettingsContractProperties:
type: object
properties:
settings:
type: object
additionalProperties:
type: string
description: Tenant settings
description: Tenant access information contract of the API Management service.
ApiCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/ApiContract'
description: Page values.
readOnly: true
count:
type: integer
format: int64
description: Total record count number across all pages.
nextLink:
type: string
description: Next page link if any.
readOnly: true
description: Paged API list representation.
DocumentationCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/DocumentationContract'
x-ms-identifiers:
- name
description: Page values.
readOnly: true
nextLink:
type: string
description: Next page link if any.
readOnly: true
description: Paged Documentation list representation.
WikiCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/WikiContract'
x-ms-identifiers:
- name
description: Page values.
readOnly: true
nextLink:
type: string
description: Next page link if any.
readOnly: true
description: Paged Wiki list representation.
ApiContract:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/ApiContractProperties'
description: API entity contract properties.
allOf:
- $ref: >-
./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
description: API details.
ApiContractProperties:
type: object
properties:
sourceApiId:
type: string
description: API identifier of the source API.
displayName:
type: string
description: API name. Must be 1 to 300 characters long.
minLength: 1
maxLength: 300
serviceUrl:
type: string
description: >-
Absolute URL of the backend service implementing this API. Cannot be
more than 2000 characters long.
minLength: 0
maxLength: 2000
path:
type: string
description: >-
Relative URL uniquely identifying this API and all of its resource
paths within the API Management service instance. It is appended to
the API endpoint base URL specified during the service instance
creation to form a public URL for this API.
minLength: 0
maxLength: 400
protocols:
type: array
items:
type: string
enum:
- http
- https
- ws
- wss
x-ms-enum:
name: Protocol
modelAsString: true
description: >-
Describes on which protocols the operations in this API can be
invoked.
apiVersionSet:
description: Version set details
$ref: '#/definitions/ApiVersionSetContractDetails'
provisioningState:
type: string
readOnly: true
description: The provisioning state
allOf:
- $ref: '#/definitions/ApiEntityBaseContract'
required:
- path
description: API Entity Properties
ApiCreateOrUpdateParameter:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/ApiCreateOrUpdateProperties'
description: API entity create of update properties.
description: API Create or Update Parameters.
ApiCreateOrUpdateProperties:
type: object
properties:
value:
type: string
description: Content value when Importing an API.
format:
type: string
description: >-
Format of the Content in which the API is getting imported. New
formats can be added in the future
enum:
- wadl-xml
- wadl-link-json
- swagger-json
- swagger-link-json
- wsdl
- wsdl-link
- openapi
- openapi+json
- openapi-link
- openapi+json-link
- graphql-link
- odata
- odata-link
- grpc
- grpc-link
x-ms-enum:
name: ContentFormat
modelAsString: true
values:
- value: wadl-xml
description: The contents are inline and Content type is a WADL document.
- value: wadl-link-json
description: >-
The WADL document is hosted on a publicly accessible internet
address.
- value: swagger-json
description: >-
The contents are inline and Content Type is a OpenAPI 2.0 JSON
Document.
- value: swagger-link-json
description: >-
The OpenAPI 2.0 JSON document is hosted on a publicly accessible
internet address.
- value: wsdl
description: >-
The contents are inline and the document is a WSDL/Soap
document.
- value: wsdl-link
description: >-
The WSDL document is hosted on a publicly accessible internet
address.
- value: openapi
description: >-
The contents are inline and Content Type is a OpenAPI 3.0 YAML
Document.
- value: openapi+json
description: >-
The contents are inline and Content Type is a OpenAPI 3.0 JSON
Document.
- value: openapi-link
description: >-
The OpenAPI 3.0 YAML document is hosted on a publicly accessible
internet address.
- value: openapi+json-link
description: >-
The OpenAPI 3.0 JSON document is hosted on a publicly accessible
internet address.
- value: graphql-link
description: >-
The GraphQL API endpoint hosted on a publicly accessible
internet address.
- value: odata
description: >-
The contents are inline and Content Type is a OData XML
Document.
- value: odata-link
description: >-
The OData metadata document hosted on a publicly accessible
internet address.
- value: grpc
description: >-
The contents are inline and Content Type is a gRPC protobuf
file.
- value: grpc-link
description: >-
The gRPC protobuf file is hosted on a publicly accessible
internet address.
wsdlSelector:
type: object
description: Criteria to limit import of WSDL to a subset of the document.
properties:
wsdlServiceName:
type: string
description: Name of service to import from WSDL
wsdlEndpointName:
type: string
description: Name of endpoint(port) to import from WSDL
apiType:
type: string
description: |-
Type of API to create.
* `http` creates a REST API
* `soap` creates a SOAP pass-through API
* `websocket` creates websocket API
* `graphql` creates GraphQL API.
New types can be added in the future.
enum:
- http
- soap
- websocket
- graphql
- odata
- grpc
x-ms-client-name: SoapApiType
x-ms-enum:
name: SoapApiType
modelAsString: true
values:
- value: http
description: Imports a SOAP API having a RESTful front end.
name: SoapToRest
- value: soap
description: Imports the SOAP API having a SOAP front end.
name: SoapPassThrough
- value: websocket
description: Imports the API having a Websocket front end.
name: WebSocket
- value: graphql
description: Imports the API having a GraphQL front end.
name: GraphQL
- value: odata
description: Imports the API having a OData front end.
name: OData
- value: grpc
description: Imports the API having a gRPC front end.
name: gRPC
translateRequiredQueryParameters:
type: string
description: >-
Strategy of translating required query parameters to template ones. By
default has value 'template'. Possible values: 'template', 'query'
enum:
- template
- query
x-ms-client-name: TranslateRequiredQueryParametersConduct
x-ms-enum:
name: TranslateRequiredQueryParametersConduct
modelAsString: true
values:
- value: template
description: >-
Translates required query parameters to template ones. Is a
default value
name: Template
- value: query
description: >-
Leaves required query parameters as they are (no translation
done).
name: Query
allOf:
- $ref: '#/definitions/ApiContractProperties'
description: API Create or Update Properties.
ApiEntityBaseContract:
type: object
properties:
description:
type: string
description: Description of the API. May include HTML formatting tags.
authenticationSettings:
$ref: '#/definitions/AuthenticationSettingsContract'
description: Collection of authentication settings included into this API.
subscriptionKeyParameterNames:
$ref: '#/definitions/SubscriptionKeyParameterNamesContract'
description: Protocols over which API is made available.
type:
type: string
description: Type of API.
enum:
- http
- soap
- websocket
- graphql
- odata
- grpc
x-ms-client-name: ApiType
x-ms-enum:
name: ApiType
modelAsString: true
apiRevision:
type: string
description: >-
Describes the revision of the API. If no value is provided, default
revision 1 is created
minLength: 1
maxLength: 100
apiVersion:
type: string
description: Indicates the version identifier of the API if the API is versioned
maxLength: 100
isCurrent:
type: boolean
description: Indicates if API revision is current api revision.
isOnline:
type: boolean
description: Indicates if API revision is accessible via the gateway.
readOnly: true
apiRevisionDescription:
type: string
description: Description of the API Revision.
maxLength: 256
apiVersionDescription:
type: string
description: Description of the API Version.
maxLength: 256
apiVersionSetId:
type: string
description: A resource identifier for the related ApiVersionSet.
subscriptionRequired:
type: boolean
description: >-
Specifies whether an API or Product subscription is required for
accessing the API.
termsOfServiceUrl:
type: string
description: ' A URL to the Terms of Service for the API. MUST be in the format of a URL.'
contact:
$ref: '#/definitions/ApiContactInformation'
description: Contact information for the API.
license:
$ref: '#/definitions/ApiLicenseInformation'
description: License information for the API.
description: API base contract details.
ApiContactInformation:
type: object
properties:
name:
type: string
description: The identifying name of the contact person/organization
url:
type: string
description: >-
The URL pointing to the contact information. MUST be in the format of
a URL
email:
type: string
description: >-
The email address of the contact person/organization. MUST be in the
format of an email address
description: API contact information
ApiLicenseInformation:
type: object
description: API license information
properties:
name:
type: string
description: The license name used for the API
url:
type: string
description: A URL to the license used for the API. MUST be in the format of a URL
ApiExportResult:
type: object
properties:
id:
type: string
description: ResourceId of the API which was exported.
format:
type: string
enum:
- swagger-link-json
- wadl-link-json
- wsdl-link+xml
- openapi-link
x-ms-client-name: ExportResultFormat
x-ms-enum:
name: ExportResultFormat
modelAsString: true
values:
- value: swagger-link-json
description: >-
The API Definition is exported in OpenAPI Specification 2.0
format to the Storage Blob.
name: Swagger
- value: wsdl-link+xml
description: >-
The API Definition is exported in WSDL Schema to Storage Blob.
This is only supported for APIs of Type `soap`
name: Wsdl
- value: wadl-link-json
description: Export the API Definition in WADL Schema to Storage Blob.
name: Wadl
- value: openapi-link
description: >-
Export the API Definition in OpenAPI Specification 3.0 to
Storage Blob.
name: OpenApi
description: >-
Format in which the API Details are exported to the Storage Blob with
Sas Key valid for 5 minutes.
value:
type: object
description: The object defining the schema of the exported API Detail
properties:
link:
type: string
description: >-
Link to the Storage Blob containing the result of the export
operation. The Blob Uri is only valid for 5 minutes.
description: API Export result.
ApiReleaseCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/ApiReleaseContract'
description: Page values.
readOnly: true
count:
type: integer
format: int64
description: Total record count number across all pages.
nextLink:
type: string
description: Next page link if any.
readOnly: true
description: Paged ApiRelease list representation.
ApiReleaseContract:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/ApiReleaseContractProperties'
description: ApiRelease entity contract properties.
allOf:
- $ref: >-
./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
description: ApiRelease details.
ApiReleaseContractProperties:
type: object
properties:
apiId:
type: string
description: Identifier of the API the release belongs to.
createdDateTime:
type: string
readOnly: true
format: date-time
description: >-
The time the API was released. The date conforms to the following
format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
updatedDateTime:
type: string
readOnly: true
format: date-time
description: The time the API release was updated.
notes:
type: string
description: Release Notes
description: API Release details
ApiRevisionCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/ApiRevisionContract'
x-ms-identifiers:
- apiId
description: Page values.
readOnly: true
count:
type: integer
format: int64
description: Total record count number across all pages.
nextLink:
type: string
description: Next page link if any.
readOnly: true
description: Paged API Revision list representation.
ApiRevisionContract:
type: object
properties:
apiId:
type: string
readOnly: true
description: Identifier of the API Revision.
apiRevision:
type: string
minLength: 1
maxLength: 100
readOnly: true
description: Revision number of API.
createdDateTime:
type: string
readOnly: true
format: date-time
description: >-
The time the API Revision was created. The date conforms to the
following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601
standard.
updatedDateTime:
type: string
readOnly: true
format: date-time
description: >-
The time the API Revision were updated. The date conforms to the
following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601
standard.
description:
type: string
readOnly: true
maxLength: 256
description: Description of the API Revision.
privateUrl:
type: string
readOnly: true
description: Gateway URL for accessing the non-current API Revision.
isOnline:
type: boolean
readOnly: true
description: Indicates if API revision is the current api revision.
isCurrent:
type: boolean
readOnly: true
description: Indicates if API revision is accessible via the gateway.
description: Summary of revision metadata.
ApiRevisionInfoContract:
type: object
description: >-
Object used to create an API Revision or Version based on an existing API
Revision
properties:
sourceApiId:
type: string
description: Resource identifier of API to be used to create the revision from.
apiVersionName:
type: string
maxLength: 100
description: Version identifier for the new API Version.
apiRevisionDescription:
type: string
maxLength: 256
description: Description of new API Revision.
apiVersionSet:
description: Version set details
$ref: '#/definitions/ApiVersionSetContractDetails'
ApiTagResourceContractProperties:
type: object
properties:
id:
type: string
description: API identifier in the form /apis/{apiId}.
name:
type: string
description: API name.
minLength: 1
maxLength: 300
serviceUrl:
type: string
description: Absolute URL of the backend service implementing this API.
minLength: 1
maxLength: 2000
path:
type: string
description: >-
Relative URL uniquely identifying this API and all of its resource
paths within the API Management service instance. It is appended to
the API endpoint base URL specified during the service instance
creation to form a public URL for this API.
minLength: 0
maxLength: 400
protocols:
type: array
items:
type: string
enum:
- http
- https
- ws
- wss
x-ms-enum:
name: Protocol
modelAsString: true
description: >-
Describes on which protocols the operations in this API can be
invoked.
allOf:
- $ref: ./definitions.json#/definitions/ApiEntityBaseContract
description: API contract properties for the Tag Resources.
ApiUpdateContract:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/ApiContractUpdateProperties'
description: Properties of the API entity that can be updated.
description: API update contract details.
ApiContractUpdateProperties:
type: object
properties:
displayName:
type: string
description: API name.
minLength: 1
maxLength: 300
serviceUrl:
type: string
description: Absolute URL of the backend service implementing this API.
minLength: 1
maxLength: 2000
path:
type: string
description: >-
Relative URL uniquely identifying this API and all of its resource
paths within the API Management service instance. It is appended to
the API endpoint base URL specified during the service instance
creation to form a public URL for this API.
minLength: 0
maxLength: 400
protocols:
type: array
items:
type: string
enum:
- http
- https
- ws
- wss
x-ms-enum:
name: Protocol
modelAsString: true
description: >-
Describes on which protocols the operations in this API can be
invoked.
allOf:
- $ref: '#/definitions/ApiEntityBaseContract'
description: API update contract properties.
ApiVersionSetCollection:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/ApiVersionSetContract'
description: Page values.
count:
type: integer
format: int64
description: Total record count number across all pages.
nextLink:
type: string
description: Next page link if any.
description: Paged API Version Set list representation.
ApiVersionSetContract:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/ApiVersionSetContractProperties'
description: API VersionSet contract properties.
allOf:
- $ref: >-
./../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
description: API Version Set Contract details.
ApiVersionSetContractDetails:
type: object
description: >-
An API Version Set contains the common configuration for a set of API
Versions relating
properties:
id:
type: string
description: >-
Identifier for existing API Version Set. Omit this value to create a
new Version Set.
name:
type: string
description: The display Name of the API Version Set.
description:
type: string
description: Description of API Version Set.
versioningScheme:
type: string
description: >-
An value that determines where the API Version identifier will be
located in a HTTP request.
enum:
- Segment
- Query
- Header
x-ms-enum:
name: versioningScheme
modelAsString: true
values:
- value: Segment
description: The API Version is passed in a path segment.
- value: Query
description: The API Version is passed in a query parameter.
- value: Header
description: The API Version is passed in a HTTP header.
versionQueryName:
type: string
description: >-
Name of query parameter that indicates the API Version if
versioningScheme is set to `query`.
versionHeaderName:
type: string
description: >-
Name of HTTP header parameter that indicates the API Version if
versioningScheme is set to `header`.
ApiVersionSetContractProperties:
type: object
properties:
displayName:
type: string
description: Name of API Version Set
minLength: 1
maxLength: 100
versioningScheme:
type: string
description: >-
An value that determines where the API Version identifier will be
located in a HTTP request.
enum:
- Segment
- Query
- Header
x-ms-enum:
name: versioningScheme
modelAsString: true
values:
- value: Segment
description: The API Version is passed in a path segment.
- value: Query
description: The API Version is passed in a query parameter.
- value: Header
description: The API Version is passed in a HTTP header.
allOf:
- $ref: '#/definitions/ApiVersionSetEntityBase'
required:
- displayName
- versioningScheme
description: Properties of an API Version Set.
ApiVersionSetEntityBase:
type: object
properties:
description:
type: string
description: Description of API Version Set.
versionQueryName:
type: string
description: >-
Name of query parameter that indicates the API Version if
versioningScheme is set to `query`.
minLength: 1
maxLength: 100
versionHeaderName:
type: string
description: >-
Name of HTTP header parameter that indicates the API Version if
versioningScheme is set to `header`.
minLength: 1
maxLength: 100
description: API Version set base parameters
ApiVersionSetUpdateParameters:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/ApiVersionSetUpdateParametersProperties'
description: Parameters to update or create an API Version Set Contract.
description: Parameters to update or create an API Version Set Contract.
ApiVersionSetUpdateParametersProperties:
type: object
properties:
displayName:
type: string
description: Name of API Version Set
minLength: 1
maxLength: 100
versioningScheme:
type: string
description: >-
An value that determines where the API Version identifier will be
located in a HTTP request.
enum:
- Segment
- Query
- Header
x-ms-enum:
name: versioningScheme
modelAsString: true
values:
- value: Segment
description: The API Version is passed in a path segment.
- value: Query
description: The API Version is passed in a query parameter.
- value: Header
description: The API Version is passed in a HTTP header.
# --- truncated at 32 KB (232 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/definitions-file-openapi-original.yml