Tag - Assign To Api

Tjänst:

API Management

API-version:

2024-05-01

Tilldela tagg till API:et.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	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.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
tagId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Taggidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	TagContract	Taggen är redan tilldelad till API:et. Sidhuvuden ETag: string
201 Created	TagContract	Taggen tilldelades api:et. Sidhuvuden ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

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

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementCreateApiTag

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tags/tagId1?api-version=2024-05-01

Exempelsvar

Statuskod:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
  "type": "Microsoft.ApiManagement/service/tags",
  "name": "tagId1",
  "properties": {
    "displayName": "tag1"
  }
}

Statuskod:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
  "type": "Microsoft.ApiManagement/service/tags",
  "name": "tagId1",
  "properties": {
    "displayName": "tag1"
  }
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
TagContract	Tagga kontraktsinformation.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

TagContract

Objekt

Tagga kontraktsinformation.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.displayName	string minLength: 1 maxLength: 160	Taggnamn.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"