Disk Accesses - Update

Serviço:

Compute

Versão da API:

2024-03-02

Atualiza (patches) um recurso de acesso ao disco.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}?api-version=2024-03-02

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
diskAccessName	path	True	string	O nome do recurso de acesso ao disco que está sendo criado. O nome não pode ser alterado depois que o conjunto de criptografia de disco é criado. Os caracteres com suporte para o nome são a-z, A-Z, 0-9, _ e -. O tamanho máximo do nome é de 80 caracteres.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
tags	object	Etiquetas de recursos

Respostas

Nome	Tipo	Description
200 OK	DiskAccess	OKEY
202 Accepted	DiskAccess	Aceitado
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Update a disk access resource.

Solicitação de exemplo

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess?api-version=2024-03-02

{
  "tags": {
    "department": "Development",
    "project": "PrivateEndpoints"
  }
}

Java

import com.azure.resourcemanager.compute.models.DiskAccessUpdate;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DiskAccesses Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/
     * DiskAccess_Update.json
     */
    /**
     * Sample code: Update a disk access resource.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateADiskAccessResource(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDiskAccesses().update("myResourceGroup", "myDiskAccess",
            new DiskAccessUpdate().withTags(mapOf("department", "Development", "project", "PrivateEndpoints")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python disk_access_update.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 = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.disk_accesses.begin_update(
        resource_group_name="myResourceGroup",
        disk_access_name="myDiskAccess",
        disk_access={"tags": {"department": "Development", "project": "PrivateEndpoints"}},
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Update.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 armcompute_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/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Update.json
func ExampleDiskAccessesClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDiskAccessesClient().BeginUpdate(ctx, "myResourceGroup", "myDiskAccess", armcompute.DiskAccessUpdate{
		Tags: map[string]*string{
			"department": to.Ptr("Development"),
			"project":    to.Ptr("PrivateEndpoints"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.DiskAccess = armcompute.DiskAccess{
	// 	Name: to.Ptr("myDiskAccess"),
	// 	Type: to.Ptr("Microsoft.Compute/diskAccesses"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"department": to.Ptr("Development"),
	// 		"project": to.Ptr("PrivateEndpoints"),
	// 	},
	// }
}

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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates (patches) a disk access resource.
 *
 * @summary Updates (patches) a disk access resource.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Update.json
 */
async function updateADiskAccessResource() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const diskAccessName = "myDiskAccess";
  const diskAccess = {
    tags: { department: "Development", project: "PrivateEndpoints" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.diskAccesses.beginUpdateAndWait(
    resourceGroupName,
    diskAccessName,
    diskAccess,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/diskAccessExamples/DiskAccess_Update.json
// this example is just showing the usage of "DiskAccesses_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DiskAccessResource created on azure
// for more information of creating DiskAccessResource, please refer to the document of DiskAccessResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string diskAccessName = "myDiskAccess";
ResourceIdentifier diskAccessResourceId = DiskAccessResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, diskAccessName);
DiskAccessResource diskAccess = client.GetDiskAccessResource(diskAccessResourceId);

// invoke the operation
DiskAccessPatch patch = new DiskAccessPatch
{
    Tags =
    {
    ["department"] = "Development",
    ["project"] = "PrivateEndpoints"
    },
};
ArmOperation<DiskAccessResource> lro = await diskAccess.UpdateAsync(WaitUntil.Completed, patch);
DiskAccessResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DiskAccessData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:

202

Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess?api-version=2024-03-02

{
  "name": "myDiskAccess",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess",
  "type": "Microsoft.Compute/diskAccesses",
  "location": "West US",
  "tags": {
    "department": "Development",
    "project": "PrivateEndpoints"
  }
}

Código de status:

200

{
  "name": "myDiskAccess",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess",
  "type": "Microsoft.Compute/diskAccesses",
  "location": "West US",
  "tags": {
    "department": "Development",
    "project": "PrivateEndpoints"
  }
}

Definições

Nome	Description
ApiError	Erro de API.
ApiErrorBase	Base de erros de API.
CloudError	Uma resposta de erro do serviço de computação.
DiskAccess	recurso de acesso ao disco.
DiskAccessUpdate	Usado para atualizar um recurso de acesso a disco.
ExtendedLocation	O tipo complexo do local estendido.
ExtendedLocationTypes	O tipo de local estendido.
InnerError	Detalhes do erro interno.
PrivateEndpoint	O recurso de ponto de extremidade privado.
PrivateEndpointConnection	O recurso conexão de ponto de extremidade privado.
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateEndpointServiceConnectionStatus	O status da conexão do ponto de extremidade privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

ApiError

Objeto

Erro de API.

Nome	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro da API
innererror	InnerError	O erro interno da API
message	string	A mensagem de erro.
target	string	O destino do erro específico.

ApiErrorBase

Objeto

Base de erros de API.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

CloudError

Objeto

Uma resposta de erro do serviço de computação.

Nome	Tipo	Description
error	ApiError	Erro de API.

DiskAccess

Objeto

recurso de acesso ao disco.

Nome	Tipo	Description
extendedLocation	ExtendedLocation	O local estendido onde o acesso ao disco será criado. O local estendido não pode ser alterado.
id	string	ID do recurso
location	string	Local do recurso
name	string	Nome do recurso
properties.privateEndpointConnections	PrivateEndpointConnection[]	Uma coleção somente leitura de conexões de ponto de extremidade privado criadas no disco. Atualmente, há suporte para apenas uma conexão de ponto de extremidade.
properties.provisioningState	string	O estado de provisionamento de recursos de acesso ao disco.
properties.timeCreated	string (date-time)	A hora em que o acesso ao disco foi criado.
tags	object	Etiquetas de recursos
type	string	Tipo de recurso

DiskAccessUpdate

Objeto

Usado para atualizar um recurso de acesso a disco.

Nome	Tipo	Description
tags	object	Etiquetas de recursos

ExtendedLocation

Objeto

O tipo complexo do local estendido.

Nome	Tipo	Description
name	string	O nome do local estendido.
type	ExtendedLocationTypes	O tipo de local estendido.

ExtendedLocationTypes

Enumeração

O tipo de local estendido.

Valor	Description
EdgeZone

InnerError

Objeto

Detalhes do erro interno.

Nome	Tipo	Description
errordetail	string	A mensagem de erro interna ou o despejo de exceção.
exceptiontype	string	O tipo de exceção.

PrivateEndpoint

Objeto

O recurso de ponto de extremidade privado.

Nome	Tipo	Description
id	string	O identificador do ARM para o ponto de extremidade privado

PrivateEndpointConnection

Objeto

O recurso conexão de ponto de extremidade privado.

Nome	Tipo	Description
id	string	ID de conexão de ponto de extremidade privado
name	string	nome da conexão do ponto de extremidade privado
properties.privateEndpoint	PrivateEndpoint	O recurso do ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o DiskAccess e a Rede Virtual.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
type	string	tipo de conexão de ponto de extremidade privado

PrivateEndpointConnectionProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeração

O status da conexão do ponto de extremidade privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objeto

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome	Tipo	Description
actionsRequired	string	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da conexão.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.