{"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. 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.oai.openapi":{"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.oai.openapi+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"]},"head":{"description":"Gets the entity state (Etag) version of the API specified by its identifier.","operationId":"Api_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApi":{"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":{"ApiManagementHeadApi":{"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":{"ApiManagementHeadApi":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApi":{"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":{"ApiManagementHeadApi":{"value":"subid"}}}],"responses":{"200":{"description":"Specified API entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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"]},"patch":{"description":"Updates the specified API of the API Management service instance.","operationId":"Api_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateApi":{"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":{"ApiManagementUpdateApi":{"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":{"ApiManagementUpdateApi":{"value":"echo-api"}}},{"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":{"ApiManagementUpdateApi":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateApi":{"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":{"ApiManagementUpdateApi":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"API update contract 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 update contract properties.","properties":{"displayName":{"description":"API name.","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.","maxLength":2000,"minLength":1,"type":"string"}}}}}}},"description":"API Update Contract parameters.","required":true},"responses":{"204":{"description":"The API was successfully updated."},"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"]},"put":{"description":"Creates new or updates existing specified API of the API Management service instance.","operationId":"Api_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApi":{"value":"rg1"},"ApiManagementCreateApiClone":{"value":"rg1"},"ApiManagementCreateApiNewVersionUsingExistingApi":{"value":"rg1"},"ApiManagementCreateApiRevisionFromExistingApi":{"value":"rg1"},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"value":"rg1"},"ApiManagementCreateApiUsingOai3Import":{"value":"rg1"},"ApiManagementCreateApiUsingSwaggerImport":{"value":"rg1"},"ApiManagementCreateApiUsingWadlImport":{"value":"rg1"},"ApiManagementCreateApiWithOpenIdConnect":{"value":"rg1"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":"rg1"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"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":{"ApiManagementCreateApi":{"value":"apimService1"},"ApiManagementCreateApiClone":{"value":"apimService1"},"ApiManagementCreateApiNewVersionUsingExistingApi":{"value":"apimService1"},"ApiManagementCreateApiRevisionFromExistingApi":{"value":"apimService1"},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"value":"apimService1"},"ApiManagementCreateApiUsingOai3Import":{"value":"apimService1"},"ApiManagementCreateApiUsingSwaggerImport":{"value":"apimService1"},"ApiManagementCreateApiUsingWadlImport":{"value":"apimService1"},"ApiManagementCreateApiWithOpenIdConnect":{"value":"apimService1"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":"apimService1"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"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":{"ApiManagementCreateApi":{"value":"tempgroup"},"ApiManagementCreateApiClone":{"value":"echo-api2"},"ApiManagementCreateApiNewVersionUsingExistingApi":{"value":"echoapiv3"},"ApiManagementCreateApiRevisionFromExistingApi":{"value":"echo-api;rev=3"},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"value":"apidocs"},"ApiManagementCreateApiUsingOai3Import":{"value":"petstore"},"ApiManagementCreateApiUsingSwaggerImport":{"value":"petstore"},"ApiManagementCreateApiUsingWadlImport":{"value":"petstore"},"ApiManagementCreateApiWithOpenIdConnect":{"value":"tempgroup"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":"soapApi"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"value":"soapApi"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApi":{"value":"2019-12-01-preview"},"ApiManagementCreateApiClone":{"value":"2019-12-01-preview"},"ApiManagementCreateApiNewVersionUsingExistingApi":{"value":"2019-12-01-preview"},"ApiManagementCreateApiRevisionFromExistingApi":{"value":"2019-12-01-preview"},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"value":"2019-12-01-preview"},"ApiManagementCreateApiUsingOai3Import":{"value":"2019-12-01-preview"},"ApiManagementCreateApiUsingSwaggerImport":{"value":"2019-12-01-preview"},"ApiManagementCreateApiUsingWadlImport":{"value":"2019-12-01-preview"},"ApiManagementCreateApiWithOpenIdConnect":{"value":"2019-12-01-preview"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":"2019-12-01-preview"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"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":{"ApiManagementCreateApi":{"value":"subid"},"ApiManagementCreateApiClone":{"value":"subid"},"ApiManagementCreateApiNewVersionUsingExistingApi":{"value":"subid"},"ApiManagementCreateApiRevisionFromExistingApi":{"value":"subid"},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"value":"subid"},"ApiManagementCreateApiUsingOai3Import":{"value":"subid"},"ApiManagementCreateApiUsingSwaggerImport":{"value":"subid"},"ApiManagementCreateApiUsingWadlImport":{"value":"subid"},"ApiManagementCreateApiWithOpenIdConnect":{"value":"subid"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":"subid"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"API Create or Update Parameters.","properties":{"properties":{"allOf":[{"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"]}],"description":"Api Create or Update Properties.","properties":{"apiType":{"description":"Type of Api to create. \n * `http` creates a SOAP to REST API \n * `soap` creates a SOAP pass-through API .","enum":["http","soap"],"type":"string","x-ms-client-name":"SoapApiType","x-ms-enum":{"modelAsString":true,"name":"SoapApiType","values":[{"description":"Imports a SOAP API having a RESTful front end.","name":"SoapToRest","value":"http"},{"description":"Imports the Soap API having a SOAP front end.","name":"SoapPassThrough","value":"soap"}]}},"format":{"description":"Format of the Content in which the API is getting imported.","enum":["wadl-xml","wadl-link-json","swagger-json","swagger-link-json","wsdl","wsdl-link","openapi","openapi+json","openapi-link","openapi+json-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ContentFormat","values":[{"description":"The contents are inline and Content type is a WADL document.","value":"wadl-xml"},{"description":"The WADL document is hosted on a publicly accessible internet address.","value":"wadl-link-json"},{"description":"The contents are inline and Content Type is a OpenApi 2.0 Document.","value":"swagger-json"},{"description":"The Open Api 2.0 document is hosted on a publicly accessible internet address.","value":"swagger-link-json"},{"description":"The contents are inline and the document is a WSDL/Soap document.","value":"wsdl"},{"description":"The WSDL document is hosted on a publicly accessible internet address.","value":"wsdl-link"},{"description":"The contents are inline and Content Type is a OpenApi 3.0 Document in YAML format.","value":"openapi"},{"description":"The contents are inline and Content Type is a OpenApi 3.0 Document in JSON format.","value":"openapi+json"},{"description":"The Open Api 3.0 document is hosted on a publicly accessible internet address.","value":"openapi-link"},{"description":"The Open Api 3.0 Json document is hosted on a publicly accessible internet address.","value":"openapi+json-link"}]}},"value":{"description":"Content value when Importing an API.","type":"string"},"wsdlSelector":{"description":"Criteria to limit import of WSDL to a subset of the document.","properties":{"wsdlEndpointName":{"description":"Name of endpoint(port) to import from WSDL","type":"string"},"wsdlServiceName":{"description":"Name of service to import from WSDL","type":"string"}},"type":"object"}}}}}}},"description":"Create or update parameters.","required":true},"responses":{"200":{"description":"API was successfully updated.","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":{"ApiManagementCreateApi":{"$ref":"#/components/examples/ApiManagementCreateApi"},"ApiManagementCreateApiClone":{"$ref":"#/components/examples/ApiManagementCreateApiClone"},"ApiManagementCreateApiNewVersionUsingExistingApi":{"$ref":"#/components/examples/ApiManagementCreateApiNewVersionUsingExistingApi"},"ApiManagementCreateApiRevisionFromExistingApi":{"$ref":"#/components/examples/ApiManagementCreateApiRevisionFromExistingApi"},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"$ref":"#/components/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl"},"ApiManagementCreateApiUsingOai3Import":{"$ref":"#/components/examples/ApiManagementCreateApiUsingOai3Import"},"ApiManagementCreateApiUsingSwaggerImport":{"$ref":"#/components/examples/ApiManagementCreateApiUsingSwaggerImport"},"ApiManagementCreateApiUsingWadlImport":{"$ref":"#/components/examples/ApiManagementCreateApiUsingWadlImport"},"ApiManagementCreateApiWithOpenIdConnect":{"$ref":"#/components/examples/ApiManagementCreateApiWithOpenIdConnect"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"$ref":"#/components/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"$ref":"#/components/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport"}}}}},"201":{"description":"API was successfully created.","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":{"ApiManagementCreateApi":{"$ref":"#/components/examples/ApiManagementCreateApi"},"ApiManagementCreateApiClone":{"$ref":"#/components/examples/ApiManagementCreateApiClone"},"ApiManagementCreateApiNewVersionUsingExistingApi":{"$ref":"#/components/examples/ApiManagementCreateApiNewVersionUsingExistingApi"},"ApiManagementCreateApiRevisionFromExistingApi":{"$ref":"#/components/examples/ApiManagementCreateApiRevisionFromExistingApi"},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"$ref":"#/components/examples/ApiManagementCreateApiUsingImportOverrideServiceUrl"},"ApiManagementCreateApiUsingOai3Import":{"$ref":"#/components/examples/ApiManagementCreateApiUsingOai3Import"},"ApiManagementCreateApiUsingSwaggerImport":{"$ref":"#/components/examples/ApiManagementCreateApiUsingSwaggerImport"},"ApiManagementCreateApiUsingWadlImport":{"$ref":"#/components/examples/ApiManagementCreateApiUsingWadlImport"},"ApiManagementCreateApiWithOpenIdConnect":{"$ref":"#/components/examples/ApiManagementCreateApiWithOpenIdConnect"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"$ref":"#/components/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"$ref":"#/components/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport"}}}}},"202":{"description":"Request to create or update API was accepted. Location header contains the URL where the status of the long running operation can be checked."},"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-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics":{"get":{"description":"Lists all diagnostics of an API.","operationId":"ApiDiagnostic_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiDiagnostics":{"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":{"ApiManagementListApiDiagnostics":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiDiagnostics":{"value":"echo-api"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiDiagnostics":{"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":{"ApiManagementListApiDiagnostics":{"value":"subid"}}}],"responses":{"200":{"description":"Paged Result response of diagnostics for an API.","content":{"application/json":{"schema":{"description":"Paged Diagnostic list representation.","properties":{"nextLink":{"description":"Next page link if any.","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":"Diagnostic details.","properties":{"properties":{"description":"Diagnostic Entity Properties","properties":{"alwaysLog":{"description":"Specifies for what type of messages sampling settings should not apply.","enum":["allErrors"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AlwaysLog","values":[{"description":"Always log all erroneous request regardless of sampling settings.","value":"allErrors"}]}},"backend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"frontend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"httpCorrelationProtocol":{"description":"Sets correlation protocol to use for Application Insights diagnostics.","enum":["None","Legacy","W3C"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"HttpCorrelationProtocol","values":[{"description":"Do not read and inject correlation headers.","value":"None"},{"description":"Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.","value":"Legacy"},{"description":"Inject Trace Context headers. See https://w3c.github.io/trace-context.","value":"W3C"}]}},"logClientIp":{"description":"Log the ClientIP. Default is false.","type":"boolean"},"loggerId":{"description":"Resource Id of a target logger.","type":"string"},"sampling":{"description":"Sampling settings for Diagnostic.","properties":{"percentage":{"description":"Rate of sampling for fixed-rate sampling.","format":"double","maximum":100,"minimum":0,"type":"number"},"samplingType":{"description":"Sampling type.","enum":["fixed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SamplingType","values":[{"description":"Fixed-rate sampling.","value":"fixed"}]}}}},"verbosity":{"description":"The verbosity level applied to traces emitted by trace policies.","enum":["verbose","information","error"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Verbosity","values":[{"description":"All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.","value":"verbose"},{"description":"Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.","value":"information"},{"description":"Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.","value":"error"}]}}},"required":["loggerId"]}}},"type":"array"}}},"examples":{"ApiManagementListApiDiagnostics":{"$ref":"#/components/examples/ApiManagementListApiDiagnostics"}}}}},"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":["ApiDiagnostic"],"x-ms-odata":"./definitions.json#/definitions/DiagnosticContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}":{"delete":{"description":"Deletes the specified Diagnostic from an API.","operationId":"ApiDiagnostic_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiDiagnostic":{"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":{"ApiManagementDeleteApiDiagnostic":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiDiagnostic":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Diagnostic identifier. Must be unique in the current API Management service instance.","in":"path","name":"diagnosticId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiDiagnostic":{"value":"applicationinsights"}}},{"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":{"ApiManagementDeleteApiDiagnostic":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiDiagnostic":{"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":{"ApiManagementDeleteApiDiagnostic":{"value":"subid"}}}],"responses":{"200":{"description":"Diagnostic successfully removed"},"204":{"description":"Diagnostic successfully removed by previous request or does not exist"},"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":["ApiDiagnostic"]},"get":{"description":"Gets the details of the Diagnostic for an API specified by its identifier.","operationId":"ApiDiagnostic_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiDiagnostic":{"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":{"ApiManagementGetApiDiagnostic":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiDiagnostic":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Diagnostic identifier. Must be unique in the current API Management service instance.","in":"path","name":"diagnosticId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiDiagnostic":{"value":"applicationinsights"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiDiagnostic":{"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":{"ApiManagementGetApiDiagnostic":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Diagnostic 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":"Diagnostic details.","properties":{"properties":{"description":"Diagnostic Entity Properties","properties":{"alwaysLog":{"description":"Specifies for what type of messages sampling settings should not apply.","enum":["allErrors"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AlwaysLog","values":[{"description":"Always log all erroneous request regardless of sampling settings.","value":"allErrors"}]}},"backend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"frontend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"httpCorrelationProtocol":{"description":"Sets correlation protocol to use for Application Insights diagnostics.","enum":["None","Legacy","W3C"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"HttpCorrelationProtocol","values":[{"description":"Do not read and inject correlation headers.","value":"None"},{"description":"Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.","value":"Legacy"},{"description":"Inject Trace Context headers. See https://w3c.github.io/trace-context.","value":"W3C"}]}},"logClientIp":{"description":"Log the ClientIP. Default is false.","type":"boolean"},"loggerId":{"description":"Resource Id of a target logger.","type":"string"},"sampling":{"description":"Sampling settings for Diagnostic.","properties":{"percentage":{"description":"Rate of sampling for fixed-rate sampling.","format":"double","maximum":100,"minimum":0,"type":"number"},"samplingType":{"description":"Sampling type.","enum":["fixed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SamplingType","values":[{"description":"Fixed-rate sampling.","value":"fixed"}]}}}},"verbosity":{"description":"The verbosity level applied to traces emitted by trace policies.","enum":["verbose","information","error"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Verbosity","values":[{"description":"All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.","value":"verbose"},{"description":"Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.","value":"information"},{"description":"Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.","value":"error"}]}}},"required":["loggerId"]}}},"examples":{"ApiManagementGetApiDiagnostic":{"$ref":"#/components/examples/ApiManagementGetApiDiagnostic"}}}}},"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":["ApiDiagnostic"]},"head":{"description":"Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.","operationId":"ApiDiagnostic_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiDiagnostic":{"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":{"ApiManagementHeadApiDiagnostic":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiDiagnostic":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Diagnostic identifier. Must be unique in the current API Management service instance.","in":"path","name":"diagnosticId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiDiagnostic":{"value":"applicationinsights"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiDiagnostic":{"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":{"ApiManagementHeadApiDiagnostic":{"value":"subid"}}}],"responses":{"200":{"description":"Operation completed successfully.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiDiagnostic"]},"patch":{"description":"Updates the details of the Diagnostic for an API specified by its identifier.","operationId":"ApiDiagnostic_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateApiDiagnostic":{"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":{"ApiManagementUpdateApiDiagnostic":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementUpdateApiDiagnostic":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Diagnostic identifier. Must be unique in the current API Management service instance.","in":"path","name":"diagnosticId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementUpdateApiDiagnostic":{"value":"applicationinsights"}}},{"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":{"ApiManagementUpdateApiDiagnostic":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateApiDiagnostic":{"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":{"ApiManagementUpdateApiDiagnostic":{"value":"subid"}}}],"requestBody":{"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":"Diagnostic details.","properties":{"properties":{"description":"Diagnostic Entity Properties","properties":{"alwaysLog":{"description":"Specifies for what type of messages sampling settings should not apply.","enum":["allErrors"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AlwaysLog","values":[{"description":"Always log all erroneous request regardless of sampling settings.","value":"allErrors"}]}},"backend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"frontend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"httpCorrelationProtocol":{"description":"Sets correlation protocol to use for Application Insights diagnostics.","enum":["None","Legacy","W3C"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"HttpCorrelationProtocol","values":[{"description":"Do not read and inject correlation headers.","value":"None"},{"description":"Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.","value":"Legacy"},{"description":"Inject Trace Context headers. See https://w3c.github.io/trace-context.","value":"W3C"}]}},"logClientIp":{"description":"Log the ClientIP. Default is false.","type":"boolean"},"loggerId":{"description":"Resource Id of a target logger.","type":"string"},"sampling":{"description":"Sampling settings for Diagnostic.","properties":{"percentage":{"description":"Rate of sampling for fixed-rate sampling.","format":"double","maximum":100,"minimum":0,"type":"number"},"samplingType":{"description":"Sampling type.","enum":["fixed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SamplingType","values":[{"description":"Fixed-rate sampling.","value":"fixed"}]}}}},"verbosity":{"description":"The verbosity level applied to traces emitted by trace policies.","enum":["verbose","information","error"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Verbosity","values":[{"description":"All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.","value":"verbose"},{"description":"Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.","value":"information"},{"description":"Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.","value":"error"}]}}},"required":["loggerId"]}}}}},"description":"Diagnostic Update parameters.","required":true},"responses":{"204":{"description":"The Diagnostic was successfully updated."},"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":["ApiDiagnostic"]},"put":{"description":"Creates a new Diagnostic for an API or updates an existing one.","operationId":"ApiDiagnostic_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiDiagnostic":{"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":{"ApiManagementCreateApiDiagnostic":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiDiagnostic":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Diagnostic identifier. Must be unique in the current API Management service instance.","in":"path","name":"diagnosticId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiDiagnostic":{"value":"applicationinsights"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiDiagnostic":{"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":{"ApiManagementCreateApiDiagnostic":{"value":"subid"}}}],"requestBody":{"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":"Diagnostic details.","properties":{"properties":{"description":"Diagnostic Entity Properties","properties":{"alwaysLog":{"description":"Specifies for what type of messages sampling settings should not apply.","enum":["allErrors"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AlwaysLog","values":[{"description":"Always log all erroneous request regardless of sampling settings.","value":"allErrors"}]}},"backend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"frontend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"httpCorrelationProtocol":{"description":"Sets correlation protocol to use for Application Insights diagnostics.","enum":["None","Legacy","W3C"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"HttpCorrelationProtocol","values":[{"description":"Do not read and inject correlation headers.","value":"None"},{"description":"Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.","value":"Legacy"},{"description":"Inject Trace Context headers. See https://w3c.github.io/trace-context.","value":"W3C"}]}},"logClientIp":{"description":"Log the ClientIP. Default is false.","type":"boolean"},"loggerId":{"description":"Resource Id of a target logger.","type":"string"},"sampling":{"description":"Sampling settings for Diagnostic.","properties":{"percentage":{"description":"Rate of sampling for fixed-rate sampling.","format":"double","maximum":100,"minimum":0,"type":"number"},"samplingType":{"description":"Sampling type.","enum":["fixed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SamplingType","values":[{"description":"Fixed-rate sampling.","value":"fixed"}]}}}},"verbosity":{"description":"The verbosity level applied to traces emitted by trace policies.","enum":["verbose","information","error"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Verbosity","values":[{"description":"All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.","value":"verbose"},{"description":"Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.","value":"information"},{"description":"Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.","value":"error"}]}}},"required":["loggerId"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Diagnostic was successfully updated.","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":"Diagnostic details.","properties":{"properties":{"description":"Diagnostic Entity Properties","properties":{"alwaysLog":{"description":"Specifies for what type of messages sampling settings should not apply.","enum":["allErrors"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AlwaysLog","values":[{"description":"Always log all erroneous request regardless of sampling settings.","value":"allErrors"}]}},"backend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"frontend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"httpCorrelationProtocol":{"description":"Sets correlation protocol to use for Application Insights diagnostics.","enum":["None","Legacy","W3C"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"HttpCorrelationProtocol","values":[{"description":"Do not read and inject correlation headers.","value":"None"},{"description":"Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.","value":"Legacy"},{"description":"Inject Trace Context headers. See https://w3c.github.io/trace-context.","value":"W3C"}]}},"logClientIp":{"description":"Log the ClientIP. Default is false.","type":"boolean"},"loggerId":{"description":"Resource Id of a target logger.","type":"string"},"sampling":{"description":"Sampling settings for Diagnostic.","properties":{"percentage":{"description":"Rate of sampling for fixed-rate sampling.","format":"double","maximum":100,"minimum":0,"type":"number"},"samplingType":{"description":"Sampling type.","enum":["fixed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SamplingType","values":[{"description":"Fixed-rate sampling.","value":"fixed"}]}}}},"verbosity":{"description":"The verbosity level applied to traces emitted by trace policies.","enum":["verbose","information","error"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Verbosity","values":[{"description":"All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.","value":"verbose"},{"description":"Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.","value":"information"},{"description":"Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.","value":"error"}]}}},"required":["loggerId"]}}},"examples":{"ApiManagementCreateApiDiagnostic":{"$ref":"#/components/examples/ApiManagementCreateApiDiagnostic"}}}}},"201":{"description":"Diagnostic was successfully created.","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":"Diagnostic details.","properties":{"properties":{"description":"Diagnostic Entity Properties","properties":{"alwaysLog":{"description":"Specifies for what type of messages sampling settings should not apply.","enum":["allErrors"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AlwaysLog","values":[{"description":"Always log all erroneous request regardless of sampling settings.","value":"allErrors"}]}},"backend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"frontend":{"description":"Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.","properties":{"request":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}},"response":{"description":"Http message diagnostic settings.","properties":{"body":{"description":"Body logging settings.","properties":{"bytes":{"description":"Number of request body bytes to log.","format":"int32","maximum":8192,"type":"integer"}}},"headers":{"description":"Array of HTTP Headers to log.","items":{"type":"string"},"type":"array"}}}}},"httpCorrelationProtocol":{"description":"Sets correlation protocol to use for Application Insights diagnostics.","enum":["None","Legacy","W3C"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"HttpCorrelationProtocol","values":[{"description":"Do not read and inject correlation headers.","value":"None"},{"description":"Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.","value":"Legacy"},{"description":"Inject Trace Context headers. See https://w3c.github.io/trace-context.","value":"W3C"}]}},"logClientIp":{"description":"Log the ClientIP. Default is false.","type":"boolean"},"loggerId":{"description":"Resource Id of a target logger.","type":"string"},"sampling":{"description":"Sampling settings for Diagnostic.","properties":{"percentage":{"description":"Rate of sampling for fixed-rate sampling.","format":"double","maximum":100,"minimum":0,"type":"number"},"samplingType":{"description":"Sampling type.","enum":["fixed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SamplingType","values":[{"description":"Fixed-rate sampling.","value":"fixed"}]}}}},"verbosity":{"description":"The verbosity level applied to traces emitted by trace policies.","enum":["verbose","information","error"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Verbosity","values":[{"description":"All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.","value":"verbose"},{"description":"Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.","value":"information"},{"description":"Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.","value":"error"}]}}},"required":["loggerId"]}}},"examples":{"ApiManagementCreateApiDiagnostic":{"$ref":"#/components/examples/ApiManagementCreateApiDiagnostic"}}}}},"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":["ApiDiagnostic"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues":{"get":{"description":"Lists all issues associated with the specified API.","operationId":"ApiIssue_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiIssues":{"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":{"ApiManagementListApiIssues":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiIssues":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq |     | </br>","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Expand the comment attachments. ","in":"query","name":"expandCommentsAttachments","required":false,"schema":{"type":"boolean"}},{"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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiIssues":{"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":{"ApiManagementListApiIssues":{"value":"subid"}}}],"responses":{"200":{"description":"Paged Result response of issues for the API.","content":{"application/json":{"schema":{"description":"Paged Issue list representation.","properties":{"nextLink":{"description":"Next page link if any.","readOnly":true,"type":"string"},"value":{"description":"Issue 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":"Issue Contract details.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}},"required":["title","description","userId"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApiIssues":{"$ref":"#/components/examples/ApiManagementListApiIssues"}}}}},"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":["ApiIssue"],"x-ms-odata":"./definitions.json#/definitions/IssueContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}":{"delete":{"description":"Deletes the specified Issue from an API.","operationId":"ApiIssue_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiIssue":{"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":{"ApiManagementDeleteApiIssue":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiIssue":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiIssue":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"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":{"ApiManagementDeleteApiIssue":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiIssue":{"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":{"ApiManagementDeleteApiIssue":{"value":"subid"}}}],"responses":{"200":{"description":"Issue successfully removed"},"204":{"description":"Issue successfully removed by previous request or does not exist"},"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":["ApiIssue"]},"get":{"description":"Gets the details of the Issue for an API specified by its identifier.","operationId":"ApiIssue_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiIssue":{"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":{"ApiManagementGetApiIssue":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiIssue":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiIssue":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Expand the comment attachments. ","in":"query","name":"expandCommentsAttachments","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":{"ApiManagementGetApiIssue":{"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":{"ApiManagementGetApiIssue":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Issue 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":"Issue Contract details.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}},"required":["title","description","userId"]}}},"examples":{"ApiManagementGetApiIssue":{"$ref":"#/components/examples/ApiManagementGetApiIssue"}}}}},"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":["ApiIssue"]},"head":{"description":"Gets the entity state (Etag) version of the Issue for an API specified by its identifier.","operationId":"ApiIssue_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiIssue":{"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":{"ApiManagementHeadApiIssue":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiIssue":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiIssue":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiIssue":{"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":{"ApiManagementHeadApiIssue":{"value":"subid"}}}],"responses":{"200":{"description":"Operation completed successfully.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiIssue"]},"patch":{"description":"Updates an existing issue for an API.","operationId":"ApiIssue_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateApiIssue":{"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":{"ApiManagementUpdateApiIssue":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementUpdateApiIssue":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementUpdateApiIssue":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"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":{"ApiManagementUpdateApiIssue":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateApiIssue":{"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":{"ApiManagementUpdateApiIssue":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Issue update Parameters.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Update Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}}}}}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"Api issue updated successfully"},"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":["ApiIssue"]},"put":{"description":"Creates a new Issue for an API or updates an existing one.","operationId":"ApiIssue_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiIssue":{"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":{"ApiManagementCreateApiIssue":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiIssue":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiIssue":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiIssue":{"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":{"ApiManagementCreateApiIssue":{"value":"subid"}}}],"requestBody":{"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":"Issue Contract details.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}},"required":["title","description","userId"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Api issue successfully updated","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":"Issue Contract details.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}},"required":["title","description","userId"]}}},"examples":{"ApiManagementCreateApiIssue":{"$ref":"#/components/examples/ApiManagementCreateApiIssue"}}}}},"201":{"description":"New api issue successfully added","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":"Issue Contract details.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}},"required":["title","description","userId"]}}},"examples":{"ApiManagementCreateApiIssue":{"$ref":"#/components/examples/ApiManagementCreateApiIssue"}}}}},"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":["ApiIssue"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments":{"get":{"description":"Lists all attachments for the Issue associated with the specified API.","operationId":"ApiIssueAttachment_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiIssueAttachments":{"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":{"ApiManagementListApiIssueAttachments":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiIssueAttachments":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementListApiIssueAttachments":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiIssueAttachments":{"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":{"ApiManagementListApiIssueAttachments":{"value":"subid"}}}],"responses":{"200":{"description":"Paged Result response of issue attachments for the API.","content":{"application/json":{"schema":{"description":"Paged Issue Attachment list representation.","properties":{"nextLink":{"description":"Next page link if any.","readOnly":true,"type":"string"},"value":{"description":"Issue Attachment 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":"Issue Attachment Contract details.","properties":{"properties":{"description":"Issue Attachment contract Properties.","properties":{"content":{"description":"An HTTP link or Base64-encoded binary data.","type":"string"},"contentFormat":{"description":"Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.","type":"string"},"title":{"description":"Filename by which the binary data will be saved.","type":"string"}},"required":["title","contentFormat","content"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApiIssueAttachments":{"$ref":"#/components/examples/ApiManagementListApiIssueAttachments"}}}}},"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":["ApiIssueAttachment"],"x-ms-odata":"./definitions.json#/definitions/IssueAttachmentContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}":{"delete":{"description":"Deletes the specified comment from an Issue.","operationId":"ApiIssueAttachment_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiIssueAttachment":{"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":{"ApiManagementDeleteApiIssueAttachment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiIssueAttachment":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiIssueAttachment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Attachment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"attachmentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiIssueAttachment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"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":{"ApiManagementDeleteApiIssueAttachment":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiIssueAttachment":{"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":{"ApiManagementDeleteApiIssueAttachment":{"value":"subid"}}}],"responses":{"200":{"description":"Attachment successfully removed"},"204":{"description":"Attachment successfully removed by previous request or does not exist"},"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":["ApiIssueAttachment"]},"get":{"description":"Gets the details of the issue Attachment for an API specified by its identifier.","operationId":"ApiIssueAttachment_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiIssueAttachment":{"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":{"ApiManagementGetApiIssueAttachment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiIssueAttachment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiIssueAttachment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Attachment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"attachmentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiIssueAttachment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiIssueAttachment":{"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":{"ApiManagementGetApiIssueAttachment":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified issue Attachment 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":"Issue Attachment Contract details.","properties":{"properties":{"description":"Issue Attachment contract Properties.","properties":{"content":{"description":"An HTTP link or Base64-encoded binary data.","type":"string"},"contentFormat":{"description":"Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.","type":"string"},"title":{"description":"Filename by which the binary data will be saved.","type":"string"}},"required":["title","contentFormat","content"]}}},"examples":{"ApiManagementGetApiIssueAttachment":{"$ref":"#/components/examples/ApiManagementGetApiIssueAttachment"}}}}},"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":["ApiIssueAttachment"]},"head":{"description":"Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.","operationId":"ApiIssueAttachment_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiIssueAttachment":{"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":{"ApiManagementHeadApiIssueAttachment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiIssueAttachment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiIssueAttachment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Attachment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"attachmentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiIssueAttachment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiIssueAttachment":{"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":{"ApiManagementHeadApiIssueAttachment":{"value":"subid"}}}],"responses":{"200":{"description":"Operation completed successfully.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiIssueAttachment"]},"put":{"description":"Creates a new Attachment for the Issue in an API or updates an existing one.","operationId":"ApiIssueAttachment_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiIssueAttachment":{"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":{"ApiManagementCreateApiIssueAttachment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiIssueAttachment":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiIssueAttachment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Attachment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"attachmentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiIssueAttachment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiIssueAttachment":{"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":{"ApiManagementCreateApiIssueAttachment":{"value":"subid"}}}],"requestBody":{"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":"Issue Attachment Contract details.","properties":{"properties":{"description":"Issue Attachment contract Properties.","properties":{"content":{"description":"An HTTP link or Base64-encoded binary data.","type":"string"},"contentFormat":{"description":"Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.","type":"string"},"title":{"description":"Filename by which the binary data will be saved.","type":"string"}},"required":["title","contentFormat","content"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Api issue attachment successfully updated","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":"Issue Attachment Contract details.","properties":{"properties":{"description":"Issue Attachment contract Properties.","properties":{"content":{"description":"An HTTP link or Base64-encoded binary data.","type":"string"},"contentFormat":{"description":"Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.","type":"string"},"title":{"description":"Filename by which the binary data will be saved.","type":"string"}},"required":["title","contentFormat","content"]}}},"examples":{"ApiManagementCreateApiIssueAttachment":{"$ref":"#/components/examples/ApiManagementCreateApiIssueAttachment"}}}}},"201":{"description":"New api issue attachment successfully added","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":"Issue Attachment Contract details.","properties":{"properties":{"description":"Issue Attachment contract Properties.","properties":{"content":{"description":"An HTTP link or Base64-encoded binary data.","type":"string"},"contentFormat":{"description":"Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.","type":"string"},"title":{"description":"Filename by which the binary data will be saved.","type":"string"}},"required":["title","contentFormat","content"]}}},"examples":{"ApiManagementCreateApiIssueAttachment":{"$ref":"#/components/examples/ApiManagementCreateApiIssueAttachment"}}}}},"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":["ApiIssueAttachment"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments":{"get":{"description":"Lists all comments for the Issue associated with the specified API.","operationId":"ApiIssueComment_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiIssueComments":{"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":{"ApiManagementListApiIssueComments":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiIssueComments":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementListApiIssueComments":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiIssueComments":{"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":{"ApiManagementListApiIssueComments":{"value":"subid"}}}],"responses":{"200":{"description":"Paged Result response of issue comments for the API.","content":{"application/json":{"schema":{"description":"Paged Issue Comment list representation.","properties":{"nextLink":{"description":"Next page link if any.","readOnly":true,"type":"string"},"value":{"description":"Issue Comment 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":"Issue Comment Contract details.","properties":{"properties":{"description":"Issue Comment contract Properties.","properties":{"createdDate":{"description":"Date and time when the comment was created.","format":"date-time","type":"string"},"text":{"description":"Comment text.","type":"string"},"userId":{"description":"A resource identifier for the user who left the comment.","type":"string"}},"required":["text","userId"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApiIssueComments":{"$ref":"#/components/examples/ApiManagementListApiIssueComments"}}}}},"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":["ApiIssueComment"],"x-ms-odata":"./definitions.json#/definitions/IssueCommentContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}":{"delete":{"description":"Deletes the specified comment from an Issue.","operationId":"ApiIssueComment_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiIssueComment":{"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":{"ApiManagementDeleteApiIssueComment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiIssueComment":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiIssueComment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Comment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"commentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiIssueComment":{"value":"599e29ab193c3c0bd0b3e2fb"}}},{"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":{"ApiManagementDeleteApiIssueComment":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiIssueComment":{"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":{"ApiManagementDeleteApiIssueComment":{"value":"subid"}}}],"responses":{"200":{"description":"Comment successfully removed"},"204":{"description":"Comment successfully removed by previous request or does not exist"},"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":["ApiIssueComment"]},"get":{"description":"Gets the details of the issue Comment for an API specified by its identifier.","operationId":"ApiIssueComment_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiIssueComment":{"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":{"ApiManagementGetApiIssueComment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiIssueComment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiIssueComment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Comment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"commentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiIssueComment":{"value":"599e29ab193c3c0bd0b3e2fb"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiIssueComment":{"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":{"ApiManagementGetApiIssueComment":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified issue Comment 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":"Issue Comment Contract details.","properties":{"properties":{"description":"Issue Comment contract Properties.","properties":{"createdDate":{"description":"Date and time when the comment was created.","format":"date-time","type":"string"},"text":{"description":"Comment text.","type":"string"},"userId":{"description":"A resource identifier for the user who left the comment.","type":"string"}},"required":["text","userId"]}}},"examples":{"ApiManagementGetApiIssueComment":{"$ref":"#/components/examples/ApiManagementGetApiIssueComment"}}}}},"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":["ApiIssueComment"]},"head":{"description":"Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.","operationId":"ApiIssueComment_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiIssueComment":{"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":{"ApiManagementHeadApiIssueComment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiIssueComment":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiIssueComment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Comment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"commentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiIssueComment":{"value":"599e29ab193c3c0bd0b3e2fb"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiIssueComment":{"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":{"ApiManagementHeadApiIssueComment":{"value":"subid"}}}],"responses":{"200":{"description":"Operation completed successfully.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiIssueComment"]},"put":{"description":"Creates a new Comment for the Issue in an API or updates an existing one.","operationId":"ApiIssueComment_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiIssueComment":{"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":{"ApiManagementCreateApiIssueComment":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiIssueComment":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiIssueComment":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Comment identifier within an Issue. Must be unique in the current Issue.","in":"path","name":"commentId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiIssueComment":{"value":"599e29ab193c3c0bd0b3e2fb"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiIssueComment":{"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":{"ApiManagementCreateApiIssueComment":{"value":"subid"}}}],"requestBody":{"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":"Issue Comment Contract details.","properties":{"properties":{"description":"Issue Comment contract Properties.","properties":{"createdDate":{"description":"Date and time when the comment was created.","format":"date-time","type":"string"},"text":{"description":"Comment text.","type":"string"},"userId":{"description":"A resource identifier for the user who left the comment.","type":"string"}},"required":["text","userId"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Api issue comment successfully updated","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":"Issue Comment Contract details.","properties":{"properties":{"description":"Issue Comment contract Properties.","properties":{"createdDate":{"description":"Date and time when the comment was created.","format":"date-time","type":"string"},"text":{"description":"Comment text.","type":"string"},"userId":{"description":"A resource identifier for the user who left the comment.","type":"string"}},"required":["text","userId"]}}},"examples":{"ApiManagementCreateApiIssueComment":{"$ref":"#/components/examples/ApiManagementCreateApiIssueComment"}}}}},"201":{"description":"New api issue comment successfully added","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":"Issue Comment Contract details.","properties":{"properties":{"description":"Issue Comment contract Properties.","properties":{"createdDate":{"description":"Date and time when the comment was created.","format":"date-time","type":"string"},"text":{"description":"Comment text.","type":"string"},"userId":{"description":"A resource identifier for the user who left the comment.","type":"string"}},"required":["text","userId"]}}},"examples":{"ApiManagementCreateApiIssueComment":{"$ref":"#/components/examples/ApiManagementCreateApiIssueComment"}}}}},"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":["ApiIssueComment"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations":{"get":{"description":"Lists a collection of the operations for the specified API.","operationId":"ApiOperation_ListByApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiOperations":{"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":{"ApiManagementListApiOperations":{"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":{"ApiManagementListApiOperations":{"value":"57d2ef278aa04f0888cba3f3"}}},{"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>| method | 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>| urlTemplate | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiOperations":{"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":{"ApiManagementListApiOperations":{"value":"subid"}}}],"responses":{"200":{"description":"A collection of operation summary entities at the API level.","content":{"application/json":{"schema":{"description":"Paged Operation 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 Operation details.","properties":{"properties":{"allOf":[{"description":"Api Operation Entity Base Contract details.","properties":{"description":{"description":"Description of the operation. May include HTML formatting tags.","maxLength":1000,"type":"string"},"policies":{"description":"Operation Policies","type":"string"},"request":{"description":"Operation request details.","properties":{"description":{"description":"Operation request description.","type":"string"},"headers":{"description":"Collection of operation request headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"queryParameters":{"description":"Collection of operation request query parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation request representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"}}},"responses":{"description":"Array of Operation responses.","items":{"description":"Operation response details.","properties":{"description":{"description":"Operation response description.","type":"string"},"headers":{"description":"Collection of operation response headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation response representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"},"statusCode":{"description":"Operation response HTTP status code.","format":"int32","type":"integer"}},"required":["statusCode"]},"type":"array"},"templateParameters":{"description":"Collection of URL template parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"}}}],"description":"Operation Contract Properties","properties":{"displayName":{"description":"Operation Name.","maxLength":300,"minLength":1,"type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","maxLength":1000,"minLength":1,"type":"string"}},"required":["displayName","method","urlTemplate"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApiOperations":{"$ref":"#/components/examples/ApiManagementListApiOperations"}}}}},"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":["ApiOperation"],"x-ms-odata":"./definitions.json#/definitions/OperationContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}":{"delete":{"description":"Deletes the specified operation in the API.","operationId":"ApiOperation_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiOperation":{"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":{"ApiManagementDeleteApiOperation":{"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":{"ApiManagementDeleteApiOperation":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiOperation":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"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":{"ApiManagementDeleteApiOperation":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiOperation":{"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":{"ApiManagementDeleteApiOperation":{"value":"subid"}}}],"responses":{"200":{"description":"API operation successfully removed"},"204":{"description":"API operation successfully removed by previous request or does not exist"},"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":["ApiOperation"]},"get":{"description":"Gets the details of the API Operation specified by its identifier.","operationId":"ApiOperation_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiOperation":{"value":"rg1"},"ApiManagementGetApiOperationPetStore":{"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":{"ApiManagementGetApiOperation":{"value":"apimService1"},"ApiManagementGetApiOperationPetStore":{"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":{"ApiManagementGetApiOperation":{"value":"57d2ef278aa04f0888cba3f3"},"ApiManagementGetApiOperationPetStore":{"value":"swagger-petstore"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiOperation":{"value":"57d2ef278aa04f0ad01d6cdc"},"ApiManagementGetApiOperationPetStore":{"value":"loginUser"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiOperation":{"value":"2019-12-01-preview"},"ApiManagementGetApiOperationPetStore":{"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":{"ApiManagementGetApiOperation":{"value":"subid"},"ApiManagementGetApiOperationPetStore":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Operation 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 Operation details.","properties":{"properties":{"allOf":[{"description":"Api Operation Entity Base Contract details.","properties":{"description":{"description":"Description of the operation. May include HTML formatting tags.","maxLength":1000,"type":"string"},"policies":{"description":"Operation Policies","type":"string"},"request":{"description":"Operation request details.","properties":{"description":{"description":"Operation request description.","type":"string"},"headers":{"description":"Collection of operation request headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"queryParameters":{"description":"Collection of operation request query parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation request representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"}}},"responses":{"description":"Array of Operation responses.","items":{"description":"Operation response details.","properties":{"description":{"description":"Operation response description.","type":"string"},"headers":{"description":"Collection of operation response headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation response representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"},"statusCode":{"description":"Operation response HTTP status code.","format":"int32","type":"integer"}},"required":["statusCode"]},"type":"array"},"templateParameters":{"description":"Collection of URL template parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"}}}],"description":"Operation Contract Properties","properties":{"displayName":{"description":"Operation Name.","maxLength":300,"minLength":1,"type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","maxLength":1000,"minLength":1,"type":"string"}},"required":["displayName","method","urlTemplate"]}}},"examples":{"ApiManagementGetApiOperation":{"$ref":"#/components/examples/ApiManagementGetApiOperation"},"ApiManagementGetApiOperationPetStore":{"$ref":"#/components/examples/ApiManagementGetApiOperationPetStore"}}}}},"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":["ApiOperation"]},"head":{"description":"Gets the entity state (Etag) version of the API operation specified by its identifier.","operationId":"ApiOperation_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiOperation":{"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":{"ApiManagementHeadApiOperation":{"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":{"ApiManagementHeadApiOperation":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiOperation":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiOperation":{"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":{"ApiManagementHeadApiOperation":{"value":"subid"}}}],"responses":{"200":{"description":"Specified API operation entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiOperation"]},"patch":{"description":"Updates the details of the operation in the API specified by its identifier.","operationId":"ApiOperation_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateApiOperation":{"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":{"ApiManagementUpdateApiOperation":{"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":{"ApiManagementUpdateApiOperation":{"value":"echo-api"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementUpdateApiOperation":{"value":"operationId"}}},{"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":{"ApiManagementUpdateApiOperation":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateApiOperation":{"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":{"ApiManagementUpdateApiOperation":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Api Operation Update Contract details.","properties":{"properties":{"allOf":[{"description":"Api Operation Entity Base Contract details.","properties":{"description":{"description":"Description of the operation. May include HTML formatting tags.","maxLength":1000,"type":"string"},"policies":{"description":"Operation Policies","type":"string"},"request":{"description":"Operation request details.","properties":{"description":{"description":"Operation request description.","type":"string"},"headers":{"description":"Collection of operation request headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"queryParameters":{"description":"Collection of operation request query parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation request representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"}}},"responses":{"description":"Array of Operation responses.","items":{"description":"Operation response details.","properties":{"description":{"description":"Operation response description.","type":"string"},"headers":{"description":"Collection of operation response headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation response representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"},"statusCode":{"description":"Operation response HTTP status code.","format":"int32","type":"integer"}},"required":["statusCode"]},"type":"array"},"templateParameters":{"description":"Collection of URL template parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"}}}],"description":"Operation Update Contract Properties.","properties":{"displayName":{"description":"Operation Name.","maxLength":300,"minLength":1,"type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","maxLength":1000,"minLength":1,"type":"string"}}}}}}},"description":"API Operation Update parameters.","required":true},"responses":{"204":{"description":"The operation was successfully updated."},"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":["ApiOperation"]},"put":{"description":"Creates a new operation in the API or updates an existing one.","operationId":"ApiOperation_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiOperation":{"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":{"ApiManagementCreateApiOperation":{"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":{"ApiManagementCreateApiOperation":{"value":"PetStoreTemplate2"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiOperation":{"value":"newoperations"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiOperation":{"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":{"ApiManagementCreateApiOperation":{"value":"subid"}}}],"requestBody":{"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 Operation details.","properties":{"properties":{"allOf":[{"description":"Api Operation Entity Base Contract details.","properties":{"description":{"description":"Description of the operation. May include HTML formatting tags.","maxLength":1000,"type":"string"},"policies":{"description":"Operation Policies","type":"string"},"request":{"description":"Operation request details.","properties":{"description":{"description":"Operation request description.","type":"string"},"headers":{"description":"Collection of operation request headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"queryParameters":{"description":"Collection of operation request query parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation request representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"}}},"responses":{"description":"Array of Operation responses.","items":{"description":"Operation response details.","properties":{"description":{"description":"Operation response description.","type":"string"},"headers":{"description":"Collection of operation response headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation response representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"},"statusCode":{"description":"Operation response HTTP status code.","format":"int32","type":"integer"}},"required":["statusCode"]},"type":"array"},"templateParameters":{"description":"Collection of URL template parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"}}}],"description":"Operation Contract Properties","properties":{"displayName":{"description":"Operation Name.","maxLength":300,"minLength":1,"type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","maxLength":1000,"minLength":1,"type":"string"}},"required":["displayName","method","urlTemplate"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Operation was successfully updated.","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 Operation details.","properties":{"properties":{"allOf":[{"description":"Api Operation Entity Base Contract details.","properties":{"description":{"description":"Description of the operation. May include HTML formatting tags.","maxLength":1000,"type":"string"},"policies":{"description":"Operation Policies","type":"string"},"request":{"description":"Operation request details.","properties":{"description":{"description":"Operation request description.","type":"string"},"headers":{"description":"Collection of operation request headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"queryParameters":{"description":"Collection of operation request query parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation request representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"}}},"responses":{"description":"Array of Operation responses.","items":{"description":"Operation response details.","properties":{"description":{"description":"Operation response description.","type":"string"},"headers":{"description":"Collection of operation response headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation response representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"},"statusCode":{"description":"Operation response HTTP status code.","format":"int32","type":"integer"}},"required":["statusCode"]},"type":"array"},"templateParameters":{"description":"Collection of URL template parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"}}}],"description":"Operation Contract Properties","properties":{"displayName":{"description":"Operation Name.","maxLength":300,"minLength":1,"type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","maxLength":1000,"minLength":1,"type":"string"}},"required":["displayName","method","urlTemplate"]}}},"examples":{"ApiManagementCreateApiOperation":{"$ref":"#/components/examples/ApiManagementCreateApiOperation"}}}}},"201":{"description":"Operation was successfully created.","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 Operation details.","properties":{"properties":{"allOf":[{"description":"Api Operation Entity Base Contract details.","properties":{"description":{"description":"Description of the operation. May include HTML formatting tags.","maxLength":1000,"type":"string"},"policies":{"description":"Operation Policies","type":"string"},"request":{"description":"Operation request details.","properties":{"description":{"description":"Operation request description.","type":"string"},"headers":{"description":"Collection of operation request headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"queryParameters":{"description":"Collection of operation request query parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation request representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"}}},"responses":{"description":"Array of Operation responses.","items":{"description":"Operation response details.","properties":{"description":{"description":"Operation response description.","type":"string"},"headers":{"description":"Collection of operation response headers.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"representations":{"description":"Collection of operation response representations.","items":{"description":"Operation request/response representation details.","properties":{"contentType":{"description":"Specifies a registered or custom content type for this representation, e.g. application/xml.","type":"string"},"formParameters":{"description":"Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"},"sample":{"description":"An example of the representation.","type":"string"},"schemaId":{"description":"Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"},"typeName":{"description":"Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.","type":"string"}},"required":["contentType"]},"type":"array"},"statusCode":{"description":"Operation response HTTP status code.","format":"int32","type":"integer"}},"required":["statusCode"]},"type":"array"},"templateParameters":{"description":"Collection of URL template parameters.","items":{"description":"Operation parameters details.","properties":{"defaultValue":{"description":"Default parameter value.","type":"string"},"description":{"description":"Parameter description.","type":"string"},"name":{"description":"Parameter name.","type":"string"},"required":{"description":"Specifies whether parameter is required or not.","type":"boolean"},"type":{"description":"Parameter type.","type":"string"},"values":{"description":"Parameter values.","items":{"type":"string"},"type":"array"}},"required":["name","type"]},"type":"array"}}}],"description":"Operation Contract Properties","properties":{"displayName":{"description":"Operation Name.","maxLength":300,"minLength":1,"type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","maxLength":1000,"minLength":1,"type":"string"}},"required":["displayName","method","urlTemplate"]}}},"examples":{"ApiManagementCreateApiOperation":{"$ref":"#/components/examples/ApiManagementCreateApiOperation"}}}}},"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":["ApiOperation"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies":{"get":{"description":"Get the list of policy configuration at the API Operation level.","operationId":"ApiOperationPolicy_ListByOperation","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiOperationPolicies":{"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":{"ApiManagementListApiOperationPolicies":{"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":{"ApiManagementListApiOperationPolicies":{"value":"599e2953193c3c0bd0b3e2fa"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiOperationPolicies":{"value":"599e29ab193c3c0bd0b3e2fb"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiOperationPolicies":{"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":{"ApiManagementListApiOperationPolicies":{"value":"subid"}}}],"responses":{"200":{"description":"Api Operations Policy Collection.","content":{"application/json":{"schema":{"description":"The response of the list policy operation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Policy Contract value.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"type":"array"}}},"examples":{"ApiManagementListApiOperationPolicies":{"$ref":"#/components/examples/ApiManagementListApiOperationPolicies"}}}}},"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":["ApiOperationPolicy"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}":{"delete":{"description":"Deletes the policy configuration at the Api Operation.","operationId":"ApiOperationPolicy_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiOperationPolicy":{"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":{"ApiManagementDeleteApiOperationPolicy":{"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":{"ApiManagementDeleteApiOperationPolicy":{"value":"testapi"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiOperationPolicy":{"value":"testoperation"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementDeleteApiOperationPolicy":{"value":"policy"}}},{"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":{"ApiManagementDeleteApiOperationPolicy":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiOperationPolicy":{"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":{"ApiManagementDeleteApiOperationPolicy":{"value":"subid"}}}],"responses":{"200":{"description":"Policy successfully removed"},"204":{"description":"Policy successfully removed by previous request or does not exist"},"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":["ApiOperationPolicy"]},"get":{"description":"Get the policy configuration at the API Operation level.","operationId":"ApiOperationPolicy_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiOperationPolicy":{"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":{"ApiManagementGetApiOperationPolicy":{"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":{"ApiManagementGetApiOperationPolicy":{"value":"5600b539c53f5b0062040001"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiOperationPolicy":{"value":"5600b53ac53f5b0062080006"}}},{"description":"Policy Export Format.","in":"query","name":"format","required":false,"x-ms-enum":{"modelAsString":true,"name":"PolicyExportFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["xml","rawxml"],"default":"xml"}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementGetApiOperationPolicy":{"value":"policy"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiOperationPolicy":{"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":{"ApiManagementGetApiOperationPolicy":{"value":"subid"}}}],"responses":{"200":{"description":"Api Operation Policy information.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementGetApiOperationPolicy":{"$ref":"#/components/examples/ApiManagementGetApiOperationPolicy"}}}}},"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":["ApiOperationPolicy"]},"head":{"description":"Gets the entity state (Etag) version of the API operation policy specified by its identifier.","operationId":"ApiOperationPolicy_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiOperationPolicy":{"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":{"ApiManagementHeadApiOperationPolicy":{"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":{"ApiManagementHeadApiOperationPolicy":{"value":"5600b539c53f5b0062040001"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiOperationPolicy":{"value":"5600b53ac53f5b0062080006"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementHeadApiOperationPolicy":{"value":"policy"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiOperationPolicy":{"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":{"ApiManagementHeadApiOperationPolicy":{"value":"subid"}}}],"responses":{"200":{"description":"Specified API operation policy entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiOperationPolicy"]},"put":{"description":"Creates or updates policy configuration for the API Operation level.","operationId":"ApiOperationPolicy_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiOperationPolicy":{"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":{"ApiManagementCreateApiOperationPolicy":{"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":{"ApiManagementCreateApiOperationPolicy":{"value":"5600b57e7e8880006a040001"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiOperationPolicy":{"value":"5600b57e7e8880006a080001"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementCreateApiOperationPolicy":{"value":"policy"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiOperationPolicy":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiOperationPolicy":{"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":{"ApiManagementCreateApiOperationPolicy":{"value":"subid"}}}],"requestBody":{"$ref":"#/components/requestBodies/ApiOperationPolicy_CreateOrUpdateParameters"},"responses":{"200":{"description":"Api Operation policy configuration of the tenant was successfully updated.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementCreateApiOperationPolicy":{"$ref":"#/components/examples/ApiManagementCreateApiOperationPolicy"}}}}},"201":{"description":"Api Operation policy configuration was successfully created.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementCreateApiOperationPolicy":{"$ref":"#/components/examples/ApiManagementCreateApiOperationPolicy"}}}}},"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":["ApiOperationPolicy"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags":{"get":{"description":"Lists all Tags associated with the Operation.","operationId":"Tag_ListByOperation","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiOperationTags":{"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":{"ApiManagementListApiOperationTags":{"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":{"ApiManagementListApiOperationTags":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiOperationTags":{"value":"57d2ef278aa04f0888cba3f6"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiOperationTags":{"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":{"ApiManagementListApiOperationTags":{"value":"subid"}}}],"responses":{"200":{"description":"The operation returns a collection of tags associated with the Operation entity.","content":{"application/json":{"schema":{"description":"Paged Tag list representation.","properties":{"nextLink":{"description":"Next page link if any.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"type":"array"}}},"examples":{"ApiManagementListApiOperationTags":{"$ref":"#/components/examples/ApiManagementListApiOperationTags"}}}}},"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":["ApiOperationTag"],"x-ms-odata":"./definitions.json#/definitions/TagContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}":{"delete":{"description":"Detach the tag from the Operation.","operationId":"Tag_DetachFromOperation","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiOperationTag":{"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":{"ApiManagementDeleteApiOperationTag":{"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":{"ApiManagementDeleteApiOperationTag":{"value":"59d5b28d1f7fab116c282650"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiOperationTag":{"value":"59d5b28d1f7fab116c282651"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiOperationTag":{"value":"59d5b28e1f7fab116402044e"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiOperationTag":{"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":{"ApiManagementDeleteApiOperationTag":{"value":"subid"}}}],"responses":{"200":{"description":"Tag was successfully removed from Operation"},"204":{"description":"Tag successfully removed by previous request or does not exist in Operation"},"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":["ApiOperationTag"]},"get":{"description":"Get tag associated with the Operation.","operationId":"Tag_GetByOperation","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiOperationTag":{"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":{"ApiManagementGetApiOperationTag":{"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":{"ApiManagementGetApiOperationTag":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiOperationTag":{"value":"59d6bb8f1f7fab13dc67ec9a"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiOperationTag":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiOperationTag":{"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":{"ApiManagementGetApiOperationTag":{"value":"subid"}}}],"responses":{"200":{"description":"Gets the details of the tag specified by its identifier.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementGetApiOperationTag":{"$ref":"#/components/examples/ApiManagementGetApiOperationTag"}}}}},"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":["ApiOperationTag"]},"head":{"description":"Gets the entity state version of the tag specified by its identifier.","operationId":"Tag_GetEntityStateByOperation","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiOperationTag":{"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":{"ApiManagementHeadApiOperationTag":{"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":{"ApiManagementHeadApiOperationTag":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiOperationTag":{"value":"59d6bb8f1f7fab13dc67ec9a"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiOperationTag":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiOperationTag":{"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":{"ApiManagementHeadApiOperationTag":{"value":"subid"}}}],"responses":{"200":{"description":"Empty response body, ETag header entity state version.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiOperationTag"]},"put":{"description":"Assign tag to the Operation.","operationId":"Tag_AssignToOperation","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiOperationTag":{"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":{"ApiManagementCreateApiOperationTag":{"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":{"ApiManagementCreateApiOperationTag":{"value":"5931a75ae4bbd512a88c680b"}}},{"description":"Operation identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"operationId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiOperationTag":{"value":"5931a75ae4bbd512a88c680a"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiOperationTag":{"value":"tagId1"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiOperationTag":{"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":{"ApiManagementCreateApiOperationTag":{"value":"subid"}}}],"responses":{"200":{"description":"Tag is already assigned to the Operation.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementCreateApiOperationTag":{"$ref":"#/components/examples/ApiManagementCreateApiOperationTag"}}}}},"201":{"description":"Tag was assigned to the Operation.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementCreateApiOperationTag":{"$ref":"#/components/examples/ApiManagementCreateApiOperationTag"}}}}},"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":["ApiOperationTag"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags":{"get":{"description":"Lists a collection of operations associated with tags.","operationId":"Operation_ListByTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiOperationsByTags":{"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":{"ApiManagementListApiOperationsByTags":{"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":{"ApiManagementListApiOperationsByTags":{"value":"a1"}}},{"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>| apiName | 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>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| urlTemplate | 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 not tagged Operations.","in":"query","name":"includeNotTaggedOperations","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":{"ApiManagementListApiOperationsByTags":{"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":{"ApiManagementListApiOperationsByTags":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of TagResource entities.","content":{"application/json":{"schema":{"description":"Paged Tag list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"TagResource contract properties.","properties":{"api":{"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 contract properties for the Tag Resources.","properties":{"id":{"description":"API identifier in the form /apis/{apiId}.","type":"string"},"name":{"description":"API name.","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.","maxLength":2000,"minLength":1,"type":"string"}}},"operation":{"description":"Operation Entity contract Properties.","properties":{"apiName":{"description":"Api Name.","readOnly":true,"type":"string"},"apiRevision":{"description":"Api Revision.","readOnly":true,"type":"string"},"apiVersion":{"description":"Api Version.","readOnly":true,"type":"string"},"description":{"description":"Operation Description.","readOnly":true,"type":"string"},"id":{"description":"Identifier of the operation in form /operations/{operationId}.","type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"readOnly":true,"type":"string"},"name":{"description":"Operation name.","readOnly":true,"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","readOnly":true,"type":"string"}}},"product":{"allOf":[{"description":"Product Entity Base Parameters","properties":{"approvalRequired":{"description":"whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.","type":"boolean"},"description":{"description":"Product description. May include HTML formatting tags.","maxLength":1000,"minLength":1,"type":"string"},"state":{"description":"whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.","enum":["notPublished","published"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"ProductState"}},"subscriptionRequired":{"description":"Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.","type":"boolean"},"subscriptionsLimit":{"description":"Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.","format":"int32","type":"integer"},"terms":{"description":"Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.","type":"string"}}}],"description":"Product profile.","properties":{"id":{"description":"Identifier of the product in the form of /products/{productId}","type":"string"},"name":{"description":"Product name.","maxLength":300,"minLength":1,"type":"string"}},"required":["name"]},"tag":{"description":"Contract defining the Tag property in the Tag Resource Contract","properties":{"id":{"description":"Tag identifier","type":"string"},"name":{"description":"Tag Name","maxLength":160,"minLength":1,"type":"string"}}}},"required":["tag"]},"type":"array"}}},"examples":{"ApiManagementListApiOperationsByTags":{"$ref":"#/components/examples/ApiManagementListApiOperationsByTags"}}}}}},"tags":["ApiOperationsByTag"],"x-ms-odata":"./definitions.json#/definitions/TagResourceContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies":{"get":{"description":"Get the policy configuration at the API level.","operationId":"ApiPolicy_ListByApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiPolicies":{"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":{"ApiManagementListApiPolicies":{"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":{"ApiManagementListApiPolicies":{"value":"5600b59475ff190048040001"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiPolicies":{"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":{"ApiManagementListApiPolicies":{"value":"subid"}}}],"responses":{"200":{"description":"Apis Policy Collection.","content":{"application/json":{"schema":{"description":"The response of the list policy operation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Policy Contract value.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"type":"array"}}},"examples":{"ApiManagementListApiPolicies":{"$ref":"#/components/examples/ApiManagementListApiPolicies"}}}}},"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":["ApiPolicy"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}":{"delete":{"description":"Deletes the policy configuration at the Api.","operationId":"ApiPolicy_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiPolicy":{"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":{"ApiManagementDeleteApiPolicy":{"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":{"ApiManagementDeleteApiPolicy":{"value":"loggerId"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementDeleteApiPolicy":{"value":"policy"}}},{"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":{"ApiManagementDeleteApiPolicy":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiPolicy":{"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":{"ApiManagementDeleteApiPolicy":{"value":"subid"}}}],"responses":{"200":{"description":"Successfully deleted the policy configuration at the API level."},"204":{"description":"Successfully deleted the policy configuration at the API level."},"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":["ApiPolicy"]},"get":{"description":"Get the policy configuration at the API level.","operationId":"ApiPolicy_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiPolicy":{"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":{"ApiManagementGetApiPolicy":{"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":{"ApiManagementGetApiPolicy":{"value":"5600b59475ff190048040001"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementGetApiPolicy":{"value":"policy"}}},{"description":"Policy Export Format.","in":"query","name":"format","required":false,"x-ms-enum":{"modelAsString":true,"name":"PolicyExportFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["xml","rawxml"],"default":"xml"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiPolicy":{"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":{"ApiManagementGetApiPolicy":{"value":"subid"}}}],"responses":{"200":{"description":"Api Policy information.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementGetApiPolicy":{"$ref":"#/components/examples/ApiManagementGetApiPolicy"}}},"application/vnd.ms-azure-apim.policy+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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementGetApiPolicy":{"$ref":"#/components/examples/ApiManagementGetApiPolicy"}}},"application/vnd.ms-azure-apim.policy.raw+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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementGetApiPolicy":{"$ref":"#/components/examples/ApiManagementGetApiPolicy"}}}}},"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.ms-azure-apim.policy+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.ms-azure-apim.policy.raw+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"}}}}}}}}},"tags":["ApiPolicy"]},"head":{"description":"Gets the entity state (Etag) version of the API policy specified by its identifier.","operationId":"ApiPolicy_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiPolicy":{"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":{"ApiManagementHeadApiPolicy":{"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":{"ApiManagementHeadApiPolicy":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementHeadApiPolicy":{"value":"policy"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiPolicy":{"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":{"ApiManagementHeadApiPolicy":{"value":"subid"}}}],"responses":{"200":{"description":"Specified API Policy entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiPolicy"]},"put":{"description":"Creates or updates policy configuration for the API.","operationId":"ApiPolicy_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiPolicy":{"value":"rg1"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"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":{"ApiManagementCreateApiPolicy":{"value":"apimService1"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"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":{"ApiManagementCreateApiPolicy":{"value":"5600b57e7e8880006a040001"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"value":"5600b57e7e8880006a040001"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementCreateApiPolicy":{"value":"policy"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"value":"policy"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiPolicy":{"value":"*"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiPolicy":{"value":"2019-12-01-preview"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"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":{"ApiManagementCreateApiPolicy":{"value":"subid"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"value":"subid"}}}],"requestBody":{"$ref":"#/components/requestBodies/ApiOperationPolicy_CreateOrUpdateParameters"},"responses":{"200":{"description":"Api policy configuration of the tenant was successfully updated.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementCreateApiPolicy":{"$ref":"#/components/examples/ApiManagementCreateApiPolicy"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"$ref":"#/components/examples/ApiManagementCreateApiPolicyNonXmlEncoded"}}}}},"201":{"description":"Api policy configuration was successfully created.","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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementCreateApiPolicy":{"$ref":"#/components/examples/ApiManagementCreateApiPolicy"},"ApiManagementCreateApiPolicyNonXmlEncoded":{"$ref":"#/components/examples/ApiManagementCreateApiPolicyNonXmlEncoded"}}}}},"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":["ApiPolicy"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products":{"get":{"description":"Lists all Products, which the API is part of.","operationId":"ApiProduct_ListByApis","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiProducts":{"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":{"ApiManagementListApiProducts":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiProducts":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| displayName | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiProducts":{"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":{"ApiManagementListApiProducts":{"value":"subid"}}}],"responses":{"200":{"description":"The operation returns a collection of products which have the Api entity.","content":{"application/json":{"schema":{"description":"Paged Products list representation.","properties":{"nextLink":{"description":"Next page link if any.","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":"Product details.","properties":{"properties":{"allOf":[{"description":"Product Entity Base Parameters","properties":{"approvalRequired":{"description":"whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.","type":"boolean"},"description":{"description":"Product description. May include HTML formatting tags.","maxLength":1000,"minLength":1,"type":"string"},"state":{"description":"whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.","enum":["notPublished","published"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"ProductState"}},"subscriptionRequired":{"description":"Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.","type":"boolean"},"subscriptionsLimit":{"description":"Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.","format":"int32","type":"integer"},"terms":{"description":"Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.","type":"string"}}}],"description":"Product profile.","properties":{"displayName":{"description":"Product name.","maxLength":300,"minLength":1,"type":"string"}},"required":["displayName"]}}},"type":"array"}}},"examples":{"ApiManagementListApiProducts":{"$ref":"#/components/examples/ApiManagementListApiProducts"}}}}},"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":["ApiProduct"],"x-ms-odata":"./definitions.json#/definitions/ProductContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases":{"get":{"description":"Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.","operationId":"ApiRelease_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiReleases":{"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":{"ApiManagementListApiReleases":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiReleases":{"value":"a1"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| notes | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiReleases":{"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":{"ApiManagementListApiReleases":{"value":"subid"}}}],"responses":{"200":{"description":"The operation returns a list of API Releases.","content":{"application/json":{"schema":{"description":"Paged ApiRelease 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":"ApiRelease details.","properties":{"properties":{"description":"API Release details","properties":{"apiId":{"description":"Identifier of the API the release belongs to.","type":"string"},"createdDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"},"notes":{"description":"Release Notes","type":"string"},"updatedDateTime":{"description":"The time the API release was updated.","format":"date-time","readOnly":true,"type":"string"}}}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApiReleases":{"$ref":"#/components/examples/ApiManagementListApiReleases"}}}}},"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":["ApiRelease"],"x-ms-odata":"./definitions.json#/definitions/ApiReleaseContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}":{"delete":{"description":"Deletes the specified release in the API.","operationId":"ApiRelease_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiRelease":{"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":{"ApiManagementDeleteApiRelease":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteApiRelease":{"value":"5a5fcc09124a7fa9b89f2f1d"}}},{"description":"Release identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"releaseId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiRelease":{"value":"testrev"}}},{"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":{"ApiManagementDeleteApiRelease":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiRelease":{"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":{"ApiManagementDeleteApiRelease":{"value":"subid"}}}],"responses":{"200":{"description":"API release successfully removed"},"204":{"description":"API release successfully removed by previous request or does not exist"},"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":["ApiRelease"]},"get":{"description":"Returns the details of an API release.","operationId":"ApiRelease_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiRelease":{"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":{"ApiManagementGetApiRelease":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetApiRelease":{"value":"a1"}}},{"description":"Release identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"releaseId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiRelease":{"value":"5a7cb545298324c53224a799"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiRelease":{"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":{"ApiManagementGetApiRelease":{"value":"subid"}}}],"responses":{"200":{"description":"The operation returns the details of an API Release.","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":"ApiRelease details.","properties":{"properties":{"description":"API Release details","properties":{"apiId":{"description":"Identifier of the API the release belongs to.","type":"string"},"createdDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"},"notes":{"description":"Release Notes","type":"string"},"updatedDateTime":{"description":"The time the API release was updated.","format":"date-time","readOnly":true,"type":"string"}}}}},"examples":{"ApiManagementGetApiRelease":{"$ref":"#/components/examples/ApiManagementGetApiRelease"}}}}},"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":["ApiRelease"]},"head":{"description":"Returns the etag of an API release.","operationId":"ApiRelease_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiRelease":{"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":{"ApiManagementHeadApiRelease":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadApiRelease":{"value":"a1"}}},{"description":"Release identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"releaseId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiRelease":{"value":"5a7cb545298324c53224a799"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiRelease":{"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":{"ApiManagementHeadApiRelease":{"value":"subid"}}}],"responses":{"200":{"description":"Gets the entity state (Etag) version of the api release as specified by its identifier.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiRelease"]},"patch":{"description":"Updates the details of the release of the API specified by its identifier.","operationId":"ApiRelease_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateApiRelease":{"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":{"ApiManagementUpdateApiRelease":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementUpdateApiRelease":{"value":"a1"}}},{"description":"Release identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"releaseId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementUpdateApiRelease":{"value":"testrev"}}},{"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":{"ApiManagementUpdateApiRelease":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateApiRelease":{"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":{"ApiManagementUpdateApiRelease":{"value":"subid"}}}],"requestBody":{"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":"ApiRelease details.","properties":{"properties":{"description":"API Release details","properties":{"apiId":{"description":"Identifier of the API the release belongs to.","type":"string"},"createdDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"},"notes":{"description":"Release Notes","type":"string"},"updatedDateTime":{"description":"The time the API release was updated.","format":"date-time","readOnly":true,"type":"string"}}}}}}},"description":"API Release Update parameters.","required":true},"responses":{"204":{"description":"Release successfully updated"},"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":["ApiRelease"]},"put":{"description":"Creates a new Release for the API.","operationId":"ApiRelease_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiRelease":{"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":{"ApiManagementCreateApiRelease":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateApiRelease":{"value":"a1"}}},{"description":"Release identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"releaseId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiRelease":{"value":"testrev"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiRelease":{"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":{"ApiManagementCreateApiRelease":{"value":"subid"}}}],"requestBody":{"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":"ApiRelease details.","properties":{"properties":{"description":"API Release details","properties":{"apiId":{"description":"Identifier of the API the release belongs to.","type":"string"},"createdDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"},"notes":{"description":"Release Notes","type":"string"},"updatedDateTime":{"description":"The time the API release was updated.","format":"date-time","readOnly":true,"type":"string"}}}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Release was successfully updated.","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":"ApiRelease details.","properties":{"properties":{"description":"API Release details","properties":{"apiId":{"description":"Identifier of the API the release belongs to.","type":"string"},"createdDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"},"notes":{"description":"Release Notes","type":"string"},"updatedDateTime":{"description":"The time the API release was updated.","format":"date-time","readOnly":true,"type":"string"}}}}},"examples":{"ApiManagementCreateApiRelease":{"$ref":"#/components/examples/ApiManagementCreateApiRelease"}}}}},"201":{"description":"Release was successfully created.","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":"ApiRelease details.","properties":{"properties":{"description":"API Release details","properties":{"apiId":{"description":"Identifier of the API the release belongs to.","type":"string"},"createdDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"},"notes":{"description":"Release Notes","type":"string"},"updatedDateTime":{"description":"The time the API release was updated.","format":"date-time","readOnly":true,"type":"string"}}}}},"examples":{"ApiManagementCreateApiRelease":{"$ref":"#/components/examples/ApiManagementCreateApiRelease"}}}}},"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":["ApiRelease"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions":{"get":{"description":"Lists all revisions of an API.","operationId":"ApiRevision_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiRevisions":{"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":{"ApiManagementListApiRevisions":{"value":"apimService1"}}},{"description":"API identifier. Must be unique in the current API Management service instance.","in":"path","name":"apiId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListApiRevisions":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| apiRevision | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiRevisions":{"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":{"ApiManagementListApiRevisions":{"value":"subid"}}}],"responses":{"200":{"description":"The operation returns a list of revision details.","content":{"application/json":{"schema":{"description":"Paged Api Revision list representation.","properties":{"nextLink":{"description":"Next page link if any.","readOnly":true,"type":"string"},"value":{"description":"Page values.","items":{"description":"Summary of revision metadata.","properties":{"apiId":{"description":"Identifier of the API Revision.","readOnly":true,"type":"string"},"apiRevision":{"description":"Revision number of API.","maxLength":100,"minLength":1,"readOnly":true,"type":"string"},"createdDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"Description of the API Revision.","maxLength":256,"readOnly":true,"type":"string"},"isCurrent":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"isOnline":{"description":"Indicates if API revision is the current api revision.","readOnly":true,"type":"boolean"},"privateUrl":{"description":"Gateway URL for accessing the non-current API Revision.","readOnly":true,"type":"string"},"updatedDateTime":{"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.","format":"date-time","readOnly":true,"type":"string"}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApiRevisions":{"$ref":"#/components/examples/ApiManagementListApiRevisions"}}}}},"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":["ApiRevision"],"x-ms-odata":"./definitions.json#/definitions/ApiRevisionContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas":{"get":{"description":"Get the schema configuration at the API level.","operationId":"ApiSchema_ListByApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiSchemas":{"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":{"ApiManagementListApiSchemas":{"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":{"ApiManagementListApiSchemas":{"value":"59d5b28d1f7fab116c282650"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| contentType | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiSchemas":{"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":{"ApiManagementListApiSchemas":{"value":"subid"}}}],"responses":{"200":{"description":"Apis Schema Collection.","content":{"application/json":{"schema":{"description":"The response of the list schema operation.","properties":{"nextLink":{"description":"Next page link if any.","readOnly":true,"type":"string"},"value":{"description":"Api Schema Contract value.","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":"Schema Contract details.","properties":{"properties":{"description":"API Schema create or update contract Properties.","properties":{"contentType":{"description":"Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.","type":"string"},"document":{"description":"Schema Document Properties.","properties":{"definitions":{"description":"Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.","type":"object"},"value":{"description":"Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.","type":"string"}}}},"required":["contentType"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListApiSchemas":{"$ref":"#/components/examples/ApiManagementListApiSchemas"}}}}},"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":["ApiSchema"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}":{"delete":{"description":"Deletes the schema configuration at the Api.","operationId":"ApiSchema_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiSchema":{"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":{"ApiManagementDeleteApiSchema":{"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":{"ApiManagementDeleteApiSchema":{"value":"59d5b28d1f7fab116c282650"}}},{"description":"Schema identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"schemaId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiSchema":{"value":"59d5b28e1f7fab116402044e"}}},{"description":"If true removes all references to the schema before deleting it.","in":"query","name":"force","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":{"ApiManagementDeleteApiSchema":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiSchema":{"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":{"ApiManagementDeleteApiSchema":{"value":"subid"}}}],"responses":{"200":{"description":"Successfully deleted the schema configuration at the API level."},"204":{"description":"Successfully deleted the schema configuration at the API level."},"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":["ApiSchema"]},"get":{"description":"Get the schema configuration at the API level.","operationId":"ApiSchema_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiSchema":{"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":{"ApiManagementGetApiSchema":{"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":{"ApiManagementGetApiSchema":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Schema identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"schemaId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiSchema":{"value":"ec12520d-9d48-4e7b-8f39-698ca2ac63f1"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiSchema":{"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":{"ApiManagementGetApiSchema":{"value":"subid"}}}],"responses":{"200":{"description":"Api Schema information.","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":"Schema Contract details.","properties":{"properties":{"description":"API Schema create or update contract Properties.","properties":{"contentType":{"description":"Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.","type":"string"},"document":{"description":"Schema Document Properties.","properties":{"definitions":{"description":"Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.","type":"object"},"value":{"description":"Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.","type":"string"}}}},"required":["contentType"]}}},"examples":{"ApiManagementGetApiSchema":{"$ref":"#/components/examples/ApiManagementGetApiSchema"}}}}},"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":["ApiSchema"]},"head":{"description":"Gets the entity state (Etag) version of the schema specified by its identifier.","operationId":"ApiSchema_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiSchema":{"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":{"ApiManagementHeadApiSchema":{"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":{"ApiManagementHeadApiSchema":{"value":"57d1f7558aa04f15146d9d8a"}}},{"description":"Schema identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"schemaId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiSchema":{"value":"ec12520d-9d48-4e7b-8f39-698ca2ac63f1"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiSchema":{"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":{"ApiManagementHeadApiSchema":{"value":"subid"}}}],"responses":{"200":{"description":"Specified schema entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiSchema"]},"put":{"description":"Creates or updates schema configuration for the API.","operationId":"ApiSchema_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiSchema":{"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":{"ApiManagementCreateApiSchema":{"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":{"ApiManagementCreateApiSchema":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Schema identifier within an API. Must be unique in the current API Management service instance.","in":"path","name":"schemaId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiSchema":{"value":"ec12520d-9d48-4e7b-8f39-698ca2ac63f1"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiSchema":{"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":{"ApiManagementCreateApiSchema":{"value":"subid"}}}],"requestBody":{"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":"Schema Contract details.","properties":{"properties":{"description":"API Schema create or update contract Properties.","properties":{"contentType":{"description":"Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.","type":"string"},"document":{"description":"Schema Document Properties.","properties":{"definitions":{"description":"Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.","type":"object"},"value":{"description":"Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.","type":"string"}}}},"required":["contentType"]}}}}},"description":"The schema contents to apply.","required":true},"responses":{"200":{"description":"Api schema configuration of the tenant was successfully updated.","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":"Schema Contract details.","properties":{"properties":{"description":"API Schema create or update contract Properties.","properties":{"contentType":{"description":"Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.","type":"string"},"document":{"description":"Schema Document Properties.","properties":{"definitions":{"description":"Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.","type":"object"},"value":{"description":"Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.","type":"string"}}}},"required":["contentType"]}}},"examples":{"ApiManagementCreateApiSchema":{"$ref":"#/components/examples/ApiManagementCreateApiSchema"}}}}},"201":{"description":"Api schema configuration was successfully created.","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":"Schema Contract details.","properties":{"properties":{"description":"API Schema create or update contract Properties.","properties":{"contentType":{"description":"Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.","type":"string"},"document":{"description":"Schema Document Properties.","properties":{"definitions":{"description":"Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise.","type":"object"},"value":{"description":"Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.","type":"string"}}}},"required":["contentType"]}}},"examples":{"ApiManagementCreateApiSchema":{"$ref":"#/components/examples/ApiManagementCreateApiSchema"}}}}},"202":{"description":"Request to create or update Api schema configuration was accepted. Location header contains the URL where the status of the long running operation can be checked."},"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":["ApiSchema"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions":{"get":{"description":"Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations","operationId":"ApiTagDescription_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiTagDescriptions":{"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":{"ApiManagementListApiTagDescriptions":{"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":{"ApiManagementListApiTagDescriptions":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiTagDescriptions":{"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":{"ApiManagementListApiTagDescriptions":{"value":"subid"}}}],"responses":{"200":{"description":"The operation returns a collection of tagDescriptions associated with the Api entity.","content":{"application/json":{"schema":{"description":"Paged TagDescription list representation.","properties":{"nextLink":{"description":"Next page link if any.","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":"Contract details.","properties":{"properties":{"allOf":[{"description":"Parameters supplied to the Create TagDescription operation.","properties":{"description":{"description":"Description of the Tag.","type":"string"},"externalDocsDescription":{"description":"Description of the external resources describing the tag.","type":"string"},"externalDocsUrl":{"description":"Absolute URL of external resources describing the tag.","maxLength":2000,"type":"string"}}}],"description":"TagDescription contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"},"tagId":{"description":"Identifier of the tag in the form of /tags/{tagId}","type":"string"}}}}},"type":"array"}}},"examples":{"ApiManagementListApiTagDescriptions":{"$ref":"#/components/examples/ApiManagementListApiTagDescriptions"}}}}},"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":["ApiTagDescription"],"x-ms-odata":"./definitions.json#/definitions/TagDescriptionContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}":{"delete":{"description":"Delete tag description for the Api.","operationId":"ApiTagDescription_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiTagDescription":{"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":{"ApiManagementDeleteApiTagDescription":{"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":{"ApiManagementDeleteApiTagDescription":{"value":"59d5b28d1f7fab116c282650"}}},{"description":"Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.","in":"path","name":"tagDescriptionId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiTagDescription":{"value":"59d5b28e1f7fab116402044e"}}},{"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":{"ApiManagementDeleteApiTagDescription":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiTagDescription":{"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":{"ApiManagementDeleteApiTagDescription":{"value":"subid"}}}],"responses":{"200":{"description":"Tag description successfully removed"},"204":{"description":"Tag description successfully removed by previous request or does not exist"},"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":["ApiTagDescription"]},"get":{"description":"Get Tag description in scope of API","operationId":"ApiTagDescription_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiTagDescription":{"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":{"ApiManagementGetApiTagDescription":{"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":{"ApiManagementGetApiTagDescription":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.","in":"path","name":"tagDescriptionId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiTagDescription":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiTagDescription":{"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":{"ApiManagementGetApiTagDescription":{"value":"subid"}}}],"responses":{"200":{"description":"Gets the description of the tag specified by its identifier in scope if the Api.","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":"Contract details.","properties":{"properties":{"allOf":[{"description":"Parameters supplied to the Create TagDescription operation.","properties":{"description":{"description":"Description of the Tag.","type":"string"},"externalDocsDescription":{"description":"Description of the external resources describing the tag.","type":"string"},"externalDocsUrl":{"description":"Absolute URL of external resources describing the tag.","maxLength":2000,"type":"string"}}}],"description":"TagDescription contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"},"tagId":{"description":"Identifier of the tag in the form of /tags/{tagId}","type":"string"}}}}},"examples":{"ApiManagementGetApiTagDescription":{"$ref":"#/components/examples/ApiManagementGetApiTagDescription"}}}}},"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":["ApiTagDescription"]},"head":{"description":"Gets the entity state version of the tag specified by its identifier.","operationId":"ApiTagDescription_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiTagDescription":{"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":{"ApiManagementHeadApiTagDescription":{"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":{"ApiManagementHeadApiTagDescription":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.","in":"path","name":"tagDescriptionId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiTagDescription":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiTagDescription":{"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":{"ApiManagementHeadApiTagDescription":{"value":"subid"}}}],"responses":{"200":{"description":"Empty response body, ETag header entity state version.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiTagDescription"]},"put":{"description":"Create/Update tag description in scope of the Api.","operationId":"ApiTagDescription_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiTagDescription":{"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":{"ApiManagementCreateApiTagDescription":{"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":{"ApiManagementCreateApiTagDescription":{"value":"5931a75ae4bbd512a88c680b"}}},{"description":"Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.","in":"path","name":"tagDescriptionId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiTagDescription":{"value":"tagId1"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiTagDescription":{"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":{"ApiManagementCreateApiTagDescription":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Parameters supplied to the Create TagDescription operation.","properties":{"properties":{"description":"Parameters supplied to the Create TagDescription operation.","properties":{"description":{"description":"Description of the Tag.","type":"string"},"externalDocsDescription":{"description":"Description of the external resources describing the tag.","type":"string"},"externalDocsUrl":{"description":"Absolute URL of external resources describing the tag.","maxLength":2000,"type":"string"}}}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Tag Description was updated for the Api.","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":"Contract details.","properties":{"properties":{"allOf":[{"description":"Parameters supplied to the Create TagDescription operation.","properties":{"description":{"description":"Description of the Tag.","type":"string"},"externalDocsDescription":{"description":"Description of the external resources describing the tag.","type":"string"},"externalDocsUrl":{"description":"Absolute URL of external resources describing the tag.","maxLength":2000,"type":"string"}}}],"description":"TagDescription contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"},"tagId":{"description":"Identifier of the tag in the form of /tags/{tagId}","type":"string"}}}}},"examples":{"ApiManagementCreateApiTagDescription":{"$ref":"#/components/examples/ApiManagementCreateApiTagDescription"}}}}},"201":{"description":"Tag Description was created for the Api.","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":"Contract details.","properties":{"properties":{"allOf":[{"description":"Parameters supplied to the Create TagDescription operation.","properties":{"description":{"description":"Description of the Tag.","type":"string"},"externalDocsDescription":{"description":"Description of the external resources describing the tag.","type":"string"},"externalDocsUrl":{"description":"Absolute URL of external resources describing the tag.","maxLength":2000,"type":"string"}}}],"description":"TagDescription contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"},"tagId":{"description":"Identifier of the tag in the form of /tags/{tagId}","type":"string"}}}}},"examples":{"ApiManagementCreateApiTagDescription":{"$ref":"#/components/examples/ApiManagementCreateApiTagDescription"}}}}},"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":["ApiTagDescription"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags":{"get":{"description":"Lists all Tags associated with the API.","operationId":"Tag_ListByApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApiTags":{"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":{"ApiManagementListApiTags":{"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":{"ApiManagementListApiTags":{"value":"57d2ef278aa04f0888cba3f3"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | 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":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApiTags":{"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":{"ApiManagementListApiTags":{"value":"subid"}}}],"responses":{"200":{"description":"The operation returns a collection of tags associated with the Api entity.","content":{"application/json":{"schema":{"description":"Paged Tag list representation.","properties":{"nextLink":{"description":"Next page link if any.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"type":"array"}}},"examples":{"ApiManagementListApiTags":{"$ref":"#/components/examples/ApiManagementListApiTags"}}}}},"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":["ApiTag"],"x-ms-odata":"./definitions.json#/definitions/TagContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}":{"delete":{"description":"Detach the tag from the Api.","operationId":"Tag_DetachFromApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteApiTag":{"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":{"ApiManagementDeleteApiTag":{"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":{"ApiManagementDeleteApiTag":{"value":"59d5b28d1f7fab116c282650"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteApiTag":{"value":"59d5b28e1f7fab116402044e"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteApiTag":{"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":{"ApiManagementDeleteApiTag":{"value":"subid"}}}],"responses":{"200":{"description":"API/Tag association successfully removed"},"204":{"description":"API/Tag association successfully removed by previous request or does not exist"},"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":["ApiTag"]},"get":{"description":"Get tag associated with the API.","operationId":"Tag_GetByApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiTag":{"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":{"ApiManagementGetApiTag":{"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":{"ApiManagementGetApiTag":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetApiTag":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiTag":{"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":{"ApiManagementGetApiTag":{"value":"subid"}}}],"responses":{"200":{"description":"Gets the details of the tag specified by its identifier.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementGetApiTag":{"$ref":"#/components/examples/ApiManagementGetApiTag"}}}}},"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":["ApiTag"]},"head":{"description":"Gets the entity state version of the tag specified by its identifier.","operationId":"Tag_GetEntityStateByApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadApiTag":{"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":{"ApiManagementHeadApiTag":{"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":{"ApiManagementHeadApiTag":{"value":"59d6bb8f1f7fab13dc67ec9b"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadApiTag":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadApiTag":{"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":{"ApiManagementHeadApiTag":{"value":"subid"}}}],"responses":{"200":{"description":"Empty response body, ETag header entity state version.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"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":["ApiTag"]},"put":{"description":"Assign tag to the Api.","operationId":"Tag_AssignToApi","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateApiTag":{"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":{"ApiManagementCreateApiTag":{"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":{"ApiManagementCreateApiTag":{"value":"5931a75ae4bbd512a88c680b"}}},{"description":"Tag identifier. Must be unique in the current API Management service instance.","in":"path","name":"tagId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateApiTag":{"value":"tagId1"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateApiTag":{"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":{"ApiManagementCreateApiTag":{"value":"subid"}}}],"responses":{"200":{"description":"Tag is already assigned to the Api.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementCreateApiTag":{"$ref":"#/components/examples/ApiManagementCreateApiTag"}}}}},"201":{"description":"Tag was assigned to the Api.","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":"Tag Contract details.","properties":{"properties":{"description":"Tag contract Properties.","properties":{"displayName":{"description":"Tag name.","maxLength":160,"minLength":1,"type":"string"}},"required":["displayName"]}}},"examples":{"ApiManagementCreateApiTag":{"$ref":"#/components/examples/ApiManagementCreateApiTag"}}}}},"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":["ApiTag"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}#export=true":{"get":{"description":"Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.","operationId":"ApiExport_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetApiExportInOpenApi2dot0":{"value":"rg1"},"ApiManagementGetApiExportInOpenApi3dot0":{"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":{"ApiManagementGetApiExportInOpenApi2dot0":{"value":"apimService1"},"ApiManagementGetApiExportInOpenApi3dot0":{"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":{"ApiManagementGetApiExportInOpenApi2dot0":{"value":"echo-api"},"ApiManagementGetApiExportInOpenApi3dot0":{"value":"aid9676"}}},{"description":"Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes.","in":"query","name":"format","required":true,"x-ms-enum":{"modelAsString":true,"name":"ExportFormat","values":[{"description":"Export the Api Definition in OpenApi Specification 2.0 format to the Storage Blob.","name":"Swagger","value":"swagger-link"},{"description":"Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`","name":"Wsdl","value":"wsdl-link"},{"description":"Export the Api Definition in WADL Schema to Storage Blob.","name":"Wadl","value":"wadl-link"},{"description":"Export the Api Definition in OpenApi Specification 3.0 to Storage Blob.","name":"Openapi","value":"openapi-link"},{"description":"Export the Api Definition in OpenApi Specification 3.0 as JSON document to Storage Blob.","name":"OpenapiJson","value":"openapi+json-link"}]},"schema":{"type":"string","enum":["swagger-link","wadl-link","wsdl-link","openapi-link","openapi+json-link"]},"examples":{"ApiManagementGetApiExportInOpenApi2dot0":{"value":"swagger-link"},"ApiManagementGetApiExportInOpenApi3dot0":{"value":"openapi-link"}}},{"description":"Query parameter required to export the API details.","in":"query","name":"export","required":true,"x-ms-enum":{"modelAsString":true,"name":"ExportApi"},"schema":{"type":"string","enum":["true"]},"examples":{"ApiManagementGetApiExportInOpenApi2dot0":{"value":"true"},"ApiManagementGetApiExportInOpenApi3dot0":{"value":"true"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetApiExportInOpenApi2dot0":{"value":"2019-12-01-preview"},"ApiManagementGetApiExportInOpenApi3dot0":{"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":{"ApiManagementGetApiExportInOpenApi2dot0":{"value":"subid"},"ApiManagementGetApiExportInOpenApi3dot0":{"value":"subid"}}}],"responses":{"200":{"description":"The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.","content":{"application/json":{"schema":{"description":"API Export result.","properties":{"format":{"description":"Format in which the Api Details are exported to the Storage Blob with Sas Key valid for 5 minutes.","enum":["swagger-link-json","wadl-link-json","wsdl-link+xml","openapi-link"],"type":"string","x-ms-client-name":"ExportResultFormat","x-ms-enum":{"modelAsString":true,"name":"ExportResultFormat","values":[{"description":"The Api Definition is exported in OpenApi Specification 2.0 format to the Storage Blob.","name":"Swagger","value":"swagger-link-json"},{"description":"The Api Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`","name":"Wsdl","value":"wsdl-link+xml"},{"description":"Export the Api Definition in WADL Schema to Storage Blob.","name":"Wadl","value":"wadl-link-json"},{"description":"Export the Api Definition in OpenApi Specification 3.0 to Storage Blob.","name":"OpenApi","value":"openapi-link"}]}},"id":{"description":"ResourceId of the API which was exported.","type":"string"},"value":{"description":"The object defining the schema of the exported Api Detail","properties":{"link":{"description":"Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes.","type":"string"}},"type":"object"}}},"examples":{"ApiManagementGetApiExportInOpenApi2dot0":{"$ref":"#/components/examples/ApiManagementGetApiExportInOpenApi2dot0"},"ApiManagementGetApiExportInOpenApi3dot0":{"$ref":"#/components/examples/ApiManagementGetApiExportInOpenApi3dot0"}}}}},"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":["Apis"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListApis":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1","name":"a1","properties":{"apiRevision":"1","apiVersionSetId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4","displayName":"api1","isCurrent":true,"path":"api1","protocols":["https"],"serviceUrl":"http://echoapi.cloudapp.net/api"},"type":"Microsoft.ApiManagement/service/apis"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533","name":"5a73933b8f27f7cc82a2d533","properties":{"apiRevision":"1","apiVersion":"v1","apiVersionSetId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4","displayName":"api1","isCurrent":true,"path":"api1","protocols":["https"],"serviceUrl":"http://echoapi.cloudapp.net/api"},"type":"Microsoft.ApiManagement/service/apis"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api","name":"echo-api","properties":{"apiRevision":"1","displayName":"Echo API","isCurrent":true,"path":"echo","protocols":["https"],"serviceUrl":"http://echoapi.cloudapp.net/api"},"type":"Microsoft.ApiManagement/service/apis"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0","name":"5a7390baa5816a110435aee0","properties":{"apiRevision":"1","description":"A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification","displayName":"Swagger Petstore Extensive","isCurrent":true,"path":"vvv","protocols":["https"],"serviceUrl":"http://petstore.swagger.wordnik.com/api"},"type":"Microsoft.ApiManagement/service/apis"}]}},"ApiManagementGetApiContract":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a","name":"57d1f7558aa04f15146d9d8a","properties":{"apiRevision":"1","displayName":"Service","isCurrent":true,"isOnline":true,"path":"schulte","protocols":["https"],"serviceUrl":"https://api.plexonline.com/DataSource/Service.asmx","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"type":"soap"},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementGetApiRevisionContract":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3","name":"echo-api;rev=3","properties":{"apiRevision":"3","apiRevisionDescription":"fixed bug in contract","displayName":"Service","path":"schulte","protocols":["https"],"serviceUrl":"https://api.plexonline.com/DataSource/Service.asmx","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApi":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419","name":"apiid9419","properties":{"apiRevision":"1","authenticationSettings":{"oAuth2":{"authorizationServerId":"authorizationServerId2283","scope":"oauth2scope2580"}},"description":"apidescription5200","displayName":"apiname1463","isCurrent":true,"isOnline":true,"path":"newapiPath","protocols":["http","https"],"serviceUrl":"http://newechoapi.cloudapp.net/api","subscriptionKeyParameterNames":{"header":"header4520","query":"query3037"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiClone":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapi2","name":"echoapi2","properties":{"apiRevision":"1","description":"Copy of Existing Echo Api including Operations.","displayName":"Echo API2","isCurrent":true,"path":"echo2","protocols":["http","https"],"serviceUrl":"http://echoapi.cloudapp.net/api","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"subscriptionRequired":true},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiNewVersionUsingExistingApi":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoapiv3","name":"echoapiv3","properties":{"apiRevision":"1","apiVersion":"v4","apiVersionSet":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458","name":"Echo API2","versioningScheme":"Segment"},"apiVersionSetId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458","description":"Create Echo API into a new Version using Existing Version Set and Copy all Operations.","displayName":"Echo API2","isCurrent":true,"path":"echo2","protocols":["http","https"],"serviceUrl":"http://echoapi.cloudapp.net/api","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"subscriptionRequired":true},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiRevisionFromExistingApi":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3","name":"echo-api;rev=3","properties":{"apiRevision":"3","apiRevisionDescription":"Creating a Revision of an existing API","displayName":"Echo API","path":"echo","protocols":["https"],"serviceUrl":"http://echoapi.cloudapp.net/apiv3","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"subscriptionRequired":true},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiUsingImportOverrideServiceUrl":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apidocs","name":"apidocs","properties":{"apiRevision":"1","description":"This is a sample server Petstore server.  You can find out more about Swagger \n    at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com</a> or on irc.freenode.net, #swagger.  For this sample,\n    you can use the api key \"special-key\" to test the authorization filters","displayName":"Swagger Sample App","isCurrent":true,"path":"petstoreapi123","protocols":["https"],"serviceUrl":"http://petstore.swagger.wordnik.com/api","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiUsingOai3Import":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi","name":"petstoreapi","properties":{"apiRevision":"1","displayName":"Swagger Petstore","isCurrent":true,"path":"petstore","protocols":["https"],"serviceUrl":"http://petstore.swagger.io/v1","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiUsingSwaggerImport":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi","name":"petstoreapi","properties":{"apiRevision":"1","description":"This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.","displayName":"Swagger Petstore","isCurrent":true,"path":"petstore","protocols":["http"],"serviceUrl":"http://petstore.swagger.io/v2","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiUsingWadlImport":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl","name":"collectorwadl","properties":{"apiRevision":"1","description":"","displayName":"http://localhost:8080/collector-northbound","isCurrent":true,"path":"collector","protocols":["https"],"serviceUrl":"http://localhost:8080/collector-northbound","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateApiWithOpenIdConnect":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58da4c4ccdae970a08121230","name":"58da4c4ccdae970a08121230","properties":{"apiRevision":"1","authenticationSettings":{"openid":{"bearerTokenSendingMethods":["authorizationHeader"],"openidProviderId":"testopenid"}},"description":"This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.","displayName":"Swagger Petstore","isCurrent":true,"path":"petstore","protocols":["https"],"serviceUrl":"http://petstore.swagger.io/v2","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi","name":"soapApi","properties":{"apiRevision":"1","displayName":"CurrencyConvertor","isCurrent":true,"path":"currency","protocols":["https"],"serviceUrl":"http://www.webservicex.net","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"},"type":"soap"},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi","name":"soapApi","properties":{"apiRevision":"1","displayName":"CurrencyConvertor","isCurrent":true,"path":"currency","protocols":["https"],"serviceUrl":"http://www.webservicex.net","subscriptionKeyParameterNames":{"header":"Ocp-Apim-Subscription-Key","query":"subscription-key"}},"type":"Microsoft.ApiManagement/service/apis"}},"ApiManagementListApiDiagnostics":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights","name":"applicationinsights","properties":{"alwaysLog":"allErrors","backend":{"request":{"body":{"bytes":100},"headers":[]},"response":{"body":{"bytes":100},"headers":[]}},"frontend":{"request":{"body":{"bytes":100},"headers":[]},"response":{"body":{"bytes":100},"headers":[]}},"httpCorrelationProtocol":"Legacy","logClientIp":true,"loggerId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest","sampling":{"percentage":100,"samplingType":"fixed"}},"type":"Microsoft.ApiManagement/service/apis/diagnostics"}]}},"ApiManagementGetApiDiagnostic":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights","name":"applicationinsights","properties":{"alwaysLog":"allErrors","backend":{"request":{"body":{"bytes":100},"headers":[]},"response":{"body":{"bytes":100},"headers":[]}},"frontend":{"request":{"body":{"bytes":100},"headers":[]},"response":{"body":{"bytes":100},"headers":[]}},"httpCorrelationProtocol":"Legacy","logClientIp":true,"loggerId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest","sampling":{"percentage":100,"samplingType":"fixed"}},"type":"Microsoft.ApiManagement/service/apis/diagnostics"}},"ApiManagementCreateApiDiagnostic":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights","name":"applicationinsights","properties":{"alwaysLog":"allErrors","backend":{"request":{"body":{"bytes":512},"headers":["Content-type"]},"response":{"body":{"bytes":512},"headers":["Content-type"]}},"frontend":{"request":{"body":{"bytes":512},"headers":["Content-type"]},"response":{"body":{"bytes":512},"headers":["Content-type"]}},"loggerId":"/loggers/applicationinsights","sampling":{"percentage":50,"samplingType":"fixed"}},"type":"Microsoft.ApiManagement/service/apis/diagnostics"}},"ApiManagementListApiIssues":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc","name":"57d2ef278aa04f0ad01d6cdc","properties":{"apiId":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a","createdDate":"2018-02-01T22:21:20.467Z","description":"New API issue description","state":"open","title":"New API issue","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/apis/issues"}]}},"ApiManagementGetApiIssue":{"value":{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc","name":"57d2ef278aa04f0ad01d6cdc","properties":{"apiId":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a","createdDate":"2018-02-01T22:21:20.467Z","description":"New API issue description","state":"open","title":"New API issue","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/apis/issues"}},"ApiManagementCreateApiIssue":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc","name":"57d2ef278aa04f0ad01d6cdc","properties":{"createdDate":"2018-02-01T22:21:20.467Z","description":"New API issue description","state":"open","title":"New API issue","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/apis/issues"}},"ApiManagementListApiIssueAttachments":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3","name":"57d2ef278aa04f0888cba3f3","properties":{"content":"https://.../image.jpg","contentFormat":"link","title":"Issue attachment."},"type":"Microsoft.ApiManagement/service/apis/issues/attachments"}]}},"ApiManagementGetApiIssueAttachment":{"value":{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3","name":"57d2ef278aa04f0888cba3f3","properties":{"content":"https://.../image.jpg","contentFormat":"link","title":"Issue attachment."},"type":"Microsoft.ApiManagement/service/apis/issues/attachments"}},"ApiManagementCreateApiIssueAttachment":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3","name":"57d2ef278aa04f0888cba3f3","properties":{"content":"https://.../image.jpg","contentFormat":"link","title":"Issue attachment."},"type":"Microsoft.ApiManagement/service/apis/issues/attachments"}},"ApiManagementListApiIssueComments":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb","name":"599e29ab193c3c0bd0b3e2fb","properties":{"createdDate":"2018-02-01T22:21:20.467Z","text":"Issue comment.","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/apis/issues/comments"}]}},"ApiManagementGetApiIssueComment":{"value":{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb","name":"599e29ab193c3c0bd0b3e2fb","properties":{"createdDate":"2018-02-01T22:21:20.467Z","text":"Issue comment.","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/apis/issues/comments"}},"ApiManagementCreateApiIssueComment":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb","name":"599e29ab193c3c0bd0b3e2fb","properties":{"createdDate":"2018-02-01T22:21:20.467Z","text":"Issue comment.","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/apis/issues/comments"}},"ApiManagementListApiOperations":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc","name":"57d2ef278aa04f0ad01d6cdc","properties":{"displayName":"CancelOrder","method":"POST","urlTemplate":"/?soapAction=http://tempuri.org/IFazioService/CancelOrder"},"type":"Microsoft.ApiManagement/service/apis/operations"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda","name":"57d2ef278aa04f0ad01d6cda","properties":{"displayName":"GetMostRecentOrder","method":"POST","urlTemplate":"/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder"},"type":"Microsoft.ApiManagement/service/apis/operations"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9","name":"57d2ef278aa04f0ad01d6cd9","properties":{"displayName":"GetOpenOrders","method":"POST","urlTemplate":"/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders"},"type":"Microsoft.ApiManagement/service/apis/operations"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb","name":"57d2ef278aa04f0ad01d6cdb","properties":{"displayName":"GetOrder","method":"POST","urlTemplate":"/?soapAction=http://tempuri.org/IFazioService/GetOrder"},"type":"Microsoft.ApiManagement/service/apis/operations"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8","name":"57d2ef278aa04f0ad01d6cd8","properties":{"displayName":"submitOrder","method":"POST","urlTemplate":"/?soapAction=http://tempuri.org/IFazioService/submitOrder"},"type":"Microsoft.ApiManagement/service/apis/operations"}]}},"ApiManagementGetApiOperation":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc","name":"57d2ef278aa04f0ad01d6cdc","properties":{"displayName":"CancelOrder","method":"POST","request":{"description":"IFazioService_CancelOrder_InputMessage","headers":[],"queryParameters":[],"representations":[{"contentType":"text/xml","sample":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<Envelope xmlns=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n  <Body>\r\n    <CancelOrder xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://tempuri.org/\">\r\n      <orderId>1</orderId>\r\n    </CancelOrder>\r\n  </Body>\r\n</Envelope>","schemaId":"6980a395-f08b-4a59-8295-1440cbd909b8","typeName":"CancelOrder"}]},"responses":[{"description":"IFazioService_CancelOrder_OutputMessage","headers":[],"representations":[{"contentType":"text/xml","sample":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<Envelope xmlns=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n  <Body>\r\n    <CancelOrderResponse xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://tempuri.org/\">\r\n      <CancelOrderResult>1</CancelOrderResult>\r\n    </CancelOrderResponse>\r\n  </Body>\r\n</Envelope>","schemaId":"6980a395-f08b-4a59-8295-1440cbd909b8","typeName":"CancelOrderResponse"}],"statusCode":200}],"templateParameters":[],"urlTemplate":"/?soapAction=http://tempuri.org/IFazioService/CancelOrder"},"type":"Microsoft.ApiManagement/service/apis/operations"}},"ApiManagementGetApiOperationPetStore":{"value":{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/swagger-petstore/operations/loginUser","name":"loginUser","properties":{"description":"","displayName":"Logs user into the system","method":"GET","request":{"headers":[],"queryParameters":[],"representations":[]},"responses":[{"description":"successful operation","headers":[{"description":"calls per hour allowed by the user","name":"X-Rate-Limit","type":"integer","values":[]},{"description":"date in UTC when token expires","name":"X-Expires-After","type":"string","values":[]}],"representations":[{"contentType":"application/xml","schemaId":"5ba91a35f373b513a0bf31c6","typeName":"UserLoginGet200ApplicationXmlResponse"},{"contentType":"application/json","schemaId":"5ba91a35f373b513a0bf31c6","typeName":"UserLoginGet200ApplicationJsonResponse"}],"statusCode":200},{"description":"Invalid username/password supplied","headers":[],"representations":[{"contentType":"application/xml"},{"contentType":"application/json"}],"statusCode":400}],"templateParameters":[{"description":"The user name for login","name":"username","required":true,"type":"string","values":[]},{"description":"The password for login in clear text","name":"password","required":true,"type":"string","values":[]}],"urlTemplate":"/user/login?username={username}&password={password}"},"type":"Microsoft.ApiManagement/service/apis/operations"}},"ApiManagementCreateApiOperation":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations","name":"newoperations","properties":{"description":"This can only be done by the logged in user.","displayName":"createUser2","method":"POST","request":{"description":"Created user object","headers":[],"queryParameters":[],"representations":[{"contentType":"application/json","schemaId":"592f6c1d0af5840ca8897f0c","typeName":"User"}]},"responses":[{"description":"successful operation","headers":[],"representations":[{"contentType":"application/xml"},{"contentType":"application/json"}],"statusCode":200}],"templateParameters":[],"urlTemplate":"/user1"},"type":"Microsoft.ApiManagement/service/apis/operations"}},"ApiManagementListApiOperationPolicies":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy","name":"policy","properties":{"value":"<!--\r\n    IMPORTANT:\r\n    - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n    - Only the <forward-request> policy element can appear within the <backend> section element.\r\n    - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n    - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n    - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n    - To remove a policy, delete the corresponding policy statement from the policy document.\r\n    - Position the <base> element within a section element to inherit all policies from the corresponding section element in the enclosing scope.\r\n    - Remove the <base> element to prevent inheriting policies from the corresponding section element in the enclosing scope.\r\n    - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n  <inbound>\r\n    <validate-jwt header-name=\"dd\">\r\n      <required-claims>\r\n        <claim name=\"bla\" separator=\"\">\r\n          <value>xxx</value>\r\n        </claim>\r\n      </required-claims>\r\n    </validate-jwt>\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <base />\r\n  </outbound>\r\n</policies>"},"type":"Microsoft.ApiManagement/service/apis/operations/policies"}]}},"ApiManagementGetApiOperationPolicy":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy","name":"policy","properties":{"value":"<policies>\r\n  <inbound>\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <base />\r\n    <set-header name=\"X-My-Sample\" exists-action=\"override\">\r\n      <value>This is a sample</value>\r\n      <!-- for multiple headers with the same name add additional value elements -->\r\n    </set-header>\r\n    <jsonp callback-parameter-name=\"ProcessResponse\" />\r\n  </outbound>\r\n</policies>"},"type":"Microsoft.ApiManagement/service/apis/operations/policies"}},"ApiManagementCreateApiOperationPolicy":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy","name":"policy","properties":{"value":"<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"},"type":"Microsoft.ApiManagement/service/apis/operations/policies"}},"ApiManagementListApiOperationTags":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002","name":"5600b539c53f5b0062060002","properties":{"displayName":"tag1"},"type":"Microsoft.ApiManagement/service/tags"}]}},"ApiManagementGetApiOperationTag":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9","name":"59306a29e4bbd510dc24e5f9","properties":{"displayName":"tag1"},"type":"Microsoft.ApiManagement/service/tags"}},"ApiManagementCreateApiOperationTag":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1","name":"tagId1","properties":{"displayName":"tag1"},"type":"Microsoft.ApiManagement/service/tags"}},"ApiManagementListApiOperationsByTags":{"value":{"value":[{"operation":{"apiName":"Echo API","apiRevision":"1","description":"A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend.","id":"/apis/echo-api/operations/create-resource","method":"POST","name":"Create resource","urlTemplate":"/resource"},"tag":{"id":"/tags/apitag123","name":"awesomeTag"}}]}},"ApiManagementListApiPolicies":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy","name":"policy","properties":{"value":"<!--\r\n    IMPORTANT:\r\n    - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n    - Only the <forward-request> policy element can appear within the <backend> section element.\r\n    - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n    - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n    - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n    - To remove a policy, delete the corresponding policy statement from the policy document.\r\n    - Position the <base> element within a section element to inherit all policies from the corresponding section element in the enclosing scope.\r\n    - Remove the <base> element to prevent inheriting policies from the corresponding section element in the enclosing scope.\r\n    - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n  <inbound>\r\n    <quota-by-key calls=\"5\" bandwidth=\"2\" renewal-period=\"&#x9;P3Y6M4DT12H30M5S\" counter-key=\"ba\" />\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <log-to-eventhub logger-id=\"apimService1\" partition-key=\"@(context.Subscription.Id)\">\r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \";                \r\n                return string.Join(\",\", DateTime.UtcNow, new string(\r\n                    Enumerable.Repeat(Chars, Random.Next(2150400))\r\n                              .Select(s =&gt; s[Random.Next(s.Length)])\r\n                              .ToArray()));\r\n          }                           \r\n                        </log-to-eventhub>\r\n    <base />\r\n  </outbound>\r\n</policies>"},"type":"Microsoft.ApiManagement/service/apis/policies"}]}},"ApiManagementGetApiPolicy":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy","name":"policy","properties":{"value":"<!--\r\n    IMPORTANT:\r\n    - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n    - Only the <forward-request> policy element can appear within the <backend> section element.\r\n    - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n    - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n    - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n    - To remove a policy, delete the corresponding policy statement from the policy document.\r\n    - Position the <base> element within a section element to inherit all policies from the corresponding section element in the enclosing scope.\r\n    - Remove the <base> element to prevent inheriting policies from the corresponding section element in the enclosing scope.\r\n    - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n  <inbound>\r\n    <quota-by-key calls=\"5\" bandwidth=\"2\" renewal-period=\"&#x9;P3Y6M4DT12H30M5S\" counter-key=\"ba\" />\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <log-to-eventhub logger-id=\"apimService1\" partition-key=\"@(context.Subscription.Id)\">\r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \";                \r\n                return string.Join(\",\", DateTime.UtcNow, new string(\r\n                    Enumerable.Repeat(Chars, Random.Next(2150400))\r\n                              .Select(s =&gt; s[Random.Next(s.Length)])\r\n                              .ToArray()));\r\n          }                           \r\n                        </log-to-eventhub>\r\n    <base />\r\n  </outbound>\r\n</policies>"},"type":"Microsoft.ApiManagement/service/apis/policies"}},"ApiManagementCreateApiPolicy":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy","name":"policy","properties":{"value":"<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"},"type":"Microsoft.ApiManagement/service/apis/policies"}},"ApiManagementCreateApiPolicyNonXmlEncoded":{"value":{"id":"/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy","name":"policy","properties":{"value":"<policies>\r\n  <inbound>\r\n    <base />\r\n    <set-header name=\"newvalue\" exists-action=\"override\">\r\n      <value>\"@(context.Request.Headers.FirstOrDefault(h =&gt; h.Ke==\"Via\"))\" </value>\r\n    </set-header>\r\n  </inbound>\r\n</policies>"},"type":"Microsoft.ApiManagement/service/apis/operations/policies"}},"ApiManagementListApiProducts":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b539c53f5b0062060002","name":"5600b539c53f5b0062060002","properties":{"approvalRequired":true,"description":"Subscribers have completely unlimited access to the API. Administrator approval is required.","displayName":"Unlimited","state":"published","subscriptionRequired":true,"subscriptionsLimit":1},"type":"Microsoft.ApiManagement/service/apis/products"}]}},"ApiManagementListApiReleases":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799","name":"5a7cb545298324c53224a799","properties":{"createdDateTime":"2018-02-08T20:38:29.173Z","notes":"yahoo","updatedDateTime":"2018-02-08T20:38:29.173Z"},"type":"Microsoft.ApiManagement/service/apis/releases"}]}},"ApiManagementGetApiRelease":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799","name":"5a7cb545298324c53224a799","properties":{"apiId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1","createdDateTime":"2018-02-08T20:38:29.173Z","notes":"yahoo","updatedDateTime":"2018-02-08T20:38:29.173Z"},"type":"Microsoft.ApiManagement/service/apis/releases"}},"ApiManagementCreateApiRelease":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev","name":"testrev","properties":{"apiId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1","createdDateTime":"2018-02-08T20:52:00.65Z","notes":"yahooagain","updatedDateTime":"2018-02-08T20:52:00.65Z"},"type":"Microsoft.ApiManagement/service/apis/releases"}},"ApiManagementListApiRevisions":{"value":{"nextLink":"","value":[{"apiId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1","apiRevision":"1","createdDateTime":"2018-02-01T22:21:20.467Z","isCurrent":true,"isOnline":true,"updatedDateTime":"2018-02-01T22:21:20.467Z"}]}},"ApiManagementListApiSchemas":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e","name":"59d5b28e1f7fab116402044e","properties":{"contentType":"application/vnd.ms-azure-apim.swagger.definitions+json"},"type":"Microsoft.ApiManagement/service/apis/schemas"}]}},"ApiManagementGetApiSchema":{"value":{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1","name":"ec12520d-9d48-4e7b-8f39-698ca2ac63f1","properties":{"contentType":"application/vnd.ms-azure-apim.xsd+xml","document":{"value":"<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\">\r\n  <s:element name=\"GetWeatherInformation\">\r\n    <s:complexType />\r\n  </s:element>\r\n  <s:element name=\"GetWeatherInformationResponse\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:complexType name=\"ArrayOfWeatherDescription\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"WeatherDescription\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:element name=\"GetCityForecastByZIP\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:element name=\"GetCityForecastByZIPResponse\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:complexType name=\"ForecastReturn\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"ArrayOfForecast\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"Forecast\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"temp\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"POP\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:element name=\"GetCityWeatherByZIP\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:element name=\"GetCityWeatherByZIPResponse\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:complexType name=\"WeatherReturn\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" />\r\n  <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" />\r\n  <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" />\r\n</s:schema>"}},"type":"Microsoft.ApiManagement/service/apis/schemas"}},"ApiManagementCreateApiSchema":{"value":{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1","name":"ec12520d-9d48-4e7b-8f39-698ca2ac63f1","properties":{"contentType":"application/vnd.ms-azure-apim.xsd+xml","document":{"value":"<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\">\r\n  <s:element name=\"GetWeatherInformation\">\r\n    <s:complexType />\r\n  </s:element>\r\n  <s:element name=\"GetWeatherInformationResponse\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:complexType name=\"ArrayOfWeatherDescription\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"WeatherDescription\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:element name=\"GetCityForecastByZIP\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:element name=\"GetCityForecastByZIPResponse\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:complexType name=\"ForecastReturn\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"ArrayOfForecast\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"Forecast\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"temp\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:complexType name=\"POP\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:element name=\"GetCityWeatherByZIP\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:element name=\"GetCityWeatherByZIPResponse\">\r\n    <s:complexType>\r\n      <s:sequence>\r\n        <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" />\r\n      </s:sequence>\r\n    </s:complexType>\r\n  </s:element>\r\n  <s:complexType name=\"WeatherReturn\">\r\n    <s:sequence>\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" />\r\n      <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" />\r\n      <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" />\r\n    </s:sequence>\r\n  </s:complexType>\r\n  <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" />\r\n  <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" />\r\n  <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" />\r\n</s:schema>"}},"type":"Microsoft.ApiManagement/service/apis/schemas"}},"ApiManagementListApiTagDescriptions":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002","name":"5600b539c53f5b0062060002","properties":{"displayName":"tag1","externalDocsDescription":"some additional info","externalDocsUrl":"http://some_url.com","tagId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002"},"type":"Microsoft.ApiManagement/service/tags"}]}},"ApiManagementGetApiTagDescription":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9","name":"59306a29e4bbd510dc24e5f9","properties":{"displayName":"tag1","externalDocsDescription":"some additional info","externalDocsUrl":"http://some_url.com","tagId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9"},"type":"Microsoft.ApiManagement/service/apis/tagDescriptions"}},"ApiManagementCreateApiTagDescription":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1","name":"tagId1","properties":{"description":"Some description that will be displayed for operation's tag if the tag is assigned to operation of the API","displayName":"tag1","externalDocsDescription":"some additional info","externalDocsUrl":"http://some_url.com","tagId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1"},"type":"Microsoft.ApiManagement/service/apis/tagDescriptions"}},"ApiManagementListApiTags":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002","name":"5600b539c53f5b0062060002","properties":{"displayName":"tag1"},"type":"Microsoft.ApiManagement/service/tags"}]}},"ApiManagementGetApiTag":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9","name":"59306a29e4bbd510dc24e5f9","properties":{"displayName":"tag1"},"type":"Microsoft.ApiManagement/service/tags"}},"ApiManagementCreateApiTag":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1","name":"tagId1","properties":{"displayName":"tag1"},"type":"Microsoft.ApiManagement/service/tags"}},"ApiManagementGetApiExportInOpenApi2dot0":{"value":{"format":"swagger-link-json","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api","value":{"link":"https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?sv=2015-07-08&sr=b&sig=mxhLsFuOonu8EXIjyFPV%2FnDra0qTIoip7N7MuU%2BTFsA%3D&se=2019-04-10T22:41:31Z&sp=r"}}},"ApiManagementGetApiExportInOpenApi3dot0":{"value":{"format":"openapi-link","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676","value":{"link":"https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?sv=2015-07-08&sr=b&sig=qqtR1y5iTbz5P7USBduqB5vriIU4gmiGqe0lKVV8j9k%3D&se=2019-04-10T22:40:57Z&sp=r"}}}},"requestBodies":{"ApiOperationPolicy_CreateOrUpdateParameters":{"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":"Policy Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}}}},"description":"The policy contents to apply.","required":true}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}}}}