Disk Accesses - Update

Service:

Compute

API Version:

2023-10-02

ディスク アクセス リソースをUpdates (パッチ) します。

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

URI パラメーター

名前	/	必須	型	説明
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 のバージョン。

要求本文

名前	型	説明
tags	object	リソース タグ

応答

名前	型	説明
200 OK	DiskAccess	OK
202 Accepted	DiskAccess	同意
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

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

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピューティング サービスからのエラー応答。
DiskAccess	ディスク アクセス リソース。
DiskAccessUpdate	ディスク アクセス リソースを更新するために使用されます。
ExtendedLocation	拡張場所の複合型。
ExtendedLocationTypes	拡張された場所の型。
InnerError	内部エラーの詳細。
PrivateEndpoint	プライベート エンドポイント リソース。
PrivateEndpointConnection	プライベート エンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

ApiError

API エラー。

名前	型	説明
code	string	エラー コード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api の内部エラー
message	string	エラー メッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラー コード。
message	string	エラー メッセージ。
target	string	特定のエラーのターゲット。

CloudError

コンピューティング サービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

DiskAccess

ディスク アクセス リソース。

名前	型	説明
extendedLocation	ExtendedLocation	ディスク アクセスが作成される拡張された場所。 拡張された場所は変更できません。
id	string	リソース ID
location	string	リソースの場所
name	string	リソース名
properties.privateEndpointConnections	PrivateEndpointConnection[]	ディスク上に作成されたプライベート エンドポイント接続の読み取り専用コレクション。 現在、サポートされているエンドポイント接続は 1 つだけです。
properties.provisioningState	string	ディスク アクセス リソースのプロビジョニング状態。
properties.timeCreated	string	ディスク アクセスが作成された時刻。
tags	object	リソース タグ
type	string	リソースの種類

DiskAccessUpdate

ディスク アクセス リソースを更新するために使用されます。

名前	型	説明
tags	object	リソース タグ

ExtendedLocation

拡張場所の複合型。

名前	型	説明
name	string	拡張場所の名前。
type	ExtendedLocationTypes	拡張された場所の型。

ExtendedLocationTypes

拡張された場所の型。

名前	型	説明
EdgeZone	string

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラー メッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

PrivateEndpoint

プライベート エンドポイント リソース。

名前	型	説明
id	string	プライベート エンドポイントの ARM 識別子

PrivateEndpointConnection

プライベート エンドポイント接続リソース。

名前	型	説明
id	string	プライベート エンドポイント接続 ID
name	string	プライベート エンドポイント接続名
properties.privateEndpoint	PrivateEndpoint	プライベート エンドポイントのリソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	DiskAccess と Virtual Network間の接続の状態に関する情報のコレクション。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベート エンドポイント接続リソースのプロビジョニング状態。
type	string	プライベート エンドポイント接続の種類

PrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

プライベート エンドポイント接続の状態。

名前	型	説明
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービス プロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。