Disk Encryption Sets - Update

Aktualisiert (patcht) einen Festplattenverschlüsselungssatz.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
diskEncryptionSetName
path True

string

Der Name des Datenträgerverschlüsselungssatzes, der erstellt wird. Der Name kann nicht geändert werden, nachdem der Datenträgerverschlüsselungssatz erstellt wurde. Unterstützte Zeichen für den Namen sind a-z, A-Z, 0-9, _ und -. Die maximale Namenslänge ist 80 Zeichen.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

minLength: 1

Die ID des Zielabonnements.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Typ Beschreibung
identity

EncryptionSetIdentity

Die verwaltete Identität für den Datenträgerverschlüsselungssatz. Sie sollte über die Berechtigung für den Schlüsseltresor verfügen, bevor sie zum Verschlüsseln von Datenträgern verwendet werden kann.

properties.activeKey

KeyForDiskEncryptionSet

Key Vault-Schlüssel-URL, die für die serverseitige Verschlüsselung von verwalteten Datenträgern und Momentaufnahmen verwendet werden soll

properties.encryptionType

DiskEncryptionSetType

Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird.

properties.federatedClientId

string

Client-ID für mehrere Mandanten, um auf den Schlüsseltresor in einem anderen Mandanten zuzugreifen. Wenn Sie den Wert auf "None" festlegen, wird die Eigenschaft gelöscht.

properties.rotationToLatestKeyVersionEnabled

boolean

Legen Sie dieses Kennzeichen auf "true" fest, um die automatische Aktualisierung dieser Datenträgerverschlüsselung auf die neueste Schlüsselversion zu aktivieren.

tags

object

Ressourcenetiketten

Antworten

Name Typ Beschreibung
200 OK

DiskEncryptionSet

Azure-Operation erfolgreich abgeschlossen.

202 Accepted

DiskEncryptionSet

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Succeeded
update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Updating
update a disk encryption set.

update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Succeeded

Beispielanforderung

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "activeKey": {
      "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "rotationToLatestKeyVersionEnabled": true
  }
}

Beispiel für eine Antwort

{
  "name": "myDiskEncryptionSet",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
  "type": "Microsoft.Compute/diskEncryptionSets",
  "location": "West US",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "activeKey": {
      "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/KeyVersion2"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "rotationToLatestKeyVersionEnabled": true,
    "provisioningState": "Succeeded",
    "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00"
  }
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2025-01-02
{
  "name": "myDiskEncryptionSet",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
  "type": "Microsoft.Compute/diskEncryptionSets",
  "location": "West US",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "activeKey": {
      "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "previousKeys": []
  }
}

update a disk encryption set with rotationToLatestKeyVersionEnabled set to true - Updating

Beispielanforderung

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "activeKey": {
      "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "rotationToLatestKeyVersionEnabled": true
  }
}

Beispiel für eine Antwort

{
  "name": "myDiskEncryptionSet",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
  "type": "Microsoft.Compute/diskEncryptionSets",
  "location": "West US",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "activeKey": {
      "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion2"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "rotationToLatestKeyVersionEnabled": true,
    "previousKeys": [
      {
        "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1"
      }
    ],
    "provisioningState": "Updating",
    "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00"
  }
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2025-01-02
{
  "name": "myDiskEncryptionSet",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
  "type": "Microsoft.Compute/diskEncryptionSets",
  "location": "West US",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "activeKey": {
      "keyUrl": "https://myvaultdifferentsub.vault-int.azure-int.net/keys/keyName/keyVersion1"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "previousKeys": []
  }
}

update a disk encryption set.

Beispielanforderung

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

{
  "properties": {
    "activeKey": {
      "sourceVault": {
        "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault"
      },
      "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/keyName/keyVersion"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey"
  },
  "tags": {
    "department": "Development",
    "project": "Encryption"
  }
}

Beispiel für eine Antwort

{
  "name": "myDiskEncryptionSet",
  "location": "West US",
  "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/keyName/keyVersion"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "previousKeys": [],
    "lastKeyRotationTimestamp": "2021-04-01T04:41:35.079872+00:00"
  },
  "tags": {
    "department": "Development",
    "project": "Encryption"
  }
}
Location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet?api-version=2025-01-02
{
  "name": "myDiskEncryptionSet",
  "location": "West US",
  "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/keyName/keyVersion"
    },
    "encryptionType": "EncryptionAtRestWithCustomerKey",
    "previousKeys": []
  },
  "tags": {
    "department": "Development",
    "project": "Encryption"
  }
}

Definitionen

Name Beschreibung
ApiError

API-Fehler.

ApiErrorBase

API-Fehlerbasis.

CloudError

Eine Fehlerantwort vom Compute-Dienst.

Common.UserAssignedIdentitiesValue
createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DiskEncryptionSet

Datenträgerverschlüsselungssatzressource.

DiskEncryptionSetIdentityType

Der Typ der verwalteten Identität, die vom DiskEncryptionSet verwendet wird. Nur SystemAssigned wird für neue Erstellungen unterstützt. Datenträgerverschlüsselungssätze können während der Migration des Abonnements zu einem neuen Azure Active Directory Mandanten mit dem Identitätstyp "Keine" aktualisiert werden. Die verschlüsselten Ressourcen verlieren den Zugriff auf die Schlüssel.

DiskEncryptionSetType

Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird.

DiskEncryptionSetUpdate

Datenträgerverschlüsselungssatz-Updateressource.

EncryptionSetIdentity

Die verwaltete Identität für den Datenträgerverschlüsselungssatz. Sie sollte über die Berechtigung für den Schlüsseltresor verfügen, bevor sie zum Verschlüsseln von Datenträgern verwendet werden kann.

InnerError

Innere Fehlerdetails.

KeyForDiskEncryptionSet

Key Vault-Schlüssel-URL, die für die serverseitige Verschlüsselung von verwalteten Datenträgern und Momentaufnahmen verwendet werden soll

SourceVault

Die Tresor-ID ist eine Azure Resource Manager-Ressourcen-ID im Format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

ApiError

API-Fehler.

Name Typ Beschreibung
code

string

Der Fehlercode.

details

ApiErrorBase[]

Die Details zum API-Fehler

innererror

InnerError

Der innere API-Fehler

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

ApiErrorBase

API-Fehlerbasis.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung.

target

string

Das Ziel des bestimmten Fehlers.

CloudError

Eine Fehlerantwort vom Compute-Dienst.

Name Typ Beschreibung
error

ApiError

API-Fehler.

Common.UserAssignedIdentitiesValue

Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.

principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

DiskEncryptionSet

Datenträgerverschlüsselungssatzressource.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

EncryptionSetIdentity

Die verwaltete Identität für den Datenträgerverschlüsselungssatz. Sie sollte über die Berechtigung für den Schlüsseltresor verfügen, bevor sie zum Verschlüsseln von Datenträgern verwendet werden kann.

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.activeKey

KeyForDiskEncryptionSet

Der Schlüsseltresorschlüssel, der derzeit von diesem Datenträgerverschlüsselungssatz verwendet wird.

properties.autoKeyRotationError

ApiError

Der Fehler, der während der automatischen Schlüsseldrehung aufgetreten ist. Wenn ein Fehler auftritt, wird die automatische Schlüsselrotation erst versucht, wenn der Fehler in diesem Datenträgerverschlüsselungssatz behoben ist.

properties.encryptionType

DiskEncryptionSetType

Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird.

properties.federatedClientId

string

Client-ID für mehrere Mandanten, um auf den Schlüsseltresor in einem anderen Mandanten zuzugreifen. Wenn Sie den Wert auf "None" festlegen, wird die Eigenschaft gelöscht.

properties.lastKeyRotationTimestamp

string (date-time)

Der Zeitpunkt, zu dem der aktive Schlüssel dieses Festplattenverschlüsselungssatzes aktualisiert wurde.

properties.previousKeys

KeyForDiskEncryptionSet[]

Eine schreibgeschützte Auflistung von Schlüsseltresorschlüsseln, die zuvor von diesem Datenträgerverschlüsselungssatz verwendet wurden, während eine Schlüsselrotation ausgeführt wird. Er ist leer, wenn keine laufende Schlüsselrotation stattfindet.

properties.provisioningState

string

Der Bereitstellungsstatus des Datenträgerverschlüsselungssatzes.

properties.rotationToLatestKeyVersionEnabled

boolean

Legen Sie dieses Kennzeichen auf "true" fest, um die automatische Aktualisierung dieser Datenträgerverschlüsselung auf die neueste Schlüsselversion zu aktivieren.

systemData

systemData

Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.

tags

object

Ressourcentags.

type

string

Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

DiskEncryptionSetIdentityType

Der Typ der verwalteten Identität, die vom DiskEncryptionSet verwendet wird. Nur SystemAssigned wird für neue Erstellungen unterstützt. Datenträgerverschlüsselungssätze können während der Migration des Abonnements zu einem neuen Azure Active Directory Mandanten mit dem Identitätstyp "Keine" aktualisiert werden. Die verschlüsselten Ressourcen verlieren den Zugriff auf die Schlüssel.

Wert Beschreibung
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

DiskEncryptionSetType

Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird.

Wert Beschreibung
EncryptionAtRestWithCustomerKey

Die Ressource, die diskEncryptionSet verwendet, wird im Ruhezustand mit dem vom Kunden verwalteten Schlüssel verschlüsselt, der von einem Kunden geändert und widerrufen werden kann.

EncryptionAtRestWithPlatformAndCustomerKeys

Die Ressource, die diskEncryptionSet verwendet, wird im Ruhezustand mit zwei Verschlüsselungsebenen verschlüsselt. Einer der Schlüssel ist vom Kunden verwaltet, und der andere Schlüssel wird plattformverwaltet.

ConfidentialVmEncryptedWithCustomerKey

Der von vertraulichen VMs unterstützte Datenträger und der Gaststatus der VM werden mit dem vom Kunden verwalteten Schlüssel verschlüsselt.

DiskEncryptionSetUpdate

Datenträgerverschlüsselungssatz-Updateressource.

Name Typ Beschreibung
identity

EncryptionSetIdentity

Die verwaltete Identität für den Datenträgerverschlüsselungssatz. Sie sollte über die Berechtigung für den Schlüsseltresor verfügen, bevor sie zum Verschlüsseln von Datenträgern verwendet werden kann.

properties.activeKey

KeyForDiskEncryptionSet

Key Vault-Schlüssel-URL, die für die serverseitige Verschlüsselung von verwalteten Datenträgern und Momentaufnahmen verwendet werden soll

properties.encryptionType

DiskEncryptionSetType

Der Schlüsseltyp, der zum Verschlüsseln der Daten des Datenträgers verwendet wird.

properties.federatedClientId

string

Client-ID für mehrere Mandanten, um auf den Schlüsseltresor in einem anderen Mandanten zuzugreifen. Wenn Sie den Wert auf "None" festlegen, wird die Eigenschaft gelöscht.

properties.rotationToLatestKeyVersionEnabled

boolean

Legen Sie dieses Kennzeichen auf "true" fest, um die automatische Aktualisierung dieser Datenträgerverschlüsselung auf die neueste Schlüsselversion zu aktivieren.

tags

object

Ressourcenetiketten

EncryptionSetIdentity

Die verwaltete Identität für den Datenträgerverschlüsselungssatz. Sie sollte über die Berechtigung für den Schlüsseltresor verfügen, bevor sie zum Verschlüsseln von Datenträgern verwendet werden kann.

Name Typ Beschreibung
principalId

string

Die Objekt-ID der Ressource für verwaltete Identitäten. Dies wird von ARM über den x-ms-identity-principal-id-Header in der PUT-Anforderung an die vertrauende Seite gesendet, wenn die Ressource über eine systemAssigned(implizite) Identität verfügt

tenantId

string

Die Mandanten-ID der Ressource für verwaltete Identitäten. Dies wird von ARM über den x-ms-client-tenant-id-Header in der PUT-Anforderung an die vertrauende Seite gesendet, wenn die Ressource über eine systemAssigned(implizite) Identität verfügt

type

DiskEncryptionSetIdentityType

Der Typ der verwalteten Identität, die vom DiskEncryptionSet verwendet wird. Nur SystemAssigned wird für neue Erstellungen unterstützt. Datenträgerverschlüsselungssätze können während der Migration des Abonnements zu einem neuen Azure Active Directory Mandanten mit dem Identitätstyp "Keine" aktualisiert werden. Die verschlüsselten Ressourcen verlieren den Zugriff auf die Schlüssel.

userAssignedIdentities

<string,  Common.UserAssignedIdentitiesValue>

Die Liste der Benutzeridentitäten, die dem Datenträgerverschlüsselungssatz zugeordnet sind. Die Schlüsselreferenzen im Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs in der Form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. ManagedIdentity/userAssignedIdentities/{identityName}'.

InnerError

Innere Fehlerdetails.

Name Typ Beschreibung
errordetail

string

Die interne Fehlermeldung oder der Ausnahmedump.

exceptiontype

string

Der Ausnahmetyp.

KeyForDiskEncryptionSet

Key Vault-Schlüssel-URL, die für die serverseitige Verschlüsselung von verwalteten Datenträgern und Momentaufnahmen verwendet werden soll

Name Typ Beschreibung
keyUrl

string

Vollversionierte Schlüssel-URL, die auf einen Schlüssel in KeyVault verweist. Das Versionssegment der URL ist unabhängig vom RotationToLatestKeyVersionEnabled-Wert erforderlich.

sourceVault

SourceVault

Ressourcen-ID des KeyVault-Werts, der den Schlüssel oder geheimen Schlüssel enthält. Diese Eigenschaft ist optional und kann nicht verwendet werden, wenn das KeyVault-Abonnement nicht mit dem Disk Encryption Set-Abonnement identisch ist.

SourceVault

Die Tresor-ID ist eine Azure Resource Manager-Ressourcen-ID im Format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Name Typ Beschreibung
id

string

Ressourcen-ID

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string (date-time)

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.