Operation - List By Tags
Lists a collection of operations associated with tags.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags?api-version=2024-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags?$filter={$filter}&$top={$top}&$skip={$skip}&includeNotTaggedOperations={includeNotTaggedOperations}&api-version=2024-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api
|
path | True |
string |
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. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
$filter
|
query |
string |
| Field | Usage | Supported operators | Supported functions | |
|
$skip
|
query |
integer int32 |
Number of records to skip. |
|
$top
|
query |
integer int32 |
Number of records to return. |
|
include
|
query |
boolean |
Include not tagged Operations. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Lists a collection of TagResource entities. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
ApiManagementListApiOperationsByTags
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/operationsByTags?api-version=2024-05-01
Sample response
{
"value": [
{
"tag": {
"id": "/tags/apitag123",
"name": "awesomeTag"
},
"operation": {
"id": "/apis/echo-api/operations/create-resource",
"apiName": "Echo API",
"apiRevision": "1",
"name": "Create resource",
"method": "POST",
"urlTemplate": "/resource",
"description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."
}
}
],
"count": 1
}
Definitions
Name | Description |
---|---|
Api |
API contact information |
Api |
API license information |
Api |
API contract properties for the Tag Resources. |
Api |
Type of API. |
Authentication |
API Authentication Settings. |
bearer |
How to send token to the server. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
OAuth2Authentication |
API OAuth2 Authentication settings details. |
Open |
API OAuth2 Authentication settings details. |
Operation |
Operation Entity contract Properties. |
Product |
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. |
Product |
Product profile. |
Protocol |
Describes on which protocols the operations in this API can be invoked. |
Subscription |
Subscription key parameter names details. |
Tag |
Paged Tag list representation. |
Tag |
TagResource contract properties. |
Tag |
Contract defining the Tag property in the Tag Resource Contract |
ApiContactInformation
API contact information
Name | Type | Description |
---|---|---|
string |
The email address of the contact person/organization. MUST be in the format of an email address |
|
name |
string |
The identifying name of the contact person/organization |
url |
string |
The URL pointing to the contact information. MUST be in the format of a URL |
ApiLicenseInformation
API license information
Name | Type | Description |
---|---|---|
name |
string |
The license name used for the API |
url |
string |
A URL to the license used for the API. MUST be in the format of a URL |
ApiTagResourceContractProperties
API contract properties for the Tag Resources.
Name | Type | Description |
---|---|---|
apiRevision |
string |
Describes the revision of the API. If no value is provided, default revision 1 is created |
apiRevisionDescription |
string |
Description of the API Revision. |
apiVersion |
string |
Indicates the version identifier of the API if the API is versioned |
apiVersionDescription |
string |
Description of the API Version. |
apiVersionSetId |
string |
A resource identifier for the related ApiVersionSet. |
authenticationSettings |
Collection of authentication settings included into this API. |
|
contact |
Contact information for the API. |
|
description |
string |
Description of the API. May include HTML formatting tags. |
id |
string |
API identifier in the form /apis/{apiId}. |
isCurrent |
boolean |
Indicates if API revision is current api revision. |
isOnline |
boolean |
Indicates if API revision is accessible via the gateway. |
license |
License information for the API. |
|
name |
string |
API name. |
path |
string |
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. |
protocols |
Protocol[] |
Describes on which protocols the operations in this API can be invoked. |
serviceUrl |
string |
Absolute URL of the backend service implementing this API. |
subscriptionKeyParameterNames |
Protocols over which API is made available. |
|
subscriptionRequired |
boolean |
Specifies whether an API or Product subscription is required for accessing the API. |
termsOfServiceUrl |
string |
A URL to the Terms of Service for the API. MUST be in the format of a URL. |
type |
Type of API. |
ApiType
Type of API.
Name | Type | Description |
---|---|---|
graphql |
string |
|
grpc |
string |
|
http |
string |
|
odata |
string |
|
soap |
string |
|
websocket |
string |
AuthenticationSettingsContract
API Authentication Settings.
Name | Type | Description |
---|---|---|
oAuth2 |
OAuth2 Authentication settings |
|
oAuth2AuthenticationSettings |
Collection of OAuth2 authentication settings included into this API. |
|
openid |
OpenID Connect Authentication Settings |
|
openidAuthenticationSettings |
Collection of Open ID Connect authentication settings included into this API. |
bearerTokenSendingMethods
How to send token to the server.
Name | Type | Description |
---|---|---|
authorizationHeader |
string |
Access token will be transmitted in the Authorization header using Bearer schema |
query |
string |
Access token will be transmitted as query parameters. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
OAuth2AuthenticationSettingsContract
API OAuth2 Authentication settings details.
Name | Type | Description |
---|---|---|
authorizationServerId |
string |
OAuth authorization server identifier. |
scope |
string |
operations scope. |
OpenIdAuthenticationSettingsContract
API OAuth2 Authentication settings details.
Name | Type | Description |
---|---|---|
bearerTokenSendingMethods |
How to send token to the server. |
|
openidProviderId |
string |
OAuth authorization server identifier. |
OperationTagResourceContractProperties
Operation Entity contract Properties.
Name | Type | Description |
---|---|---|
apiName |
string |
API Name. |
apiRevision |
string |
API Revision. |
apiVersion |
string |
API Version. |
description |
string |
Operation Description. |
id |
string |
Identifier of the operation in form /operations/{operationId}. |
method |
string |
A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. |
name |
string |
Operation name. |
urlTemplate |
string |
Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} |
ProductState
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.
Name | Type | Description |
---|---|---|
notPublished |
string |
|
published |
string |
ProductTagResourceContractProperties
Product profile.
Name | Type | Description |
---|---|---|
approvalRequired |
boolean |
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 false. |
description |
string |
Product description. May include HTML formatting tags. |
id |
string |
Identifier of the product in the form of /products/{productId} |
name |
string |
Product name. |
state |
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. |
|
subscriptionRequired |
boolean |
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. |
subscriptionsLimit |
integer |
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 false. |
terms |
string |
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. |
Protocol
Describes on which protocols the operations in this API can be invoked.
Name | Type | Description |
---|---|---|
http |
string |
|
https |
string |
|
ws |
string |
|
wss |
string |
SubscriptionKeyParameterNamesContract
Subscription key parameter names details.
Name | Type | Description |
---|---|---|
header |
string |
Subscription key header name. |
query |
string |
Subscription key query string parameter name. |
TagResourceCollection
Paged Tag list representation.
Name | Type | Description |
---|---|---|
count |
integer |
Total record count number across all pages. |
nextLink |
string |
Next page link if any. |
value |
Page values. |
TagResourceContract
TagResource contract properties.
Name | Type | Description |
---|---|---|
api |
API associated with the tag. |
|
operation |
Operation associated with the tag. |
|
product |
Product associated with the tag. |
|
tag |
Tag associated with the resource. |
TagTagResourceContractProperties
Contract defining the Tag property in the Tag Resource Contract
Name | Type | Description |
---|---|---|
id |
string |
Tag identifier |
name |
string |
Tag Name |