Dela via


Tag - Get By Api

Hämta tagg som är associerad med API:et.

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

URI-parametrar

Name I Obligatorisk Typ Description
apiId
path True

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Reguljärt uttrycksmönster: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID för målprenumerationen.

tagId
path True

string

Taggidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

Reguljärt uttrycksmönster: ^[^*#&+:<>?]+$

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

TagContract

Hämtar information om taggen som anges av dess identifierare.

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementGetApiTag

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ErrorFieldContract

Fel fältkontrakt.

ErrorResponse

Felsvar.

TagContract

Tagga kontraktsinformation.

ErrorFieldContract

Fel fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.

message

string

Mänsklig läsbar representation av fel på egenskapsnivå.

target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.

error.message

string

Mänsklig läsbar representation av felet.

TagContract

Tagga kontraktsinformation.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.displayName

string

Taggnamn.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"