Поделиться через


Tag - Get By Api

Получение тега, связанного с API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}?api-version=2022-08-01

Параметры URI

Имя В Обязательно Тип Описание
apiId
path True

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Текущая редакция имеет ; rev=n в виде суффикса, где n — номер редакции.

Шаблон регулярного выражения: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName
path True

string

Имя службы Управление API.

Шаблон регулярного выражения: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Идентификатор целевой подписки.

tagId
path True

string

Идентификатор тега. Должен быть уникальным в текущем экземпляре службы Управление API.

Шаблон регулярного выражения: ^[^*#&+:<>?]+$

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

TagContract

Возвращает сведения о теге, заданном его идентификатором.

Заголовки

ETag: string

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementGetApiTag

Образец запроса

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tags/59306a29e4bbd510dc24e5f9?api-version=2022-08-01

Пример ответа

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9",
  "type": "Microsoft.ApiManagement/service/tags",
  "name": "59306a29e4bbd510dc24e5f9",
  "properties": {
    "displayName": "tag1"
  }
}

Определения

Имя Описание
ErrorFieldContract

Контракт поля ошибки.

ErrorResponse

Ответ на ошибку.

TagContract

Пометка сведений о контракте.

ErrorFieldContract

Контракт поля ошибки.

Имя Тип Описание
code

string

Код ошибки уровня свойства.

message

string

Понятное представление ошибки на уровне свойств.

target

string

Имя свойства.

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
error.code

string

Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.

error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.

error.message

string

Читаемое представление ошибки.

TagContract

Пометка сведений о контракте.

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties.displayName

string

Имя тега.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"