Compartir a través de


Tag - Get By Api

Obtenga la etiqueta asociada a la 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 de identificador URI

Nombre En Requerido Tipo Description
apiId
path True

string

Identificador de revisión de API. Debe ser único en la instancia de servicio API Management actual. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Patrón de Regex: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName
path True

string

Nombre del servicio API Management.

Patrón de Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Identificador de la suscripción de destino.

tagId
path True

string

Identificador de etiqueta. Debe ser único en la instancia de servicio API Management actual.

Patrón de Regex: ^[^*#&+:<>?]+$

api-version
query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

TagContract

Obtiene los detalles de la etiqueta especificada por su identificador.

Encabezados

ETag: string

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

ApiManagementGetApiTag

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

TagContract

Etiquetar detalles del contrato.

ErrorFieldContract

Contrato de campo de error.

Nombre Tipo Description
code

string

Código de error de nivel de propiedad.

message

string

Representación legible del error de nivel de propiedad.

target

string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre Tipo Description
error.code

string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

ErrorFieldContract[]

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message

string

Representación legible del error.

TagContract

Etiquetar detalles del contrato.

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nombre del recurso.

properties.displayName

string

Nombre de etiqueta.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"