Disk Encryption Sets - List

Servizio:

Compute

Versione API:

2025-01-02

Elenca tutti i set di crittografia del disco inclusi in una sottoscrizione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	DiskEncryptionSetList	La richiesta è andata a buon fine.
Other Status Codes	CloudError	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

list all disk encryption sets in a subscription.

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
ApiError	Errore API.
ApiErrorBase	Base di errore API.
CloudError	Risposta di errore dal servizio di calcolo.
createdByType	Tipo di identità che ha creato la risorsa.
DiskEncryptionSet	Risorsa set di crittografia del disco.
DiskEncryptionSetIdentityType	Tipo di identità gestita usata da DiskEncryptionSet. Per le nuove creazioni è supportato solo SystemAssigned. I set di crittografia dischi possono essere aggiornati con tipo di identità Nessuno durante la migrazione della sottoscrizione a un nuovo tenant di Azure Active Directory; causerà la perdita dell'accesso alle chiavi da parte delle risorse crittografate.
DiskEncryptionSetList	La risposta dell'operazione Elenca set di crittografia disco.
DiskEncryptionSetType	Tipo di chiave utilizzata per crittografare i dati del disco.
EncryptionSetIdentity	Identità gestita per il set di crittografia del disco. Deve essere concessa l'autorizzazione per l'insieme di credenziali delle chiavi prima che possa essere usata per crittografare i dischi.
InnerError	Dettagli dell'errore interno.
KeyForDiskEncryptionSet	URL della chiave di Key Vault da usare per la crittografia lato server di Managed Disks and Snapshots
SourceVault	L'ID dell'insieme di credenziali è un ID risorsa di Azure Resource Manager nel formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserAssignedIdentitiesValue

ApiError

Oggetto

Errore API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore Api
innererror	InnerError	L'errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Oggetto

Base di errore API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

CloudError

Oggetto

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore API.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DiskEncryptionSet

Oggetto

Risorsa set di crittografia del disco.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	EncryptionSetIdentity	Identità gestita per il set di crittografia del disco. Deve essere concessa l'autorizzazione per l'insieme di credenziali delle chiavi prima che possa essere usata per crittografare i dischi.
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.activeKey	KeyForDiskEncryptionSet	Chiave dell'insieme di credenziali delle chiavi attualmente usata da questo set di crittografia del disco.
properties.autoKeyRotationError	ApiError	L'errore che si è verificato durante la rotazione automatica dei tasti. Se è presente un errore, la rotazione automatica della chiave non verrà tentata fino a quando l'errore in questo set di crittografia del disco non sarà corretto.
properties.encryptionType	DiskEncryptionSetType	Tipo di chiave utilizzata per crittografare i dati del disco.
properties.federatedClientId	string	ID client dell'applicazione multi-tenant per accedere all'insieme di credenziali delle chiavi in un tenant diverso. Se si imposta il valore su "Nessuno", la proprietà verrà cancellata.
properties.lastKeyRotationTimestamp	string (date-time)	Ora in cui la chiave attiva di questo set di crittografia del disco è stata aggiornata.
properties.previousKeys	KeyForDiskEncryptionSet[]	Una raccolta di sola lettura delle chiavi dell'insieme di credenziali delle chiavi usate in precedenza da questo set di crittografia del disco mentre è in corso una rotazione delle chiavi. Sarà vuoto se non c'è una rotazione dei tasti in corso.
properties.provisioningState	string	Stato di provisioning del set di crittografia del disco.
properties.rotationToLatestKeyVersionEnabled	boolean	Impostare questo flag su true per abilitare l'aggiornamento automatico di questa crittografia del disco impostata sulla versione più recente della chiave.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

DiskEncryptionSetIdentityType

Enumerazione

Tipo di identità gestita usata da DiskEncryptionSet. Per le nuove creazioni è supportato solo SystemAssigned. I set di crittografia dischi possono essere aggiornati con tipo di identità Nessuno durante la migrazione della sottoscrizione a un nuovo tenant di Azure Active Directory; causerà la perdita dell'accesso alle chiavi da parte delle risorse crittografate.

Valore	Descrizione
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

DiskEncryptionSetList

Oggetto

La risposta dell'operazione Elenca set di crittografia disco.

Nome	Tipo	Descrizione
nextLink	string (uri)	Collegamento alla pagina successiva di elementi
value	DiskEncryptionSet[]	Elementi DiskEncryptionSet in questa pagina

DiskEncryptionSetType

Enumerazione

Tipo di chiave utilizzata per crittografare i dati del disco.

Valore	Descrizione
EncryptionAtRestWithCustomerKey	La risorsa che utilizza diskEncryptionSet verrebbe crittografata inattiva con la chiave gestita dal cliente che può essere modificata e revocata da un cliente.
EncryptionAtRestWithPlatformAndCustomerKeys	La risorsa che utilizza diskEncryptionSet verrebbe crittografata a riposo con due livelli di crittografia. Una delle chiavi è gestita dal cliente e l'altra chiave è la gestione della piattaforma.
ConfidentialVmEncryptedWithCustomerKey	Il disco riservato supportato dalla macchina virtuale e lo stato guest della macchina virtuale verranno crittografati con la chiave gestita dal cliente.

EncryptionSetIdentity

Oggetto

Identità gestita per il set di crittografia del disco. Deve essere concessa l'autorizzazione per l'insieme di credenziali delle chiavi prima che possa essere usata per crittografare i dischi.

Nome	Tipo	Descrizione
principalId	string	ID oggetto della risorsa di identità gestita. Questo verrà inviato al componente da ARM tramite l'intestazione x-ms-identity-principal-id nella richiesta PUT se la risorsa ha un'identità systemAssigned(implicit)
tenantId	string	ID tenant della risorsa di identità gestita. Questo verrà inviato all'RP da ARM tramite l'intestazione x-ms-client-tenant-id nella richiesta PUT se la risorsa ha un'identità systemAssigned(implicit)
type	DiskEncryptionSetIdentityType	Tipo di identità gestita usata da DiskEncryptionSet. Per le nuove creazioni è supportato solo SystemAssigned. I set di crittografia dischi possono essere aggiornati con tipo di identità Nessuno durante la migrazione della sottoscrizione a un nuovo tenant di Azure Active Directory; causerà la perdita dell'accesso alle chiavi da parte delle risorse crittografate.
userAssignedIdentities	<string,  UserAssignedIdentitiesValue>	Elenco di identità utente associate al set di crittografia del disco. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

InnerError

Oggetto

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump di eccezione.
exceptiontype	string	Tipo di eccezione.

KeyForDiskEncryptionSet

Oggetto

URL della chiave di Key Vault da usare per la crittografia lato server di Managed Disks and Snapshots

Nome	Tipo	Descrizione
keyUrl	string	URL chiave con versione completa che punta a una chiave in KeyVault. Il segmento di versione dell'URL è obbligatorio indipendentemente dal valore rotationToLatestKeyVersionEnabled.
sourceVault	SourceVault	ID risorsa dell'insieme di credenziali delle chiavi contenente la chiave o il segreto. Questa proprietà è facoltativa e non può essere usata se la sottoscrizione di KeyVault non corrisponde alla sottoscrizione del set di crittografia dischi.

SourceVault

Oggetto

L'ID dell'insieme di credenziali è un ID risorsa di Azure Resource Manager nel formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Nome	Tipo	Descrizione
id	string	ID risorsa

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UserAssignedIdentitiesValue

Oggetto

Nome	Tipo	Descrizione
clientId	string	ID client dell'identità assegnata dall'utente.
principalId	string	ID principale dell'identità assegnata dall'utente.