Disk Encryption Sets - List

Serviço:

Compute

Versão da API:

2025-01-02

Lista todos os conjuntos de criptografia de disco em uma assinatura.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	DiskEncryptionSetList	O pedido foi bem-sucedido.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

list all disk encryption sets in a subscription.

Pedido de amostra

HTTP

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

Java

/**
 * Samples for DiskEncryptionSets List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2025-01-02/examples/
     * diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json
     */
    /**
     * Sample code: list all disk encryption sets in a subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllDiskEncryptionSetsInASubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDiskEncryptionSets()
            .list(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

Python

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: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2025-01-02/examples/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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7033e85e1f80ef5cd9ca664b538ed193a8fd815b/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2025-01-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json
func ExampleDiskEncryptionSetsClient_NewListPager() {
	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().NewListPager(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/mySecondResourceGroup/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/mySecondResourceGroup/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");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists all the disk encryption sets under a subscription.
 *
 * @summary Lists all the disk encryption sets under a subscription.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2025-01-02/examples/diskEncryptionSetExamples/DiskEncryptionSet_ListBySubscription.json
 */
async function listAllDiskEncryptionSetsInASubscription() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.diskEncryptionSets.list()) {
    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 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/DiskRP/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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
ApiError	Erro de api.
ApiErrorBase	Base de erro da api.
CloudError	Uma resposta de erro do serviço de computação.
createdByType	O tipo de identidade que criou o recurso.
DiskEncryptionSet	recurso do conjunto de criptografia de disco.
DiskEncryptionSetIdentityType	O tipo de identidade gerenciada usada pelo DiskEncryptionSet. Apenas SystemAssigned é suportado para novas criações. Os Conjuntos de Criptografia de Disco podem ser atualizados com o tipo de Identidade Nenhum durante a migração da assinatura para um novo locatário do Azure Ative Directory; Isso fará com que os recursos criptografados percam o acesso às chaves.
DiskEncryptionSetList	A resposta da operação do conjunto de criptografia de disco List.
DiskEncryptionSetType	O tipo de chave usada para criptografar os dados do disco.
EncryptionSetIdentity	A identidade gerenciada para o conjunto de criptografia de disco. Ele deve receber permissão no cofre de chaves antes de poder ser usado para criptografar discos.
InnerError	Detalhes do erro interno.
KeyForDiskEncryptionSet	URL da chave do cofre da chave a ser usada para criptografia do lado do servidor de discos gerenciados e instantâneos
SourceVault	A id do vault é uma id de recurso do Azure Resource Manager no formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentitiesValue

ApiError

Object

Erro de api.

Name	Tipo	Description
code	string	O código de erro.
details	ApiErrorBase[]	Os detalhes do erro Api
innererror	InnerError	O erro interno da Api
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

ApiErrorBase

Object

Base de erro da api.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.
target	string	O alvo do erro específico.

CloudError

Object

Uma resposta de erro do serviço de computação.

Name	Tipo	Description
error	ApiError	Erro de api.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DiskEncryptionSet

Object

recurso do conjunto de criptografia de disco.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	EncryptionSetIdentity	A identidade gerenciada para o conjunto de criptografia de disco. Ele deve receber permissão no cofre de chaves antes de poder ser usado para criptografar discos.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.activeKey	KeyForDiskEncryptionSet	A chave do cofre de chaves que é atualmente usada por este conjunto de criptografia de disco.
properties.autoKeyRotationError	ApiError	O erro encontrado durante a rotação da chave automática. Se houver um erro, a rotação automática da chave não será tentada até que o erro neste conjunto de criptografia de disco seja corrigido.
properties.encryptionType	DiskEncryptionSetType	O tipo de chave usada para criptografar os dados do disco.
properties.federatedClientId	string	ID do cliente de aplicativo multilocatário para acessar o cofre de chaves em um locatário diferente. Definir o valor como 'Nenhum' limpará a propriedade.
properties.lastKeyRotationTimestamp	string (date-time)	A hora em que a chave ativa deste conjunto de encriptação de disco foi atualizada.
properties.previousKeys	KeyForDiskEncryptionSet[]	Uma coleção somente leitura de chaves do cofre de chaves usadas anteriormente por esse conjunto de criptografia de disco enquanto uma rotação de chaves está em andamento. Ficará vazio se não houver rotação de chaves em curso.
properties.provisioningState	string	O estado de provisionamento do conjunto de criptografia de disco.
properties.rotationToLatestKeyVersionEnabled	boolean	Defina esse sinalizador como true para habilitar a atualização automática desse conjunto de criptografia de disco para a versão de chave mais recente.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DiskEncryptionSetIdentityType

Enumeração

O tipo de identidade gerenciada usada pelo DiskEncryptionSet. Apenas SystemAssigned é suportado para novas criações. Os Conjuntos de Criptografia de Disco podem ser atualizados com o tipo de Identidade Nenhum durante a migração da assinatura para um novo locatário do Azure Ative Directory; Isso fará com que os recursos criptografados percam o acesso às chaves.

Valor	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

DiskEncryptionSetList

Object

A resposta da operação do conjunto de criptografia de disco List.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	DiskEncryptionSet[]	Os itens DiskEncryptionSet nesta página

DiskEncryptionSetType

Enumeração

O tipo de chave usada para criptografar os dados do disco.

Valor	Description
EncryptionAtRestWithCustomerKey	O recurso usando diskEncryptionSet seria criptografado em repouso com a chave gerenciada pelo cliente que pode ser alterada e revogada por um cliente.
EncryptionAtRestWithPlatformAndCustomerKeys	O recurso usando diskEncryptionSet seria criptografado em repouso com duas camadas de criptografia. Uma das chaves é gerida pelo Cliente e a outra chave é gerida pela Plataforma.
ConfidentialVmEncryptedWithCustomerKey	O disco confidencial suportado pela VM e o estado do convidado da VM seriam criptografados com a chave gerenciada pelo cliente.

EncryptionSetIdentity

Object

A identidade gerenciada para o conjunto de criptografia de disco. Ele deve receber permissão no cofre de chaves antes de poder ser usado para criptografar discos.

Name	Tipo	Description
principalId	string	A id do objeto do Recurso de Identidade Gerenciada. Isso será enviado para o RP do ARM por meio do cabeçalho x-ms-identity-principal-id na solicitação PUT se o recurso tiver uma identidade systemAssigned(implicit)
tenantId	string	A ID do locatário do Recurso de Identidade Gerenciada. Isso será enviado para o RP do ARM por meio do cabeçalho x-ms-client-tenant-id na solicitação PUT se o recurso tiver uma identidade systemAssigned(implicit)
type	DiskEncryptionSetIdentityType	O tipo de identidade gerenciada usada pelo DiskEncryptionSet. Apenas SystemAssigned é suportado para novas criações. Os Conjuntos de Criptografia de Disco podem ser atualizados com o tipo de Identidade Nenhum durante a migração da assinatura para um novo locatário do Azure Ative Directory; Isso fará com que os recursos criptografados percam o acesso às chaves.
userAssignedIdentities	<string,  UserAssignedIdentitiesValue>	A lista de identidades de usuário associadas ao conjunto de criptografia de disco. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

InnerError

Object

Detalhes do erro interno.

Name	Tipo	Description
errordetail	string	A mensagem de erro interna ou despejo de exceção.
exceptiontype	string	O tipo de exceção.

KeyForDiskEncryptionSet

Object

URL da chave do cofre da chave a ser usada para criptografia do lado do servidor de discos gerenciados e instantâneos

Name	Tipo	Description
keyUrl	string	URL de chave totalmente versionada apontando para uma chave no KeyVault. O segmento de versão da URL é necessário independentemente do valor rotationToLatestKeyVersionEnabled.
sourceVault	SourceVault	ID do recurso do KeyVault que contém a chave ou o segredo. Esta propriedade é opcional e não pode ser usada se a assinatura do KeyVault não for a mesma que a assinatura do Conjunto de Criptografia de Disco.

SourceVault

Object

A id do vault é uma id de recurso do Azure Resource Manager no formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Name	Tipo	Description
id	string	ID do recurso

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentitiesValue

Object

Name	Tipo	Description
clientId	string	O ID do cliente da identidade atribuída ao usuário.
principalId	string	O id principal da identidade atribuída ao usuário.