Sdílet prostřednictvím


Tag - Get By Api

Získejte značku přidruženou k rozhraní API.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
apiId
path True

string

Identifikátor revize rozhraní API. Musí být v aktuální instanci služby API Management jedinečná. Non-current revize má ; rev=n jako přípona, kde n je číslo revize.

Vzor regulárního výrazu: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName
path True

string

Název služby API Management.

Vzor regulárního výrazu: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID cílového předplatného.

tagId
path True

string

Identifikátor značky. Musí být v aktuální instanci služby API Management jedinečná.

Vzor regulárního výrazu: ^[^*#&+:<>?]+$

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

TagContract

Získá podrobnosti značky určené jeho identifikátor.

Hlavičky

ETag: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

ApiManagementGetApiTag

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
ErrorFieldContract

Chyba Kontrakt pole.

ErrorResponse

Odpověď na chybu.

TagContract

Podrobnosti o kontraktu značky.

ErrorFieldContract

Chyba Kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.

message

string

Čitelné znázornění chyby na úrovni vlastností.

target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v žádosti v případě chyby ověření.

error.message

string

Znázornění chyby čitelné pro člověka

TagContract

Podrobnosti o kontraktu značky.

Name Typ Description
id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Název prostředku

properties.displayName

string

Název značky.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts