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

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

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.","title":"ApiManagementClient","version":"2016-10-10","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/stable/2016-10-10/apimbackends.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimbackends","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends":{"get":{"description":"Lists a collection of backends in the specified service instance.","externalDocs":{"url":"https://msdn.microsoft.com/en-us/library/dn935030.aspx"},"operationId":"Backends_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"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])?$"}},{"description":"| Field | Supported operators    | Supported functions                         |\n|-------|------------------------|---------------------------------------------|\n| id    | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| host  | ge, le, eq, ne, gt, lt | substringof, contains, 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"}},{"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"}}],"responses":{"200":{"description":"Lists a collection of Backend entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendCollection"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"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":["Backends"],"x-ms-odata":"#/components/schemas/BackendResponse","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}":{"delete":{"description":"Deletes the specified backend.","operationId":"Backends_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"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])?$"}},{"$ref":"#/components/parameters/BackendIdParameter"},{"description":"The entity state (Etag) version of the backend to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","in":"header","name":"If-Match","required":true,"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"}},{"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"}}],"responses":{"204":{"description":"The backend was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"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":["Backends"]},"get":{"description":"Gets the details of the backend specified by its identifier.","operationId":"Backends_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"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])?$"}},{"$ref":"#/components/parameters/BackendIdParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"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"}}],"responses":{"200":{"description":"The response body contains the specified Backend 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/BackendResponse"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"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":["Backends"]},"patch":{"description":"Updates an existing backend.","operationId":"Backends_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"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])?$"}},{"$ref":"#/components/parameters/BackendIdParameter"},{"description":"The entity state (Etag) version of the backend to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","in":"header","name":"If-Match","required":true,"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"}},{"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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The existing backend was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"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":["Backends"]},"put":{"description":"Creates or Updates a backend.","operationId":"Backends_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"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])?$"}},{"$ref":"#/components/parameters/BackendIdParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendContract"}}},"description":"Create parameters.","required":true},"responses":{"201":{"description":"Backend was successfully created."},"204":{"description":"The existing backend was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"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":["Backends"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"parameters":{"BackendIdParameter":{"description":"Identifier of the Backend entity. Must be unique in the current API Management service instance.","in":"path","name":"backendid","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^*#&+:<>?]+$"}}},"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"}}}}},"schemas":{"BackendAuthorizationHeaderCredentials":{"description":"Authorization header information.","properties":{"parameter":{"description":"Authentication Parameter value.","maxLength":300,"minLength":1,"type":"string"},"scheme":{"description":"Authentication Scheme name.","maxLength":100,"minLength":1,"type":"string"}},"required":["scheme","parameter"]},"BackendBaseParameters":{"allOf":[{"$ref":"#/components/schemas/BackendCredentialsContract"},{"$ref":"#/components/schemas/BackendProxyContract"}],"description":"Backend entity base Parameter set.","properties":{"description":{"description":"Backend Description.","maxLength":2000,"minLength":1,"type":"string"},"properties":{"$ref":"#/components/schemas/BackendProperties"},"resourceId":{"description":"Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.","maxLength":2000,"minLength":1,"type":"string"},"title":{"description":"Backend Title.","maxLength":300,"minLength":1,"type":"string"}}},"BackendCollection":{"description":"Paged Backend list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Backend values.","items":{"$ref":"#/components/schemas/BackendResponse"},"type":"array"}}},"BackendContract":{"allOf":[{"$ref":"#/components/schemas/BackendBaseParameters"}],"description":"Parameters supplied to the Create Backend operation.","properties":{"id":{"description":"Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier.","readOnly":true,"type":"string"},"protocol":{"description":"Backend communication protocol.","enum":["http","soap"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"BackendProtocol"}},"url":{"description":"Runtime Url of the Backend.","maxLength":2000,"minLength":1,"type":"string"}},"required":["url","protocol"]},"BackendCredentialsContract":{"allOf":[{"$ref":"#/components/schemas/BackendAuthorizationHeaderCredentials"}],"description":"Details of the Credentials used to connect to Backend.","properties":{"certificate":{"description":"List of Client Certificate Thumbprint.","items":{"type":"string"},"maxItems":32,"type":"array"},"header":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Header Parameter description.","type":"object"},"query":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Query Parameter description.","type":"object"}}},"BackendProperties":{"description":"Properties specific to a Backend.","properties":{"skipCertificateChainValidation":{"default":false,"description":"Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.","type":"boolean"},"skipCertificateNameValidation":{"default":false,"description":"Flag indicating whether SSL certificate name validation should be skipped when using self-signed certificates for this backend host.","type":"boolean"}}},"BackendProxyContract":{"description":"Details of the Backend WebProxy Server to use in the Request to Backend.","externalDocs":{"description":"Backend entity uses these details to connect to a WebProxy.","url":"https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx"},"properties":{"password":{"description":"Password to connect to the WebProxy Server","type":"string"},"url":{"description":"WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.","maxLength":2000,"minLength":1,"type":"string"},"username":{"description":"Username to connect to the WebProxy server","type":"string"}},"required":["url"]},"BackendResponse":{"allOf":[{"$ref":"#/components/schemas/BackendContract"}],"description":"The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.","properties":{"id":{"description":"Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier.","readOnly":true,"type":"string"}}},"BackendUpdateParameters":{"allOf":[{"$ref":"#/components/schemas/BackendBaseParameters"}],"description":"Parameters supplied to the Update Backend operation.","properties":{"protocol":{"description":"Backend communication protocol.","enum":["http","soap"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"BackendProtocol"}},"url":{"description":"Runtime Url of the Backend.","maxLength":2000,"minLength":1,"type":"string"}}}}}}