Disk Encryption Sets - List

서비스:: Compute

API 버전:: 2025-01-02

구독에 있는 모든 디스크 암호화 집합을 나열합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?api-version=2025-01-02

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	DiskEncryptionSetList	요청이 성공했습니다.
Other Status Codes	CloudError	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

list all disk encryption sets in a subscription.

샘플 요청

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/diskEncryptionSets?api-version=2025-01-02

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python disk_encryption_set_list_by_subscription.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_encryption_sets.list()
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-02/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.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

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

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/Compute/stable/2025-01-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json
// this example is just showing the usage of "DiskEncryptionSets_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (DiskEncryptionSetResource item in subscriptionResource.GetDiskEncryptionSetsAsync())
{
    // 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

샘플 응답

상태 코드:: 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/mySecondResourceGroup/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/mySecondResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2",
      "name": "myDiskEncryptionSet2"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken=token"
}

정의

Name	Description
ApiError	API 오류.
ApiErrorBase	API 오류 기반.
CloudError	컴퓨팅 서비스의 오류 응답입니다.
Common.UserAssignedIdentitiesValue
createdByType	리소스를 만든 ID의 형식입니다.
DiskEncryptionSet	디스크 암호화 집합 리소스입니다.
DiskEncryptionSetIdentityType	DiskEncryptionSet에서 사용하는 관리 ID의 형식입니다. 새 생성에는 SystemAssigned만 지원됩니다. 디스크 암호화 집합은 새 Azure Active Directory 테넌트에 구독을 마이그레이션하는 동안 ID 유형 없음으로 업데이트할 수 있습니다. 그러면 암호화된 리소스가 키에 대한 액세스 권한을 잃게 됩니다.
DiskEncryptionSetList	디스크 암호화 집합 작업 응답 나열
DiskEncryptionSetType	디스크의 데이터를 암호화하는 데 사용되는 키 유형입니다.
EncryptionSetIdentity	디스크 암호화 집합의 관리 ID입니다. 디스크를 암호화하는 데 사용하려면 키 자격 증명 모음에 대한 권한이 부여되어야 합니다.
InnerError	내부 오류 세부 정보입니다.
KeyForDiskEncryptionSet	Managed Disks 및 스냅샷의 서버 쪽 암호화에 사용할 Key Vault 키 URL
SourceVault	자격 증명 모음 ID는 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} 형식의 Azure Resource Manager 리소스 ID입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

ApiError

Object

API 오류.

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

ApiErrorBase

Object

API 오류 기반.

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

CloudError

Object

컴퓨팅 서비스의 오류 응답입니다.

Name	형식	Description
error	ApiError	API 오류.

Common.UserAssignedIdentitiesValue

Object

Name	형식	Description
clientId	string	사용자 할당 ID의 클라이언트 ID입니다.
principalId	string	사용자 할당 ID의 보안 주체 ID입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

DiskEncryptionSet

Object

디스크 암호화 집합 리소스입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	EncryptionSetIdentity	디스크 암호화 집합의 관리 ID입니다. 디스크를 암호화하는 데 사용하려면 키 자격 증명 모음에 대한 권한이 부여되어야 합니다.
location	string	리소스가 있는 지리적 위치
name	string	리소스의 이름
properties.activeKey	KeyForDiskEncryptionSet	이 디스크 암호화 집합에서 현재 사용되는 키 자격 증명 모음 키입니다.
properties.autoKeyRotationError	ApiError	자동 키 회전 중에 발생한 오류입니다. 오류가 있는 경우 이 디스크 암호화 집합의 오류가 수정될 때까지 자동 키 순환을 시도하지 않습니다.
properties.encryptionType	DiskEncryptionSetType	디스크의 데이터를 암호화하는 데 사용되는 키 유형입니다.
properties.federatedClientId	string	다른 테넌트에서 키 자격 증명 모음에 액세스하기 위한 다중 테넌트 애플리케이션 클라이언트 ID입니다. 값을 'None'으로 설정하면 속성이 지워지게 됩니다.
properties.lastKeyRotationTimestamp	string (date-time)	이 디스크 암호화 세트의 활성 키가 업데이트된 시간입니다.
properties.previousKeys	KeyForDiskEncryptionSet[]	키 회전이 진행되는 동안 이 디스크 암호화 집합에서 이전에 사용한 키 자격 증명 모음 키의 읽기 전용 컬렉션입니다. 진행 중인 키 교체가 없으면 비어 있습니다.
properties.provisioningState	string	디스크 암호화 세트 프로비저닝 상태입니다.
properties.rotationToLatestKeyVersionEnabled	boolean	이 디스크 암호화 집합을 최신 키 버전으로 자동 업데이트하려면 이 플래그를 true로 설정합니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
tags	object	리소스 태그.
type	string	리소스의 형식입니다. 예를 들어, "Microsoft. 컴퓨트/가상 머신" 또는 "Microsoft." 저장소/저장소 계정"

DiskEncryptionSetIdentityType

열거형

DiskEncryptionSet에서 사용하는 관리 ID의 형식입니다. 새 생성에는 SystemAssigned만 지원됩니다. 디스크 암호화 집합은 새 Azure Active Directory 테넌트에 구독을 마이그레이션하는 동안 ID 유형 없음으로 업데이트할 수 있습니다. 그러면 암호화된 리소스가 키에 대한 액세스 권한을 잃게 됩니다.

값	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

DiskEncryptionSetList

Object

디스크 암호화 집합 작업 응답 나열

Name	형식	Description
nextLink	string (uri)	항목의 다음 페이지에 대한 링크
value	DiskEncryptionSet[]	이 페이지의 DiskEncryptionSet 항목

DiskEncryptionSetType

열거형

디스크의 데이터를 암호화하는 데 사용되는 키 유형입니다.

값	Description
EncryptionAtRestWithCustomerKey	diskEncryptionSet을 사용하는 리소스는 고객이 변경 및 해지할 수 있는 고객 관리형 키를 사용하여 미사용 시 암호화됩니다.
EncryptionAtRestWithPlatformAndCustomerKeys	diskEncryptionSet을 사용하는 리소스는 두 계층의 암호화를 사용하여 미사용 시 암호화됩니다. 키 중 하나는 고객 관리이고 다른 키는 플랫폼 관리입니다.
ConfidentialVmEncryptedWithCustomerKey	기밀 VM 지원 디스크 및 VM 게스트 상태는 고객 관리형 키로 암호화됩니다.

EncryptionSetIdentity

Object

디스크 암호화 집합의 관리 ID입니다. 디스크를 암호화하는 데 사용하려면 키 자격 증명 모음에 대한 권한이 부여되어야 합니다.

Name	형식	Description
principalId	string	관리 ID 리소스의 개체 ID입니다. 리소스에 systemAssigned(암시적) ID가 있는 경우 PUT 요청의 x-ms-identity-principal-id 헤더를 통해 ARM에서 RP로 전송됩니다
tenantId	string	관리 ID 리소스의 테넌트 ID입니다. 리소스에 systemAssigned(암시적) ID가 있는 경우 PUT 요청의 x-ms-client-tenant-id 헤더를 통해 ARM에서 RP로 전송됩니다
type	DiskEncryptionSetIdentityType	DiskEncryptionSet에서 사용하는 관리 ID의 형식입니다. 새 생성에는 SystemAssigned만 지원됩니다. 디스크 암호화 집합은 새 Azure Active Directory 테넌트에 구독을 마이그레이션하는 동안 ID 유형 없음으로 업데이트할 수 있습니다. 그러면 암호화된 리소스가 키에 대한 액세스 권한을 잃게 됩니다.
userAssignedIdentities	<string, Common.UserAssignedIdentitiesValue>	디스크 암호화 집합과 연결된 사용자 ID 목록입니다. 사용자 신원 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft 형태의 ARM 리소스 ID입니다. ManagedIdentity/userAssignedIdentities/{identityName}'.

InnerError

Object

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

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

KeyForDiskEncryptionSet

Object

Managed Disks 및 스냅샷의 서버 쪽 암호화에 사용할 Key Vault 키 URL

Name	형식	Description
keyUrl	string	KeyVault의 키를 가리키는 완전히 버전이 지정된 키 URL입니다. URL의 버전 세그먼트는 rotationToLatestKeyVersionEnabled 값에 관계없이 필요합니다.
sourceVault	SourceVault	키 또는 비밀을 포함하는 KeyVault의 리소스 ID입니다. 이 속성은 선택 사항이며 KeyVault 구독이 디스크 암호화 집합 구독과 동일하지 않은 경우 사용할 수 없습니다.

SourceVault

Object

자격 증명 모음 ID는 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} 형식의 Azure Resource Manager 리소스 ID입니다.

Name	형식	Description
id	string	리소스 ID

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.