你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Disk Encryption Sets - List By Resource Group

Service:

Compute

API Version:

2023-10-02

Lists资源组下的所有磁盘加密集。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	DiskEncryptionSetList	确定
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	模拟用户帐户

示例

List all disk encryption sets in a resource group.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets?api-version=2023-10-02

Java

/**
 * Samples for DiskEncryptionSets ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/examples/
     * diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json
     */
    /**
     * Sample code: List all disk encryption sets in a resource group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllDiskEncryptionSetsInAResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDiskEncryptionSets().listByResourceGroup("myResourceGroup",
            com.azure.core.util.Context.NONE);
    }
}

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/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/e4009d2f8d3bf0271757e522c7d1c1997e193d44/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json
func ExampleDiskEncryptionSetsClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewDiskEncryptionSetsClient().NewListByResourceGroupPager("myResourceGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DiskEncryptionSetList = armcompute.DiskEncryptionSetList{
		// 	Value: []*armcompute.DiskEncryptionSet{
		// 		{
		// 			Name: to.Ptr("myDiskEncryptionSet"),
		// 			Type: to.Ptr("Microsoft.Compute/diskEncryptionSets"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"department": to.Ptr("Development"),
		// 				"project": to.Ptr("Encryption"),
		// 			},
		// 			Identity: &armcompute.EncryptionSetIdentity{
		// 				Type: to.Ptr(armcompute.DiskEncryptionSetIdentityTypeSystemAssigned),
		// 			},
		// 			Properties: &armcompute.EncryptionSetProperties{
		// 				ActiveKey: &armcompute.KeyForDiskEncryptionSet{
		// 					KeyURL: to.Ptr("https://myvmvault.vault-int.azure-int.net/keys/{key}"),
		// 					SourceVault: &armcompute.SourceVault{
		// 						ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault"),
		// 					},
		// 				},
		// 				EncryptionType: to.Ptr(armcompute.DiskEncryptionSetTypeEncryptionAtRestWithCustomerKey),
		// 				PreviousKeys: []*armcompute.KeyForDiskEncryptionSet{
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("myDiskEncryptionSet2"),
		// 			Type: to.Ptr("Microsoft.Compute/diskEncryptionSets"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"department": to.Ptr("Development"),
		// 				"project": to.Ptr("Encryption"),
		// 			},
		// 			Identity: &armcompute.EncryptionSetIdentity{
		// 				Type: to.Ptr(armcompute.DiskEncryptionSetIdentityTypeSystemAssigned),
		// 			},
		// 			Properties: &armcompute.EncryptionSetProperties{
		// 				ActiveKey: &armcompute.KeyForDiskEncryptionSet{
		// 					KeyURL: to.Ptr("https://myvmvault.vault-int.azure-int.net/keys/{key}"),
		// 					SourceVault: &armcompute.SourceVault{
		// 						ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2"),
		// 					},
		// 				},
		// 				EncryptionType: to.Ptr(armcompute.DiskEncryptionSetTypeEncryptionAtRestWithCustomerKey),
		// 				PreviousKeys: []*armcompute.KeyForDiskEncryptionSet{
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists all the disk encryption sets under a resource group.
 *
 * @summary Lists all the disk encryption sets under a resource group.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json
 */
async function listAllDiskEncryptionSetsInAResourceGroup() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.diskEncryptionSets.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2023-10-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListByResourceGroup.json
// this example is just showing the usage of "DiskEncryptionSets_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DiskEncryptionSetResource
DiskEncryptionSetCollection collection = resourceGroupResource.GetDiskEncryptionSets();

// invoke the operation and iterate over the result
await foreach (DiskEncryptionSetResource item in collection.GetAllAsync())
{
    // the variable item 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
    DiskEncryptionSetData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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:

200

{
  "value": [
    {
      "identity": {
        "type": "SystemAssigned"
      },
      "properties": {
        "activeKey": {
          "sourceVault": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault"
          },
          "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}"
        },
        "encryptionType": "EncryptionAtRestWithCustomerKey",
        "previousKeys": [],
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.Compute/diskEncryptionSets",
      "location": "westus",
      "tags": {
        "department": "Development",
        "project": "Encryption"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
      "name": "myDiskEncryptionSet"
    },
    {
      "identity": {
        "type": "SystemAssigned"
      },
      "properties": {
        "activeKey": {
          "sourceVault": {
            "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2"
          },
          "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}"
        },
        "encryptionType": "EncryptionAtRestWithCustomerKey",
        "previousKeys": [],
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.Compute/diskEncryptionSets",
      "location": "westus",
      "tags": {
        "department": "Development",
        "project": "Encryption"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2",
      "name": "myDiskEncryptionSet2"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}"
}

定义

名称	说明
ApiError	Api 错误。
ApiErrorBase	Api 错误基。
CloudError	来自计算服务的错误响应。
DiskEncryptionSet	磁盘加密集资源。
DiskEncryptionSetIdentityType	DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 在将订阅迁移到新的 Azure Active Directory 租户期间，可以使用标识类型“无”更新磁盘加密集;这将导致加密的资源失去对密钥的访问权限。
DiskEncryptionSetList	列出磁盘加密集操作响应。
DiskEncryptionSetType	用于加密磁盘数据的密钥类型。
EncryptionSetIdentity	磁盘加密集的托管标识。 在密钥保管库可用于加密磁盘之前，应向其授予对密钥保管库的权限。
InnerError	内部错误详细信息。
KeyForDiskEncryptionSet	密钥保管库密钥 URL 用于托管磁盘和快照的服务器端加密
SourceVault	保管库 ID 是 Azure 资源管理器资源 ID，格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
UserAssignedIdentities	与虚拟机关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

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 错误。

DiskEncryptionSet

磁盘加密集资源。

名称	类型	说明
id	string	资源 ID
identity	EncryptionSetIdentity	磁盘加密集的托管标识。 在密钥保管库可用于加密磁盘之前，应向其授予对密钥保管库的权限。
location	string	资源位置
name	string	资源名称
properties.activeKey	KeyForDiskEncryptionSet	此磁盘加密集当前使用的密钥保管库密钥。
properties.autoKeyRotationError	ApiError	自动键轮换期间遇到的错误。 如果存在错误，则在修复此磁盘加密集上的错误之前，不会尝试自动密钥轮换。
properties.encryptionType	DiskEncryptionSetType	用于加密磁盘数据的密钥类型。
properties.federatedClientId	string	用于访问不同租户中的密钥保管库的多租户应用程序客户端 ID。 将值设置为“None”将清除 属性。
properties.lastKeyRotationTimestamp	string	更新此磁盘加密集的活动密钥的时间。
properties.previousKeys	KeyForDiskEncryptionSet[]	密钥轮换正在进行时，此磁盘加密集以前使用的密钥保管库密钥的只读集合。 如果没有正在进行的密钥轮换，则它将为空。
properties.provisioningState	string	磁盘加密集预配状态。
properties.rotationToLatestKeyVersionEnabled	boolean	将此标志设置为 true 以启用此磁盘加密集的自动更新到最新密钥版本。
tags	object	资源标记
type	string	资源类型

DiskEncryptionSetIdentityType

DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 在将订阅迁移到新的 Azure Active Directory 租户期间，可以使用标识类型“无”更新磁盘加密集;这将导致加密的资源失去对密钥的访问权限。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

DiskEncryptionSetList

列出磁盘加密集操作响应。

名称	类型	说明
nextLink	string	用于提取磁盘加密集下一页的 URI。 调用 ListNext () 以提取磁盘加密集的下一页。
value	DiskEncryptionSet[]	磁盘加密集的列表。

DiskEncryptionSetType

用于加密磁盘数据的密钥类型。

名称	类型	说明
ConfidentialVmEncryptedWithCustomerKey	string	机密 VM 支持的磁盘和 VM 来宾状态将使用客户管理的密钥进行加密。
EncryptionAtRestWithCustomerKey	string	使用 diskEncryptionSet 的资源将使用客户管理的密钥进行静态加密，客户可以更改和撤销这些密钥。
EncryptionAtRestWithPlatformAndCustomerKeys	string	使用 diskEncryptionSet 的资源将使用两层加密进行静态加密。 其中一个密钥是客户管理的，另一个密钥是平台管理的。

EncryptionSetIdentity

磁盘加密集的托管标识。 在密钥保管库可用于加密磁盘之前，应向其授予对密钥保管库的权限。

名称	类型	说明
principalId	string	托管标识资源的对象 ID。 如果资源具有 systemAssigned (隐式) 标识，则这会通过 PUT 请求中的 x-ms-identity-principal-id 标头从 ARM 发送到 RP
tenantId	string	托管标识资源的租户 ID。 如果资源具有 systemAssigned (隐式) 标识，则会通过 PUT 请求中的 x-ms-client-tenant-id 标头从 ARM 发送到 RP
type	DiskEncryptionSetIdentityType	DiskEncryptionSet 使用的托管标识的类型。 新创建仅支持 SystemAssigned。 在将订阅迁移到新的 Azure Active Directory 租户期间，可以使用标识类型“无”更新磁盘加密集;这将导致加密的资源失去对密钥的访问权限。
userAssignedIdentities	UserAssignedIdentities	与磁盘加密集关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

InnerError

内部错误详细信息。

名称	类型	说明
errordetail	string	内部错误消息或异常转储。
exceptiontype	string	异常类型。

KeyForDiskEncryptionSet

密钥保管库密钥 URL 用于托管磁盘和快照的服务器端加密

名称	类型	说明
keyUrl	string	完全版本的密钥 URL，指向 KeyVault 中的密钥。 无论 rotationToLatestKeyVersionEnabled 值如何，都需要 URL 的版本段。
sourceVault	SourceVault	包含密钥或机密的 KeyVault 的资源 ID。 此属性是可选的，如果 KeyVault 订阅与磁盘加密集订阅不同，则无法使用此属性。

SourceVault

保管库 ID 是 Azure 资源管理器资源 ID，格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

名称	类型	说明
id	string	资源 ID

UserAssignedIdentities

与虚拟机关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称	类型	说明