Disk Encryption Sets - Get

Obtient des informations sur un ensemble de chiffrement de disque.

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

Paramètres URI

Nom Dans Obligatoire Type Description
diskEncryptionSetName
path True

string

Nom du jeu de chiffrement de disque en cours de création. Le nom ne peut pas être modifié une fois le jeu de chiffrement de disque créé. Les caractères pris en charge pour le nom sont a-z, A-Z, 0-9, _ et -. La longueur maximale du nom est limitée à 80 caractères.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

minLength: 1

ID de l’abonnement cible.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

DiskEncryptionSet

Opération Azure terminée avec succès.

Other Status Codes

CloudError

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

get information about a disk encryption set when auto-key rotation failed.
get information about a disk encryption set.

get information about a disk encryption set when auto-key rotation failed.

Exemple de requête

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

Exemple de réponse

{
  "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": [],
    "rotationToLatestKeyVersionEnabled": true,
    "provisioningState": "Succeeded",
    "autoKeyRotationError": {
      "code": "ManagedServiceIdentityNotFound",
      "message": "Auto-key rotation was disabled as managed service identity associated with DiskEncryptionSet 'myDiskEncryptionSet' was not found. Please update the resource with correct identity to re-enable auto-key rotation."
    }
  },
  "type": "Microsoft.Compute/diskEncryptionSets",
  "location": "westus",
  "tags": {
    "department": "Development",
    "project": "Encryption"
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
  "name": "myDiskEncryptionSet"
}

get information about a disk encryption set.

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ApiError

Erreur d’API.

ApiErrorBase

Base d’erreur de l’API.

CloudError

Réponse d’erreur du service de calcul.

Common.UserAssignedIdentitiesValue
createdByType

Type d’identité qui a créé la ressource.

DiskEncryptionSet

ressource de jeu de chiffrement de disque.

DiskEncryptionSetIdentityType

Type d’identité managée utilisée par DiskEncryptionSet. Seul SystemAssigned est pris en charge pour les nouvelles créations. Les jeux de chiffrement de disque peuvent être mis à jour avec le type d’identité None lors de la migration de l’abonnement vers un nouveau locataire Azure Active Directory ; les ressources chiffrées perdent l’accès aux clés.

DiskEncryptionSetType

Type de clé utilisé pour chiffrer les données du disque.

EncryptionSetIdentity

Identité managée pour le jeu de chiffrement de disque. Elle doit être autorisée sur le coffre de clés avant de pouvoir être utilisée pour chiffrer les disques.

InnerError

Détails de l’erreur interne.

KeyForDiskEncryptionSet

URL de clé Key Vault à utiliser pour le chiffrement côté serveur des disques managés et des instantanés

SourceVault

L’ID de coffre est un ID de ressource Azure Resource Manager sous la forme /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

ApiError

Erreur d’API.

Nom Type Description
code

string

Code d’erreur.

details

ApiErrorBase[]

Les détails de l’erreur Api

innererror

InnerError

L’erreur interne de l’API

message

string

Message d’erreur.

target

string

Cible de l’erreur particulière.

ApiErrorBase

Base d’erreur de l’API.

Nom Type Description
code

string

Code d’erreur.

message

string

Message d’erreur.

target

string

Cible de l’erreur particulière.

CloudError

Réponse d’erreur du service de calcul.

Nom Type Description
error

ApiError

Erreur d’API.

Common.UserAssignedIdentitiesValue

Nom Type Description
clientId

string

ID client de l’identité affectée par l’utilisateur.

principalId

string

ID principal de l’identité affectée par l’utilisateur.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
User
Application
ManagedIdentity
Key

DiskEncryptionSet

ressource de jeu de chiffrement de disque.

Nom Type Description
id

string

ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

EncryptionSetIdentity

Identité managée pour le jeu de chiffrement de disque. Elle doit être autorisée sur le coffre de clés avant de pouvoir être utilisée pour chiffrer les disques.

location

string

Emplacement géographique où réside la ressource

name

string

Nom de la ressource

properties.activeKey

KeyForDiskEncryptionSet

Clé de coffre de clés actuellement utilisée par ce jeu de chiffrement de disque.

properties.autoKeyRotationError

ApiError

Erreur rencontrée lors de la rotation automatique de la touche. Si une erreur est présente, la rotation automatique de la clé n’est pas tentée tant que l’erreur sur ce jeu de chiffrement de disque n’est pas corrigée.

properties.encryptionType

DiskEncryptionSetType

Type de clé utilisé pour chiffrer les données du disque.

properties.federatedClientId

string

ID client d’application mutualisée pour accéder au coffre de clés dans un autre locataire. La définition de la valeur « None » efface la propriété.

properties.lastKeyRotationTimestamp

string (date-time)

Heure à laquelle la clé active de ce jeu de chiffrement de disque a été mise à jour.

properties.previousKeys

KeyForDiskEncryptionSet[]

Collection en lecture seule des clés du coffre de clés précédemment utilisées par ce jeu de chiffrement de disque pendant qu’une rotation de clés est en cours. Il sera vide s’il n’y a pas de rotation de clé en cours.

properties.provisioningState

string

État de provisionnement du chiffrement de disque.

properties.rotationToLatestKeyVersionEnabled

boolean

Définissez cet indicateur sur true pour activer la mise à jour automatique de ce chiffrement de disque défini sur la dernière version de clé.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

DiskEncryptionSetIdentityType

Type d’identité managée utilisée par DiskEncryptionSet. Seul SystemAssigned est pris en charge pour les nouvelles créations. Les jeux de chiffrement de disque peuvent être mis à jour avec le type d’identité None lors de la migration de l’abonnement vers un nouveau locataire Azure Active Directory ; les ressources chiffrées perdent l’accès aux clés.

Valeur Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

DiskEncryptionSetType

Type de clé utilisé pour chiffrer les données du disque.

Valeur Description
EncryptionAtRestWithCustomerKey

La ressource utilisant diskEncryptionSet est chiffrée au repos avec une clé gérée par le client qui peut être modifiée et révoquée par un client.

EncryptionAtRestWithPlatformAndCustomerKeys

La ressource utilisant diskEncryptionSet est chiffrée au repos à l’aide de deux couches de chiffrement. L’une des clés est gérée par le client et l’autre clé est gérée par la plateforme.

ConfidentialVmEncryptedWithCustomerKey

Le disque confidentiel pris en charge par la machine virtuelle et l’état de l’invité de la machine virtuelle sont chiffrés avec la clé gérée par le client.

EncryptionSetIdentity

Identité managée pour le jeu de chiffrement de disque. Elle doit être autorisée sur le coffre de clés avant de pouvoir être utilisée pour chiffrer les disques.

Nom Type Description
principalId

string

ID d’objet de la ressource d’identité managée. Celui-ci sera envoyé au RP à partir d’ARM via l’en-tête x-ms-identity-principal-id dans la demande PUT si la ressource a une identité systemAssigned(implicite)

tenantId

string

ID de locataire de la ressource d’identité managée. Celui-ci sera envoyé au RP à partir d’ARM via l’en-tête x-ms-client-tenant-id dans la demande PUT si la ressource a une identité systemAssigned(implicite)

type

DiskEncryptionSetIdentityType

Type d’identité managée utilisée par DiskEncryptionSet. Seul SystemAssigned est pris en charge pour les nouvelles créations. Les jeux de chiffrement de disque peuvent être mis à jour avec le type d’identité None lors de la migration de l’abonnement vers un nouveau locataire Azure Active Directory ; les ressources chiffrées perdent l’accès aux clés.

userAssignedIdentities

<string,  Common.UserAssignedIdentitiesValue>

Liste des identités utilisateur associées au jeu de chiffrement de disque. Les références clés du dictionnaire d'identité utilisateur seront des identifiants de ressources ARM sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}'.

InnerError

Détails de l’erreur interne.

Nom Type Description
errordetail

string

Message d’erreur interne ou vidage d’exception.

exceptiontype

string

Type d'exception.

KeyForDiskEncryptionSet

URL de clé Key Vault à utiliser pour le chiffrement côté serveur des disques managés et des instantanés

Nom Type Description
keyUrl

string

URL de clé entièrement versionnée pointant vers une clé dans KeyVault. Le segment de version de l’URL est requis, quelle que soit la valeur rotationToLatestKeyVersionEnabled.

sourceVault

SourceVault

ID de ressource du coffre de clés contenant la clé ou le secret. Cette propriété est facultative et ne peut pas être utilisée si l’abonnement KeyVault n’est pas identique à l’abonnement Jeu de chiffrement de disque.

SourceVault

L’ID de coffre est un ID de ressource Azure Resource Manager sous la forme /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Nom Type Description
id

string

ID de ressource

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.