Partilhar via


Tag - Get By Api

Obter etiqueta associada à API.

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

Parâmetros do URI

Name Em Necessário Tipo Description
apiId
path True

string

Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ; rev=n como um sufixo em que n é o número de revisão.

Padrão Regex: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName
path True

string

O nome do serviço Gestão de API.

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

subscriptionId
path True

string

O ID da subscrição de destino.

tagId
path True

string

Identificador de etiqueta. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

Padrão Regex: ^[^*#&+:<>?]+$

api-version
query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

TagContract

Obtém os detalhes da etiqueta especificada pelo respetivo identificador.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ApiManagementGetApiTag

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta do Erro.

TagContract

Detalhes do Contrato de Etiqueta.

ErrorFieldContract

Contrato de Campo de Erro.

Name Tipo Description
code

string

Código de erro de nível de propriedade.

message

string

Representação legível por humanos do erro ao nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta do Erro.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

A lista de campos inválidos enviados no pedido, em caso de erro de validação.

error.message

string

Representação legível por humanos do erro.

TagContract

Detalhes do Contrato de Etiqueta.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.displayName

string

Nome da etiqueta.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"