openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 325 kB
JSON
{"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":"2018-06-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/2018-06-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 | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |","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":{"ApiManagementListApis":{"value":"2018-06-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"}}},{"description":"Include full ApiVersionSet resource in response","in":"query","name":"expandApiVersionSet","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Paged Result response of Apis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCollection"},"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":["Apis"],"x-ms-odata":"#/components/schemas/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.json":{"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.json":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ApiIdRevParameter"},{"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.json":{"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.json":{"value":"2018-06-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.json":{"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":["Apis"]},"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"}}},{"$ref":"#/components/parameters/ApiIdRevParameter"},{"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":"2018-06-01-preview"},"ApiManagementGetApiRevisionContract":{"value":"2018-06-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":{"$ref":"#/components/schemas/ApiContract"},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.sun.wadl+xml":{"schema":{"$ref":"#/components/schemas/ApiContract"},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.swagger.doc+json":{"schema":{"$ref":"#/components/schemas/ApiContract"},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/wsdl+xml":{"schema":{"$ref":"#/components/schemas/ApiContract"},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.oai.openapi":{"schema":{"$ref":"#/components/schemas/ApiContract"},"examples":{"ApiManagementGetApiContract":{"$ref":"#/components/examples/ApiManagementGetApiContract"},"ApiManagementGetApiRevisionContract":{"$ref":"#/components/examples/ApiManagementGetApiRevisionContract"}}},"application/vnd.oai.openapi+json":{"schema":{"$ref":"#/components/schemas/ApiContract"},"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":["Apis"]},"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"}}},{"$ref":"#/components/parameters/ApiIdRevParameter"},{"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":"2018-06-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":["Apis"]},"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.json":{"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.json":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ApiIdRevParameter"},{"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.json":{"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.json":{"value":"2018-06-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.json":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiUpdateContract"}}},"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":["Apis"]},"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"},"ApiManagementCreateApiRevision":{"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"},"ApiManagementCreateApiRevision":{"value":"apimService1"},"ApiManagementCreateApiUsingOai3Import":{"value":"apimService1"},"ApiManagementCreateApiUsingSwaggerImport":{"value":"apimService1"},"ApiManagementCreateApiUsingWadlImport":{"value":"apimService1"},"ApiManagementCreateApiWithOpenIdConnect":{"value":"apimService1"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":"apimService1"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ApiIdRevParameter"},{"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":"2018-06-01-preview"},"ApiManagementCreateApiRevision":{"value":"2018-06-01-preview"},"ApiManagementCreateApiUsingOai3Import":{"value":"2018-06-01-preview"},"ApiManagementCreateApiUsingSwaggerImport":{"value":"2018-06-01-preview"},"ApiManagementCreateApiUsingWadlImport":{"value":"2018-06-01-preview"},"ApiManagementCreateApiWithOpenIdConnect":{"value":"2018-06-01-preview"},"ApiManagementCreateSoapPassThroughApiUsingWsdlImport":{"value":"2018-06-01-preview"},"ApiManagementCreateSoapToRestApiUsingWsdlImport":{"value":"2018-06-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"},"ApiManagementCreateApiRevision":{"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":{"$ref":"#/components/schemas/ApiCreateOrUpdateParameter"}},"application/vnd.sun.wadl+xml":{"schema":{"$ref":"#/components/schemas/ApiCreateOrUpdateParameter"}},"application/vnd.swagger.doc+json":{"schema":{"$ref":"#/components/schemas/ApiCreateOrUpdateParameter"}},"application/wsdl+xml":{"schema":{"$ref":"#/components/schemas/ApiCreateOrUpdateParameter"}},"application/vnd.oai.openapi":{"schema":{"$ref":"#/components/schemas/ApiCreateOrUpdateParameter"}},"application/vnd.oai.openapi+json":{"schema":{"$ref":"#/components/schemas/ApiCreateOrUpdateParameter"}}},"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":{"$ref":"#/components/schemas/ApiContract"},"examples":{"ApiManagementCreateApi":{"$ref":"#/components/examples/ApiManagementCreateApi"},"ApiManagementCreateApiRevision":{"$ref":"#/components/examples/ApiManagementCreateApiRevision"},"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":{"$ref":"#/components/schemas/ApiContract"},"examples":{"ApiManagementCreateApi":{"$ref":"#/components/examples/ApiManagementCreateApi"},"ApiManagementCreateApiRevision":{"$ref":"#/components/examples/ApiManagementCreateApiRevision"},"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"}}}}},"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"]}},"/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"}}},{"$ref":"#/components/parameters/ApiIdParameter"},{"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":"2018-06-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"}}},{"description":"| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |","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}}],"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"}}}}},"enableHttpCorrelationHeaders":{"description":"Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true.","type":"boolean"},"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"}}}}},"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"}]}}}}},"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":["ApiDiagnostics"],"x-ms-odata":"./apimdiagnostics.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"}}},{"$ref":"#/components/parameters/ApiIdParameter"},{"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":"(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)"},"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":"2018-06-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":"The Diagnostic was successfully deleted."},"204":{"description":"The Diagnostic 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":["ApiDiagnostics"]},"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"}}},{"$ref":"#/components/parameters/ApiIdParameter"},{"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":"(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)"},"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":"2018-06-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"}}}}},"enableHttpCorrelationHeaders":{"description":"Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true.","type":"boolean"},"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"}}}}},"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"}]}}}}},"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":["ApiDiagnostics"]},"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"}}},{"$ref":"#/components/parameters/ApiIdParameter"},{"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":"(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)"},"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":"2018-06-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":["ApiDiagnostics"]},"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"}}},{"$ref":"#/components/parameters/ApiIdParameter"},{"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":"(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)"},"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":"2018-06-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":[{"descri