ApiManagementClient
Use these REST APIs for performing operations on Tag entity in your Azure API Management deployment
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "Use these REST APIs for performing operations on Tag entity in your Azure API Management deployment. Tags can be assigned to APIs, Operations and Products.",
"title": "ApiManagementClient",
"version": "2019-12-01-preview",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/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/apimtags.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "apimanagement-apimtags",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags": {
"get": {
"description": "Lists a collection of tags defined within a service instance.",
"operationId": "Tag_ListByService",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the API Management service.",
"in": "path",
"maxLength": 50,
"minLength": 1,
"name": "serviceName",
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>",
"in": "query",
"name": "$filter",
"required": false,
"type": "string"
},
{
"description": "Number of records to return.",
"format": "int32",
"in": "query",
"minimum": 1,
"name": "$top",
"required": false,
"type": "integer",
"x-ms-parameter-location": "method"
},
{
"description": "Number of records to skip.",
"format": "int32",
"in": "query",
"minimum": 0,
"name": "$skip",
"required": false,
"type": "integer",
"x-ms-parameter-location": "method"
},
{
"description": "Scope like 'apis', 'products' or 'apis/{apiId}",
"in": "query",
"name": "scope",
"required": false,
"type": "string"
},
{
"description": "Version of the API to be used with the client request.",
"in": "query",
"name": "api-version",
"required": true,
"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,
"type": "string"
}
],
"responses": {
"200": {
"description": "Lists a collection of Tag entities.",
"schema": {
"description": "Paged Tag 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": "Tag Contract details.",
"properties": {
"properties": {
"description": "Tag contract Properties.",
"properties": {
"displayName": {
"description": "Tag name.",
"maxLength": 160,
"minLength": 1,
"type": "string"
}
},
"required": [
"displayName"
]
}
}
},
"type": "array"
}
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"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": [
"Tag"
],
"x-ms-examples": {
"ApiManagementListTags": {
"parameters": {
"api-version": "2019-12-01-preview",
"resourceGroupName": "rg1",
"serviceName": "apimService1",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"nextLink": "",
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001",
"name": "5600b59375ff190048020001",
"properties": {
"displayName": "tag1"
},
"type": "Microsoft.ApiManagement/service/tags"
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002",
"name": "5600b59375ff190048020002",
"properties": {
"displayName": "tag2"
},
"type": "Microsoft.ApiManagement/service/tags"
}
]
}
}
}
}
},
"x-ms-odata": "./definitions.json#/definitions/TagContract",
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}": {
"delete": {
"description": "Deletes specific tag of the API Management service instance.",
"operationId": "Tag_Delete",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the API Management service.",
"in": "path",
"maxLength": 50,
"minLength": 1,
"name": "serviceName",
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Tag identifier. Must be unique in the current API Management service instance.",
"in": "path",
"maxLength": 80,
"minLength": 1,
"name": "tagId",
"pattern": "^[^*#&+:<>?]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"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,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Version of the API to be used with the client request.",
"in": "query",
"name": "api-version",
"required": true,
"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,
"type": "string"
}
],
"responses": {
"200": {
"description": "Tag successfully removed"
},
"204": {
"description": "Tag successfully removed by previous request or does not exist"
},
"default": {
"description": "Error response describing why the operation failed.",
"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": [
"Tag"
],
"x-ms-examples": {
"ApiManagementDeleteTag": {
"parameters": {
"If-Match": "*",
"api-version": "2019-12-01-preview",
"resourceGroupName": "rg1",
"serviceName": "apimService1",
"subscriptionId": "subid",
"tagId": "tagId1"
},
"responses": {
"200": {},
"204": {}
}
}
}
},
"get": {
"description": "Gets the details of the tag specified by its identifier.",
"operationId": "Tag_Get",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the API Management service.",
"in": "path",
"maxLength": 50,
"minLength": 1,
"name": "serviceName",
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Tag identifier. Must be unique in the current API Management service instance.",
"in": "path",
"maxLength": 80,
"minLength": 1,
"name": "tagId",
"pattern": "^[^*#&+:<>?]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Version of the API to be used with the client request.",
"in": "query",
"name": "api-version",
"required": true,
"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,
"type": "string"
}
],
"responses": {
"200": {
"description": "The response body contains the specified Tag entity.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"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": "Tag Contract details.",
"properties": {
"properties": {
"description": "Tag contract Properties.",
"properties": {
"displayName": {
"description": "Tag name.",
"maxLength": 160,
"minLength": 1,
"type": "string"
}
},
"required": [
"displayName"
]
}
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"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": [
"Tag"
],
"x-ms-examples": {
"ApiManagementGetTag": {
"parameters": {
"api-version": "2019-12-01-preview",
"resourceGroupName": "rg1",
"serviceName": "apimService1",
"subscriptionId": "subid",
"tagId": "59306a29e4bbd510dc24e5f9"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9",
"name": "59306a29e4bbd510dc24e5f9",
"properties": {
"displayName": "tag1"
},
"type": "Microsoft.ApiManagement/service/tags"
}
}
}
}
}
},
"head": {
"description": "Gets the entity state version of the tag specified by its identifier.",
"operationId": "Tag_GetEntityState",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the API Management service.",
"in": "path",
"maxLength": 50,
"minLength": 1,
"name": "serviceName",
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Tag identifier. Must be unique in the current API Management service instance.",
"in": "path",
"maxLength": 80,
"minLength": 1,
"name": "tagId",
"pattern": "^[^*#&+:<>?]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Version of the API to be used with the client request.",
"in": "query",
"name": "api-version",
"required": true,
"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,
"type": "string"
}
],
"responses": {
"200": {
"description": "Empty response body, ETag header entity state version.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"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": [
"Tag"
],
"x-ms-examples": {
"ApiManagementHeadTag": {
"parameters": {
"api-version": "2019-12-01-preview",
"resourceGroupName": "rg1",
"serviceName": "apimService1",
"subscriptionId": "subid",
"tagId": "59306a29e4bbd510dc24e5f9"
},
"responses": {
"200": {
"headers": {
"Etag": "AAAAAAAACCI="
}
}
}
}
}
},
"patch": {
"description": "Updates the details of the tag specified by its identifier.",
"operationId": "Tag_Update",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the API Management service.",
"in": "path",
"maxLength": 50,
"minLength": 1,
"name": "serviceName",
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Tag identifier. Must be unique in the current API Management service instance.",
"in": "path",
"maxLength": 80,
"minLength": 1,
"name": "tagId",
"pattern": "^[^*#&+:<>?]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Update parameters.",
"in": "body",
"name": "parameters",
"required": true,
"schema": {
"description": "Parameters supplied to Create/Update Tag operations.",
"properties": {
"properties": {
"description": "Tag contract Properties.",
"properties": {
"displayName": {
"description": "Tag name.",
"maxLength": 160,
"minLength": 1,
"type": "string"
}
},
"required": [
"displayName"
]
}
}
}
},
{
"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,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Version of the API to be used with the client request.",
"in": "query",
"name": "api-version",
"required": true,
"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,
"type": "string"
}
],
"responses": {
"204": {
"description": "The tag details were successfully updated."
},
"default": {
"description": "Error response describing why the operation failed.",
"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": [
"Tag"
],
"x-ms-examples": {
"ApiManagementUpdateTag": {
"parameters": {
"If-Match": "*",
"api-version": "2019-12-01-preview",
"parameters": {
"properties": {
"displayName": "temp tag"
}
},
"resourceGroupName": "rg1",
"serviceName": "apimService1",
"subscriptionId": "subid",
"tagId": "temptag"
},
"responses": {
"204": {}
}
}
}
},
"put": {
"description": "Creates a tag.",
"operationId": "Tag_CreateOrUpdate",
"parameters": [
{
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the API Management service.",
"in": "path",
"maxLength": 50,
"minLength": 1,
"name": "serviceName",
"pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Tag identifier. Must be unique in the current API Management service instance.",
"in": "path",
"maxLength": 80,
"minLength": 1,
"name": "tagId",
"pattern": "^[^*#&+:<>?]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Create parameters.",
"in": "body",
"name": "parameters",
"required": true,
"schema": {
"description": "Parameters supplied to Create/Update Tag operations.",
"properties": {
"properties": {
"description": "Tag contract Properties.",
"properties": {
"displayName": {
"description": "Tag name.",
"maxLength": 160,
"minLength": 1,
"type": "string"
}
},
"required": [
"displayName"
]
}
}
}
},
{
"description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.",
"in": "header",
"name": "If-Match",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "Version of the API to be used with the client request.",
"in": "query",
"name": "api-version",
"required": true,
"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,
"type": "string"
}
],
"responses": {
"200": {
"description": "Tag already exists.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"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": "Tag Contract details.",
"properties": {
"properties": {
"description": "Tag contract Properties.",
"properties": {
"displayName": {
"description": "Tag name.",
"maxLength": 160,
"minLength": 1,
"type": "string"
}
},
"required": [
"displayName"
]
}
}
}
},
"201": {
"description": "Tag was created successfully.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"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": "Tag Contract details.",
"properties": {
"properties": {
"description": "Tag contract Properties.",
"properties": {
"displayName": {
"description": "Tag name.",
"maxLength": 160,
"minLength": 1,
"type": "string"
}
},
"required": [
"displayName"
]
}
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"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": [
"Tag"
],
"x-ms-examples": {
"ApiManagementCreateTag": {
"parameters": {
"api-version": "2019-12-01-preview",
"parameters": {
"properties": {
"displayName": "tag1"
}
},
"resourceGroupName": "rg1",
"serviceName": "apimService1",
"subscriptionId": "subid",
"tagId": "tagId1"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
"name": "tagId1",
"properties": {
"displayName": "tag1"
},
"type": "Microsoft.ApiManagement/service/tags"
}
},
"201": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
"name": "tagId1",
"properties": {
"displayName": "tag1"
},
"type": "Microsoft.ApiManagement/service/tags"
}
}
}
}
}
}
}
},
"definitions": {}
}