Disk Accesses - Update

Service:

Compute

API Version:

2023-10-02

Uppdateringar (korrigeringar) en diskåtkomstresurs.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
diskAccessName	path	True	string	Namnet på diskåtkomstresursen som skapas. Namnet kan inte ändras när diskkrypteringsuppsättningen har skapats. Tecken som stöds för namnet är a-z, A-Z, 0-9, _ och -. Den maximala namnlängden är 80 tecken.
resourceGroupName	path	True	string	Namnet på resursgruppen.
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
tags	object	Resurstaggar

Svar

Name	Typ	Description
200 OK	DiskAccess	OK
202 Accepted	DiskAccess	Har godkänts
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Update a disk access resource.

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess?api-version=2023-10-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/2023-10-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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-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");

/**
 * 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/2023-10-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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Compute;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-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

Sample Response

Status code:

202

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

Response Body

{
  "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"
  }
}

Status code:

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"
  }
}

Definitioner

Name	Description
ApiError	API-fel.
ApiErrorBase	Api-felbas.
CloudError	Ett felsvar från Beräkningstjänsten.
DiskAccess	diskåtkomstresurs.
DiskAccessUpdate	Används för att uppdatera en diskåtkomstresurs.
ExtendedLocation	Den komplexa typen av utökad plats.
ExtendedLocationTypes	Typen av utökad plats.
InnerError	Inre felinformation.
PrivateEndpoint	Den privata slutpunktsresursen.
PrivateEndpointConnection	Den privata slutpunktsanslutningsresursen.
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören.

ApiError

API-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

CloudError

Ett felsvar från Beräkningstjänsten.

Name	Typ	Description
error	ApiError	API-fel.

DiskAccess

diskåtkomstresurs.

Name	Typ	Description
extendedLocation	ExtendedLocation	Den utökade platsen där diskåtkomsten skapas. Det går inte att ändra utökad plats.
id	string	Resurs-ID
location	string	Resursplats
name	string	Resursnamn
properties.privateEndpointConnections	PrivateEndpointConnection[]	En skrivskyddad samling privata slutpunktsanslutningar som skapats på disken. För närvarande stöds endast en slutpunktsanslutning.
properties.provisioningState	string	Etableringstillståndet för diskåtkomstresursen.
properties.timeCreated	string	Tiden då diskåtkomsten skapades.
tags	object	Resurstaggar
type	string	Resurstyp

DiskAccessUpdate

Används för att uppdatera en diskåtkomstresurs.

Name	Typ	Description
tags	object	Resurstaggar

ExtendedLocation

Den komplexa typen av utökad plats.

Name	Typ	Description
name	string	Namnet på den utökade platsen.
type	ExtendedLocationTypes	Typen av utökad plats.

ExtendedLocationTypes

Typen av utökad plats.

Name	Typ	Description
EdgeZone	string

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

PrivateEndpoint

Den privata slutpunktsresursen.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

Name	Typ	Description
id	string	privat slutpunktsanslutnings-ID
name	string	namn på privat slutpunktsanslutning
properties.privateEndpoint	PrivateEndpoint	Resursen för den privata slutpunkten.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan DiskAccess och Virtual Network.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillståndet för den privata slutpunktsanslutningsresursen.
type	string	anslutningstyp för privat slutpunkt

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name	Typ	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören.

Name	Typ	Description
actionsRequired	string	Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.
description	string	Anledningen till godkännande/avvisande av anslutningen.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.