openapi-directory/api/azure.com/apimanagement-apimapis.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.","title":"ApiManagementClient","version":"2019-12-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimapis.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimapis","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis":{"get":{"description":"Lists all APIs of the API Management service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis"},"operationId":"Api_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApis":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListApis":{"value":"apimService1"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Include tags in the response.","in":"query","name":"tags","required":false,"schema":{"type":"string"}},{"description":"Include full ApiVersionSet resource in response","in":"query","name":"expandApiVersionSet","required":false,"schema":{"type":"boolean"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApis":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApis":{"value":"subid"}}}],"responses":{"200":{"description":"Paged Result response of Apis.","content":{"application/json":{"schema":{"description":"Paged Api list representation.","properties":{"nextLink":{"description":"Next page link if any.","readOnly":true,"type":"string"},"value":{"description":"Page values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Api details.","properties":{"properties":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"Api Entity Properties","properties":{"apiVersionSet":{"description":"An API Version Set contains the common configuration for a set of API Versions relating ","properties":{"description":{"description":"Description of API Version Set.","type":"string"},"id":{"description":"Identifier for existing API Version Set. Omit this value to create a new Version Set.","type":"string"},"name":{"description":"The display Name of the API Version Set.","type":"string"},"versionHeaderName":{"description":"Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.","type":"string"},"versionQueryName":{"description":"Name of query parameter that indicates the API Version if versioningScheme is set to `query`.","type":"string"},"versioningScheme":{"description":"An value that determines where the API Version identifer will be located in a HTTP request.","enum":["Segment","Query","Header"],"type":"string"}}},"displayName":{"description":"API name. Must be 1 to 300 characters long.","maxLength":300,"minLength":1,"type":"string"},"path":{"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.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.","maxLength":2000,"minLength":0,"type":"string"},"sourceApiId":{"description":"API identifier of the source API.","type":"string"}},"required":["path"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApis":{"$ref":"#/components/examples/ApiManagementListApis"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Api"],"x-ms-odata":"./definitions.json#/definitions/ApiContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}":{"delete":{"description":"Deletes the specified API of the API Management service instance.","operationId":"Api_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApi":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementDeleteApi":{"value":"apimService1"}}},{"description":"API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApi":{"value":"echo-api"}}},{"description":"Delete all revisions of the Api.","in":"query","name":"deleteRevisions","required":false,"schema":{"type":"boolean"}},{"description":"ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApi":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApi":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApi":{"value":"subid"}}}],"responses":{"200":{"description":"The API was successfully deleted."},"204":{"description":"The API was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Api"]},"get":{"description":"Gets the details of the API specified by its identifier.","operationId":"Api_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiContract":{"value":"rg1"},"ApiManagementGetApiRevisionContract":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetApiContract":{"value":"apimService1"},"ApiManagementGetApiRevisionContract":{"value":"apimService1"}}},{"description":"API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiContract":{"value":"57d1f7558aa04f15146d9d8a"},"ApiManagementGetApiRevisionContract":{"value":"echo-api;rev=3"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiContract":{"value":"2019-12-01-preview"},"ApiManagementGetApiRevisionContract":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiContract":{"value":"subid"},"ApiManagementGetApiRevisionContract":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified API entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Api details.","properties":{"properties":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"Api Entity Properties","properties":{"apiVersionSet":{"description":"An API Version Set contains the common configuration for a set of API Versions relating ","properties":{"description":{"description":"Description of API Version Set.","type":"string"},"id":{"description":"Identifier for existing API Version Set. Omit this value to create a new Version Set.","type":"string"},"name":{"description":"The display Name of the API Version Set.","type":"string"},"versionHeaderName":{"description":"Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.","type":"string"},"versionQueryName":{"description":"Name of query parameter that indicates the API Version if versioningScheme is set to `query`.","type":"string"},"versioningScheme":{"description":"An value that determines where the API Version identifer will be located in a HTTP request.","enum":["Segment","Query","Header"],"type":"string"}}},"displayName":{"description":"API name. Must be 1 to 300 characters long.","maxLength":300,"minLength":1,"type":"string"},"path":{"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.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.","maxLength":2000,"minLength":0,"type":"string"},"sourceApiId":{"description":"API identifier of the source API.","type":"string"}},"required":["path"]}}},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.sun.wadl+xml":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Api details.","properties":{"properties":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"Api Entity Properties","properties":{"apiVersionSet":{"description":"An API Version Set contains the common configuration for a set of API Versions relating ","properties":{"description":{"description":"Description of API Version Set.","type":"string"},"id":{"description":"Identifier for existing API Version Set. Omit this value to create a new Version Set.","type":"string"},"name":{"description":"The display Name of the API Version Set.","type":"string"},"versionHeaderName":{"description":"Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.","type":"string"},"versionQueryName":{"description":"Name of query parameter that indicates the API Version if versioningScheme is set to `query`.","type":"string"},"versioningScheme":{"description":"An value that determines where the API Version identifer will be located in a HTTP request.","enum":["Segment","Query","Header"],"type":"string"}}},"displayName":{"description":"API name. Must be 1 to 300 characters long.","maxLength":300,"minLength":1,"type":"string"},"path":{"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.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.","maxLength":2000,"minLength":0,"type":"string"},"sourceApiId":{"description":"API identifier of the source API.","type":"string"}},"required":["path"]}}},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.swagger.doc+json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Api details.","properties":{"properties":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"Api Entity Properties","properties":{"apiVersionSet":{"description":"An API Version Set contains the common configuration for a set of API Versions relating ","properties":{"description":{"description":"Description of API Version Set.","type":"string"},"id":{"description":"Identifier for existing API Version Set. Omit this value to create a new Version Set.","type":"string"},"name":{"description":"The display Name of the API Version Set.","type":"string"},"versionHeaderName":{"description":"Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.","type":"string"},"versionQueryName":{"description":"Name of query parameter that indicates the API Version if versioningScheme is set to `query`.","type":"string"},"versioningScheme":{"description":"An value that determines where the API Version identifer will be located in a HTTP request.","enum":["Segment","Query","Header"],"type":"string"}}},"displayName":{"description":"API name. Must be 1 to 300 characters long.","maxLength":300,"minLength":1,"type":"string"},"path":{"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.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.","maxLength":2000,"minLength":0,"type":"string"},"sourceApiId":{"description":"API identifier of the source API.","type":"string"}},"required":["path"]}}},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/wsdl+xml":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Api details.","properties":{"properties":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"Api Entity Properties","properties":{"apiVersionSet":{"description":"An API Version Set contains the common configuration for a set of API Versions relating ","properties":{"description":{"description":"Description of API Version Set.","type":"string"},"id":{"description":"Identifier for existing API Version Set. Omit this value to create a new Version Set.","type":"string"},"name":{"description":"The display Name of the API Version Set.","type":"string"},"versionHeaderName":{"description":"Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.","type":"string"},"versionQueryName":{"description":"Name of query parameter that indicates the API Version if versioningScheme is set to `query`.","type":"string"},"versioningScheme":{"description":"An value that determines where the API Version identifer will be located in a HTTP request.","enum":["Segment","Query","Header"],"type":"string"}}},"displayName":{"description":"API name. Must be 1 to 300 characters long.","maxLength":300,"minLength":1,"type":"string"},"path":{"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.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.","maxLength":2000,"minLength":0,"type":"string"},"sourceApiId":{"description":"API identifier of the source API.","type":"string"}},"required":["path"]}}},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.oai.openapi":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Api details.","properties":{"properties":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"Api Entity Properties","properties":{"apiVersionSet":{"description":"An API Version Set contains the common configuration for a set of API Versions relating ","properties":{"description":{"description":"Description of API Version Set.","type":"string"},"id":{"description":"Identifier for existing API Version Set. Omit this value to create a new Version Set.","type":"string"},"name":{"description":"The display Name of the API Version Set.","type":"string"},"versionHeaderName":{"description":"Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.","type":"string"},"versionQueryName":{"description":"Name of query parameter that indicates the API Version if versioningScheme is set to `query`.","type":"string"},"versioningScheme":{"description":"An value that determines where the API Version identifer will be located in a HTTP request.","enum":["Segment","Query","Header"],"type":"string"}}},"displayName":{"description":"API name. Must be 1 to 300 characters long.","maxLength":300,"minLength":1,"type":"string"},"path":{"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.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.","maxLength":2000,"minLength":0,"type":"string"},"sourceApiId":{"description":"API identifier of the source API.","type":"string"}},"required":["path"]}}},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.oai.openapi+json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Api details.","properties":{"properties":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"Api Entity Properties","properties":{"apiVersionSet":{"description":"An API Version Set contains the common configuration for a set of API Versions relating ","properties":{"description":{"description":"Description of API Version Set.","type":"string"},"id":{"description":"Identifier for existing API Version Set. Omit this value to create a new Version Set.","type":"string"},"name":{"description":"The display Name of the API Version Set.","type":"string"},"versionHeaderName":{"description":"Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.","type":"string"},"versionQueryName":{"description":"Name of query parameter that indicates the API Version if versioningScheme is set to `query`.","type":"string"},"versioningScheme":{"description":"An value that determines where the API Version identifer will be located in a HTTP request.","enum":["Segment","Query","Header"],"type":"string"}}},"displayName":{"description":"API name. Must be 1 to 300 characters long.","maxLength":300,"minLength":1,"type":"string"},"path":{"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.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.","maxLength":2000,"minLength":0,"type":"string"},"sourceApiId":{"description":"API identifier of the source API.","type":"string"}},"required":["path"]}}},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}},"application/vnd.sun.wadl+xml":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}},"application/vnd.swagger.doc+json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}},"application/wsdl+xml":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. Th