Udostępnij za pośrednictwem


Tag - Get By Api

Pobierz tag skojarzony z interfejsem 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 identyfikatora URI

Nazwa W Wymagane Typ Opis
apiId
path True

string

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.

Wzorzec wyrażenia regularnego: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName
path True

string

Nazwa usługi API Management.

Wzorzec wyrażenia regularnego: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

tagId
path True

string

Identyfikator tagu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

Wzorzec wyrażenia regularnego: ^[^*#&+:<>?]+$

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

TagContract

Pobiera szczegóły tagu określonego przez jego identyfikator.

Nagłówki

ETag: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementGetApiTag

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.

ErrorResponse

Odpowiedź na błąd.

TagContract

Tagowanie szczegółów kontraktu.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.

message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.

target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.

error.details

ErrorFieldContract[]

Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji.

error.message

string

Czytelna dla człowieka reprezentacja błędu.

TagContract

Tagowanie szczegółów kontraktu.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.displayName

string

Nazwa tagu.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"