openapi-directory/api/azure.com/apimanagement-apimapisByTags.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 retrieve a collection of Apis associated with a tag in Azure API Management deployment.","title":"ApiManagementClient","version":"2019-12-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimapisByTags.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimapisByTags","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags":{"get":{"description":"Lists a collection of apis associated with tags.","operationId":"Api_ListByTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListApisByTags":{"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":{"ApiManagementListApisByTags":{"value":"apimService1"}}},{"description":"| Field       | Supported operators    | Supported functions               |\n|-------------|------------------------|-----------------------------------|\n\r\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|path | 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|isCurrent | eq |    |\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":"Include not tagged APIs.","in":"query","name":"includeNotTaggedApis","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":{"ApiManagementListApisByTags":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListApisByTags":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of TagResource entities.","content":{"application/json":{"schema":{"description":"Paged Tag list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"description":"TagResource contract properties.","properties":{"api":{"allOf":[{"description":"API base contract details.","properties":{"apiRevision":{"description":"Describes the Revision of the Api. If no value is provided, default revision 1 is created","maxLength":100,"minLength":1,"type":"string"},"apiRevisionDescription":{"description":"Description of the Api Revision.","maxLength":256,"type":"string"},"apiVersion":{"description":"Indicates the Version identifier of the API if the API is versioned","maxLength":100,"type":"string"},"apiVersionDescription":{"description":"Description of the Api Version.","maxLength":256,"type":"string"},"apiVersionSetId":{"description":"A resource identifier for the related ApiVersionSet.","type":"string"},"authenticationSettings":{"description":"API Authentication Settings.","properties":{"oAuth2":{"description":"API OAuth2 Authentication settings details.","properties":{"authorizationServerId":{"description":"OAuth authorization server identifier.","type":"string"},"scope":{"description":"operations scope.","type":"string"}}},"openid":{"description":"API OAuth2 Authentication settings details.","properties":{"bearerTokenSendingMethods":{"description":"How to send token to the server.","items":{"description":"Form of an authorization grant, which the client uses to request the access token.","enum":["authorizationHeader","query"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"bearerTokenSendingMethods","values":[{"description":"Access token will be transmitted in the Authorization header using Bearer schema","value":"authorizationHeader"},{"description":"Access token will be transmitted as query parameters.","value":"query"}]}},"type":"array"},"openidProviderId":{"description":"OAuth authorization server identifier.","type":"string"}}}}},"description":{"description":"Description of the API. May include HTML formatting tags.","type":"string"},"isCurrent":{"description":"Indicates if API revision is current api revision.","type":"boolean"},"isOnline":{"description":"Indicates if API revision is accessible via the gateway.","readOnly":true,"type":"boolean"},"subscriptionKeyParameterNames":{"description":"Subscription key parameter names details.","example":{"subscriptionKeyParameterNames":{"header":"customHeaderParameterName","query":"customQueryParameterName"}},"properties":{"header":{"description":"Subscription key header name.","type":"string"},"query":{"description":"Subscription key query string parameter name.","type":"string"}}},"subscriptionRequired":{"description":"Specifies whether an API or Product subscription is required for accessing the API.","type":"boolean"},"type":{"description":"Type of API.","enum":["http","soap"],"type":"string","x-ms-client-name":"ApiType","x-ms-enum":{"modelAsString":true,"name":"ApiType"}}}}],"description":"API contract properties for the Tag Resources.","properties":{"id":{"description":"API identifier in the form /apis/{apiId}.","type":"string"},"name":{"description":"API name.","maxLength":300,"minLength":1,"type":"string"},"path":{"description":"Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.","maxLength":400,"minLength":0,"type":"string"},"protocols":{"description":"Describes on which protocols the operations in this API can be invoked.","items":{"enum":["http","https"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"Protocol"}},"type":"array"},"serviceUrl":{"description":"Absolute URL of the backend service implementing this API.","maxLength":2000,"minLength":1,"type":"string"}}},"operation":{"description":"Operation Entity contract Properties.","properties":{"apiName":{"description":"Api Name.","readOnly":true,"type":"string"},"apiRevision":{"description":"Api Revision.","readOnly":true,"type":"string"},"apiVersion":{"description":"Api Version.","readOnly":true,"type":"string"},"description":{"description":"Operation Description.","readOnly":true,"type":"string"},"id":{"description":"Identifier of the operation in form /operations/{operationId}.","type":"string"},"method":{"description":"A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.","externalDocs":{"description":"As defined by RFC.","url":"http://www.rfc-editor.org/rfc/rfc7230.txt"},"readOnly":true,"type":"string"},"name":{"description":"Operation name.","readOnly":true,"type":"string"},"urlTemplate":{"description":"Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}","readOnly":true,"type":"string"}}},"product":{"allOf":[{"description":"Product Entity Base Parameters","properties":{"approvalRequired":{"description":"whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.","type":"boolean"},"description":{"description":"Product description. May include HTML formatting tags.","maxLength":1000,"minLength":1,"type":"string"},"state":{"description":"whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.","enum":["notPublished","published"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"ProductState"}},"subscriptionRequired":{"description":"Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.","type":"boolean"},"subscriptionsLimit":{"description":"Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.","format":"int32","type":"integer"},"terms":{"description":"Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.","type":"string"}}}],"description":"Product profile.","properties":{"id":{"description":"Identifier of the product in the form of /products/{productId}","type":"string"},"name":{"description":"Product name.","maxLength":300,"minLength":1,"type":"string"}},"required":["name"]},"tag":{"description":"Contract defining the Tag property in the Tag Resource Contract","properties":{"id":{"description":"Tag identifier","type":"string"},"name":{"description":"Tag Name","maxLength":160,"minLength":1,"type":"string"}}}},"required":["tag"]},"type":"array"}}},"examples":{"ApiManagementListApisByTags":{"$ref":"#/components/examples/ApiManagementListApisByTags"}}}}},"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":["ApisByTag"],"x-ms-odata":"./definitions.json#/definitions/TagResourceContract","x-ms-pageable":{"nextLinkName":"nextLink"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListApisByTags":{"value":{"value":[{"api":{"apiRevision":"1","id":"/apis/echo-api","isCurrent":true,"name":"Echo API","path":"echo","serviceUrl":"http://echoapi.cloudapp.net/api"},"tag":{"id":"/tags/apitag123","name":"awesomeTag"}}]}}},"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"}}}}}}}