Api Tag Description - Create Or Update

Service:

API Management

API Version:

2022-08-01

Creare/Aggiornare la descrizione del tag nell'ambito dell'API.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiId	path	True	string	Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso in cui n è il numero di revisione. Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName	path	True	string	Nome del servizio Gestione API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
tagDescriptionId	path	True	string	Identificatore di descrizione tag. Usato durante la creazione di tagDescription per l'associazione API/Tag. In base all'API e ai nomi di tag. Regex pattern: ^[^*#&+:<>?]+$
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non richiesto durante la creazione di un'entità, ma necessario quando si aggiorna un'entità.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.description	string	Descrizione del tag.
properties.externalDocsDescription	string	Descrizione delle risorse esterne che descrivono il tag.
properties.externalDocsUrl	string	URL assoluto delle risorse esterne che descrivono il tag.

Risposte

Nome	Tipo	Descrizione
200 OK	TagDescriptionContract	Descrizione tag è stata aggiornata per l'API. Headers ETag: string
201 Created	TagDescriptionContract	Descrizione tag è stata creata per l'API. Headers ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateApiTagDescription

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1?api-version=2022-08-01

{
  "properties": {
    "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    "externalDocsUrl": "http://some.url/additionaldoc",
    "externalDocsDescription": "Description of the external docs resource"
  }
}

Java

/** Samples for ApiTagDescription CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiTagDescription.json
     */
    /**
     * Sample code: ApiManagementCreateApiTagDescription.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateApiTagDescription(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiTagDescriptions()
            .define("tagId1")
            .withExistingApi("rg1", "apimService1", "5931a75ae4bbd512a88c680b")
            .withDescription(
                "Some description that will be displayed for operation's tag if the tag is assigned to operation of the"
                    + " API")
            .withExternalDocsUrl("http://some.url/additionaldoc")
            .withExternalDocsDescription("Description of the external docs resource")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_api_tag_description.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api_tag_description.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="5931a75ae4bbd512a88c680b",
        tag_description_id="tagId1",
        parameters={
            "properties": {
                "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
                "externalDocsDescription": "Description of the external docs resource",
                "externalDocsUrl": "http://some.url/additionaldoc",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiTagDescription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiTagDescription.json
func ExampleAPITagDescriptionClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAPITagDescriptionClient().CreateOrUpdate(ctx, "rg1", "apimService1", "5931a75ae4bbd512a88c680b", "tagId1", armapimanagement.TagDescriptionCreateParameters{
		Properties: &armapimanagement.TagDescriptionBaseProperties{
			Description:             to.Ptr("Some description that will be displayed for operation's tag if the tag is assigned to operation of the API"),
			ExternalDocsDescription: to.Ptr("Description of the external docs resource"),
			ExternalDocsURL:         to.Ptr("http://some.url/additionaldoc"),
		},
	}, &armapimanagement.APITagDescriptionClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.TagDescriptionContract = armapimanagement.TagDescriptionContract{
	// 	Name: to.Ptr("tagId1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis/tagDescriptions"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1"),
	// 	Properties: &armapimanagement.TagDescriptionContractProperties{
	// 		Description: to.Ptr("Some description that will be displayed for operation's tag if the tag is assigned to operation of the API"),
	// 		ExternalDocsDescription: to.Ptr("some additional info"),
	// 		ExternalDocsURL: to.Ptr("http://some_url.com"),
	// 		DisplayName: to.Ptr("tag1"),
	// 		TagID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create/Update tag description in scope of the Api.
 *
 * @summary Create/Update tag description in scope of the Api.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateApiTagDescription.json
 */
async function apiManagementCreateApiTagDescription() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "5931a75ae4bbd512a88c680b";
  const tagDescriptionId = "tagId1";
  const parameters = {
    description:
      "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    externalDocsDescription: "Description of the external docs resource",
    externalDocsUrl: "http://some.url/additionaldoc",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiTagDescription.createOrUpdate(
    resourceGroupName,
    serviceName,
    apiId,
    tagDescriptionId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "name": "tagId1",
  "properties": {
    "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
    "displayName": "tag1",
    "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    "externalDocsDescription": "some additional info",
    "externalDocsUrl": "http://some_url.com"
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "name": "tagId1",
  "properties": {
    "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
    "displayName": "tag1",
    "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    "externalDocsDescription": "some additional info",
    "externalDocsUrl": "http://some_url.com"
  }
}

Definizioni

Nome	Descrizione
ErrorFieldContract	Contratto campo errore.
ErrorResponse	Risposta errore.
TagDescriptionContract	Dettagli del contratto.
TagDescriptionCreateParameters	Parametri forniti all'operazione Create TagDescription.

ErrorFieldContract

Contratto campo errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

TagDescriptionContract

Dettagli del contratto.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.description	string	Descrizione del tag.
properties.displayName	string	Nome tag.
properties.externalDocsDescription	string	Descrizione delle risorse esterne che descrivono il tag.
properties.externalDocsUrl	string	URL assoluto delle risorse esterne che descrivono il tag.
properties.tagId	string	Identificatore del tag sotto forma di /tags/{tagId}
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

TagDescriptionCreateParameters

Parametri forniti all'operazione Create TagDescription.

Nome	Tipo	Descrizione
properties.description	string	Descrizione del tag.
properties.externalDocsDescription	string	Descrizione delle risorse esterne che descrivono il tag.
properties.externalDocsUrl	string	URL assoluto delle risorse esterne che descrivono il tag.