openapi-directory/api/azure.com/apimanagement-apimproducts.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 Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.","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/apimproducts.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimproducts","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products":{"get":{"description":"Lists a collection of products in the specified service instance.","operationId":"Product_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListProducts":{"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":{"ApiManagementListProducts":{"value":"apimService1"}}},{"description":"| Field       | Supported operators    | Supported functions                         |\n|-------------|------------------------|---------------------------------------------|\n| id          | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name        | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| terms       | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state       | eq                     |                                             |","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":"When set to true, the response contains an array of groups that have visibility to the product. The default is false.","in":"query","name":"expandGroups","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":{"ApiManagementListProducts":{"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":{"ApiManagementListProducts":{"value":"subid"}}}],"responses":{"200":{"description":"A Collection of the Product entities for the specified API Management service instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"},"examples":{"ApiManagementListProducts":{"$ref":"#/components/examples/ApiManagementListProducts"}}}}},"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":["Products"],"x-ms-odata":"#/components/schemas/ProductContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}":{"delete":{"description":"Delete product.","operationId":"Product_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteProduct":{"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":{"ApiManagementDeleteProduct":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"description":"Delete existing subscriptions associated with the product or not.","in":"query","name":"deleteSubscriptions","required":false,"schema":{"type":"boolean"},"examples":{"ApiManagementDeleteProduct":{"value":true}}},{"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":{"ApiManagementDeleteProduct":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteProduct":{"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":{"ApiManagementDeleteProduct":{"value":"subid"}}}],"responses":{"200":{"description":"The product was successfully deleted."},"204":{"description":"The product 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":["Products"]},"get":{"description":"Gets the details of the product specified by its identifier.","operationId":"Product_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetProduct":{"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":{"ApiManagementGetProduct":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetProduct":{"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":{"ApiManagementGetProduct":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Product 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/ProductContract"},"examples":{"ApiManagementGetProduct":{"$ref":"#/components/examples/ApiManagementGetProduct"}}}}},"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":["Products"]},"head":{"description":"Gets the entity state (Etag) version of the product specified by its identifier.","operationId":"Product_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadProduct":{"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":{"ApiManagementHeadProduct":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadProduct":{"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":{"ApiManagementHeadProduct":{"value":"subid"}}}],"responses":{"200":{"description":"Specified Product 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":["Products"]},"patch":{"description":"Update product.","operationId":"Product_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateProductBasic":{"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":{"ApiManagementUpdateProductBasic":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"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":{"ApiManagementUpdateProductBasic":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateProductBasic":{"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":{"ApiManagementUpdateProductBasic":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductUpdateParameters"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"No Content in case of Update Successful."},"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":["Products"]},"put":{"description":"Creates or Updates a product.","operationId":"Product_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateProductBasic":{"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":{"ApiManagementCreateProductBasic":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"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":{"ApiManagementCreateProductBasic":{"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":{"ApiManagementCreateProductBasic":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductContract"}}},"description":"Create or update parameters.","required":true},"responses":{"200":{"description":"Product was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductContract"},"examples":{"ApiManagementCreateProductBasic":{"$ref":"#/components/examples/ApiManagementCreateProductBasic"}}}}},"201":{"description":"Product was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductContract"},"examples":{"ApiManagementCreateProductBasic":{"$ref":"#/components/examples/ApiManagementCreateProductBasic"}}}}},"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":["Products"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis":{"get":{"description":"Lists a collection of the APIs associated with a product.","operationId":"ProductApi_ListByProduct","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListProductApis":{"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":{"ApiManagementListProductApis":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"description":"| Field       | Supported operators    | Supported functions                         |\n|-------------|------------------------|---------------------------------------------|\n| id          | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name        | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl  | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path        | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n","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":{"ApiManagementListProductApis":{"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":{"ApiManagementListProductApis":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains a collection of Api entities in the product.","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"}}},"subscriptionKeyRequired":{"description":"Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.","type":"boolean"}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","readOnly":true,"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"},"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.","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":0,"type":"string"}},"required":["path"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListProductApis":{"$ref":"#/components/examples/ApiManagementListProductApis"}}}}},"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":["ProductApis"],"x-ms-odata":"./apimapis.json#/definitions/ApiContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}":{"delete":{"description":"Deletes the specified API from the specified product.","operationId":"ProductApi_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteProductApi":{"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":{"ApiManagementDeleteProductApi":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"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":{"ApiManagementDeleteProductApi":{"value":"echo-api"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteProductApi":{"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":{"ApiManagementDeleteProductApi":{"value":"subid"}}}],"responses":{"200":{"description":"The API was successfully removed from the product."},"204":{"description":"The API was successfully removed from the product."},"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":["ProductApis"]},"head":{"description":"Checks that API entity specified by identifier is associated with the Product entity.","operationId":"ProductApi_CheckEntityExists","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadProductApi":{"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":{"ApiManagementHeadProductApi":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"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":{"ApiManagementHeadProductApi":{"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":{"ApiManagementHeadProductApi":{"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":{"ApiManagementHeadProductApi":{"value":"subid"}}}],"responses":{"204":{"description":"Entity exists"},"404":{"description":"API is not associated with the product."},"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":["ProductApis"]},"put":{"description":"Adds an API to the specified product.","operationId":"ProductApi_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateProductApi":{"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":{"ApiManagementCreateProductApi":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"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":{"ApiManagementCreateProductApi":{"value":"echo-api"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateProductApi":{"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":{"ApiManagementCreateProductApi":{"value":"subid"}}}],"responses":{"200":{"description":"The specified API is already added to the product.","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"}}},"subscriptionKeyRequired":{"description":"Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.","type":"boolean"}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","readOnly":true,"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"},"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.","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":0,"type":"string"}},"required":["path"]}}},"examples":{"ApiManagementCreateProductApi":{"$ref":"#/components/examples/ApiManagementCreateProductApi"}}}}},"201":{"description":"The API was successfully added to the product.","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"}}},"subscriptionKeyRequired":{"description":"Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.","type":"boolean"}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","readOnly":true,"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"},"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.","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":0,"type":"string"}},"required":["path"]}}},"examples":{"ApiManagementCreateProductApi":{"$ref":"#/components/examples/ApiManagementCreateProductApi"}}}}},"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":["ProductApis"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups":{"get":{"description":"Lists the collection of developer groups associated with the specified product.","operationId":"ProductGroup_ListByProduct","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListProductGroups":{"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":{"ApiManagementListProductGroups":{"value":"apimService1"}}},{"$ref":"#/components/parameters/ProductIdParameter"},{"description":"| Field       | Supported operators    | Supported functions                         |\n|-------------|------------------------|---------------------------------------------|\n| id          | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name        | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type        | eq, ne                 | N/A                                         |","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":{"ApiManagementListProductGroups":{"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":{"ApiManagementListProductGroups":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Group entities.","content":{"application/json":{"schema":{"description":"Paged Group 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":{"description":"Group contract Properties.","properties":{"builtIn":{"description":"true if the group is one of the three system groups (Administrators, Developers, or Gue