Disk Accesses - Update

참조

Service:: Compute

API Version:: 2023-10-02

디스크 액세스 리소스를 업데이트(패치)

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
diskAccessName	path	True	string	생성되는 디스크 액세스 리소스의 이름입니다. 디스크 암호화 집합을 만든 후에는 이름을 변경할 수 없습니다. 이름에 지원되는 문자는 a-z, A-Z, 0-9, _ 및 -입니다. 최대 이름 길이는 80자입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전.

요청 본문

Name	형식	Description
tags	object	리소스 태그

응답

Name	형식	Description
200 OK	DiskAccess	정상
202 Accepted	DiskAccess	수락됨
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

Update a disk access resource.

Sample Request

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


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

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

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

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

정의

Name	Description
ApiError	API 오류입니다.
ApiErrorBase	API 오류 기준입니다.
CloudError	Compute 서비스의 오류 응답입니다.
DiskAccess	디스크 액세스 리소스.
DiskAccessUpdate	디스크 액세스 리소스를 업데이트하는 데 사용됩니다.
ExtendedLocation	확장된 위치의 복합 형식입니다.
ExtendedLocationTypes	확장된 위치의 형식입니다.
InnerError	내부 오류 세부 정보입니다.
PrivateEndpoint	프라이빗 엔드포인트 리소스입니다.
PrivateEndpointConnection	프라이빗 엔드포인트 연결 리소스입니다.
PrivateEndpointConnectionProvisioningState	현재 프로비저닝 상태입니다.
PrivateEndpointServiceConnectionStatus	프라이빗 엔드포인트 연결 상태.
PrivateLinkServiceConnectionState	서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.

ApiError

API 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ApiErrorBase[]	API 오류 세부 정보
innererror	InnerError	API 내부 오류
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

ApiErrorBase

API 오류 기준입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

CloudError

Compute 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류입니다.

DiskAccess

디스크 액세스 리소스.

Name	형식	Description
extendedLocation	ExtendedLocation	디스크 액세스를 만들 확장된 위치입니다. 확장된 위치는 변경할 수 없습니다.
id	string	리소스 ID
location	string	리소스 위치
name	string	리소스 이름
properties.privateEndpointConnections	PrivateEndpointConnection[]	디스크에서 만든 프라이빗 엔드포인트 연결의 읽기 전용 컬렉션입니다. 현재 하나의 엔드포인트 연결만 지원됩니다.
properties.provisioningState	string	디스크 액세스 리소스 프로비저닝 상태입니다.
properties.timeCreated	string	디스크 액세스가 만들어진 시간입니다.
tags	object	리소스 태그
type	string	리소스 유형

DiskAccessUpdate

디스크 액세스 리소스를 업데이트하는 데 사용됩니다.

Name	형식	Description
tags	object	리소스 태그

ExtendedLocation

확장된 위치의 복합 형식입니다.

Name	형식	Description
name	string	확장된 위치의 이름입니다.
type	ExtendedLocationTypes	확장된 위치의 형식입니다.

ExtendedLocationTypes

확장된 위치의 형식입니다.

Name	형식	Description
EdgeZone	string

InnerError

내부 오류 세부 정보입니다.

Name	형식	Description
errordetail	string	내부 오류 메시지 또는 예외 덤프입니다.
exceptiontype	string	예외 형식입니다.

PrivateEndpoint

프라이빗 엔드포인트 리소스입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트에 대한 ARM 식별자

PrivateEndpointConnection

프라이빗 엔드포인트 연결 리소스입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트 연결 ID
name	string	프라이빗 엔드포인트 연결 이름
properties.privateEndpoint	PrivateEndpoint	프라이빗 엔드포인트의 리소스입니다.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	DiskAccess와 Virtual Network 간의 연결 상태에 대한 정보 컬렉션입니다.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	프라이빗 엔드포인트 연결 리소스의 프로비저닝 상태입니다.
type	string	프라이빗 엔드포인트 연결 유형

PrivateEndpointConnectionProvisioningState

현재 프로비저닝 상태입니다.

Name	형식	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

프라이빗 엔드포인트 연결 상태.

Name	형식	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.

Name	형식	Description
actionsRequired	string	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
description	string	연결의 승인/거부 이유입니다.
status	PrivateEndpointServiceConnectionStatus	서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.

Disk Accesses - Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

Scopes

예제

Update a disk access resource.

Sample Request

Sample Response

정의

ApiError

ApiErrorBase

CloudError

DiskAccess

DiskAccessUpdate

ExtendedLocation

ExtendedLocationTypes

InnerError

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

추가 리소스