Tag - List By Api

Lists all Tags associated with the API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags?api-version=2021-01-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-01-01-preview

URI Parameters

Name In Required Type Description
apiId
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: ^[^*#&+:<>?]+$

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Version of the API to be used with the client request.

$filter
query
  • string

| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query
  • integer
int32

Number of records to skip.

$top
query
  • integer
int32

Number of records to return.

Responses

Name Type Description
200 OK

The operation returns a collection of tags associated with the Api entity.

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

ApiManagementListApiTags

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/tags?api-version=2021-01-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002",
      "type": "Microsoft.ApiManagement/service/tags",
      "name": "5600b539c53f5b0062060002",
      "properties": {
        "displayName": "tag1"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

TagCollection

Paged Tag list representation.

TagContract

Tag Contract details.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

TagCollection

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.

TagContract

Tag Contract details.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.displayName
  • string

Tag name.

type
  • string

Resource type for API Management resource.