Tags - Create Or Update At Scope

Referência

Service:: Resource Management

API Version:: 2021-04-01

Cria ou atualiza todo o conjunto de tags num recurso ou subscrição.
Esta operação permite adicionar ou substituir todo o conjunto de tags no recurso ou subscrição especificados. A entidade especificada pode ter um máximo de 50 tags.

PUT https://management.azure.com/{scope}/providers/Microsoft.Resources/tags/default?api-version=2021-04-01

Parâmetros do URI

Name	In	Required	Type	Description
scope	path	True	string	O âmbito de recursos.
api-version	query	True	string	A versão API a ser utilizada para esta operação.

Corpo do Pedido

Name	Required	Type	Description
properties	True	Tags	O conjunto de etiquetas.

Respostas

Name	Type	Description
200 OK	TagsResource	Tags atualizadas com sucesso. Retorna as etiquetas do objeto especificado.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Update tags on a resource

Update tags on a subscription

Update tags on a resource

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm/providers/Microsoft.Resources/tags/default?api-version=2021-04-01

{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

package armresources_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/resources/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutTagsResource.json
func ExampleTagsClient_CreateOrUpdateAtScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armresources.NewTagsClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CreateOrUpdateAtScope(ctx,
		"subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
		armresources.TagsResource{
			Properties: &armresources.Tags{
				Tags: map[string]*string{
					"tagKey1": to.Ptr("tag-value-1"),
					"tagKey2": to.Ptr("tag-value-2"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

/**
 * This sample demonstrates how to This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
 *
 * @summary This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutTagsResource.json
 */
async function updateTagsOnAResource() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const scope =
    "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm";
  const parameters = {
    properties: { tags: { tagKey1: "tag-value-1", tagKey2: "tag-value-2" } },
  };
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.tagsOperations.createOrUpdateAtScope(scope, parameters);
  console.log(result);
}

updateTagsOnAResource().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

Update tags on a subscription

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources/tags/default?api-version=2021-04-01

{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

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

/**
 * This sample demonstrates how to This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
 *
 * @summary This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutTagsSubscription.json
 */
async function updateTagsOnASubscription() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/00000000-0000-0000-0000-000000000000";
  const parameters = {
    properties: { tags: { tagKey1: "tag-value-1", tagKey2: "tag-value-2" } },
  };
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.tagsOperations.createOrUpdateAtScope(scope, parameters);
  console.log(result);
}

updateTagsOnASubscription().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

Definições

CloudError	Uma resposta de erro para um pedido de gestão de recursos.
ErrorAdditionalInfo	O erro de gestão de recursos informações adicionais.
ErrorResponse	Resposta a Erros
Tags	Um dicionário de nome e pares de valor.
TagsResource	Recurso de invólucro para etiquetas pedidos e respostas da API.

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

Name	Type	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todos os Azure Resource Manager APIs para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name	Type	Description
info	object	A informação adicional.
type	string	O tipo de informação adicional.

ErrorResponse

Resposta a Erros

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	A informação adicional do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

Name	Type	Description
tags	object

TagsResource

Recurso de invólucro para etiquetas pedidos e respostas da API.

Name	Type	Description
id	string	A identificação do recurso de invólucro de etiquetas.
name	string	O nome do recurso de invólucro de etiquetas.
properties	Tags	O conjunto de etiquetas.
type	string	O tipo de recurso de invólucro de etiquetas.