Delen via


Disk Encryption Sets - Update

Hiermee wordt een schijfversleutelingsset bijgewerkt (gepatcht).

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

URI-parameters

Name In Vereist Type Description
diskEncryptionSetName
path True

string

De naam van de schijfversleutelingsset die wordt gemaakt. De naam kan niet worden gewijzigd nadat de schijfversleutelingsset is gemaakt. Ondersteunde tekens voor de naam zijn a-z, A-Z, 0-9, _ en -. De naam kan maximaal 80 tekens lang zijn.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is hoofdletterongevoelig.

subscriptionId
path True

string

minLength: 1

De id van het doelabonnement.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Type Description
identity

EncryptionSetIdentity

De beheerde identiteit voor de schijfversleutelingsset. Deze moet worden gemachtigd voor de sleutelkluis voordat deze kan worden gebruikt voor het versleutelen van schijven.

properties.activeKey

KeyForDiskEncryptionSet

Key Vault Key-URL die moet worden gebruikt voor versleuteling aan de serverzijde van beheerde schijven en snapshots

properties.encryptionType

DiskEncryptionSetType

Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen.

properties.federatedClientId

string

Client-id voor toepassing met meerdere tenants voor toegang tot de sleutelkluis in een andere tenant. Als u de waarde instelt op 'Geen', wordt de eigenschap gewist.

properties.rotationToLatestKeyVersionEnabled

boolean

Stel deze vlag in op true om automatisch bijwerken van deze schijfversleuteling in te schakelen op de meest recente sleutelversie.

tags

object

Resourcetags

Antwoorden

Name Type Description
200 OK

DiskEncryptionSet

Azure-bewerking is voltooid.

202 Accepted

DiskEncryptionSet

De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Kopteksten

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

CloudError

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ApiError

Api-fout.

ApiErrorBase

Api-foutbasis.

CloudError

Een foutreactie van de Compute-service.

createdByType

Het type identiteit waarmee de resource is gemaakt.

DiskEncryptionSet

Resource voor schijfversleutelingsset.

DiskEncryptionSetIdentityType

Het type beheerde identiteit dat wordt gebruikt door de DiskEncryptionSet. Alleen SystemAssigned wordt ondersteund voor nieuwe creaties. Schijfversleutelingssets kunnen worden bijgewerkt met identiteitstype Geen tijdens de migratie van het abonnement naar een nieuwe Azure Active Directory-tenant; dit zorgt ervoor dat de versleutelde resources geen toegang meer hebben tot de sleutels.

DiskEncryptionSetType

Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen.

DiskEncryptionSetUpdate

Resource voor het bijwerken van de set voor schijfversleuteling.

EncryptionSetIdentity

De beheerde identiteit voor de schijfversleutelingsset. Deze moet worden gemachtigd voor de sleutelkluis voordat deze kan worden gebruikt voor het versleutelen van schijven.

InnerError

Interne foutdetails.

KeyForDiskEncryptionSet

Key Vault Key-URL die moet worden gebruikt voor versleuteling aan de serverzijde van beheerde schijven en snapshots

SourceVault

De kluis-id is een Azure Resource Manager-resource-id in de vorm /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

UserAssignedIdentitiesValue

ApiError

Api-fout.

Name Type Description
code

string

De foutcode.

details

ApiErrorBase[]

Details van de Api-fout

innererror

InnerError

De innerlijke fout van de Api

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

ApiErrorBase

Api-foutbasis.

Name Type Description
code

string

De foutcode.

message

string

Het foutbericht.

target

string

Het doel van de specifieke fout.

CloudError

Een foutreactie van de Compute-service.

Name Type Description
error

ApiError

Api-fout.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

DiskEncryptionSet

Resource voor schijfversleutelingsset.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

EncryptionSetIdentity

De beheerde identiteit voor de schijfversleutelingsset. Deze moet worden gemachtigd voor de sleutelkluis voordat deze kan worden gebruikt voor het versleutelen van schijven.

location

string

De geografische locatie waar de resource zich bevindt

name

string

De naam van de resource

properties.activeKey

KeyForDiskEncryptionSet

De sleutelkluissleutel die momenteel wordt gebruikt door deze schijfversleutelingsset.

properties.autoKeyRotationError

ApiError

De fout die optrad tijdens het draaien van de automatische toets. Als er een fout aanwezig is, wordt niet geprobeerd de automatische sleutel te roteren totdat de fout op deze schijfcoderingsset is verholpen.

properties.encryptionType

DiskEncryptionSetType

Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen.

properties.federatedClientId

string

Client-id voor toepassing met meerdere tenants voor toegang tot de sleutelkluis in een andere tenant. Als u de waarde instelt op 'Geen', wordt de eigenschap gewist.

properties.lastKeyRotationTimestamp

string (date-time)

Het tijdstip waarop de actieve sleutel van deze schijfversleutelingsset is bijgewerkt.

properties.previousKeys

KeyForDiskEncryptionSet[]

Een alleen-lezen verzameling sleutelkluissleutels die eerder door deze schijfversleutelingsset zijn gebruikt terwijl een sleutelrotatie bezig is. Het is leeg als er geen doorlopende toetsrotatie is.

properties.provisioningState

string

De inrichtingsstatus van de schijfversleutelingsset is ingesteld.

properties.rotationToLatestKeyVersionEnabled

boolean

Stel deze vlag in op true om automatisch bijwerken van deze schijfversleuteling in te schakelen op de meest recente sleutelversie.

systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.

tags

object

Resourcetags.

type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

DiskEncryptionSetIdentityType

Het type beheerde identiteit dat wordt gebruikt door de DiskEncryptionSet. Alleen SystemAssigned wordt ondersteund voor nieuwe creaties. Schijfversleutelingssets kunnen worden bijgewerkt met identiteitstype Geen tijdens de migratie van het abonnement naar een nieuwe Azure Active Directory-tenant; dit zorgt ervoor dat de versleutelde resources geen toegang meer hebben tot de sleutels.

Waarde Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

DiskEncryptionSetType

Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen.

Waarde Description
EncryptionAtRestWithCustomerKey

Een bron die gebruikmaakt van diskEncryptionSet wordt in rust versleuteld met een door de klant beheerde sleutel die door een klant kan worden gewijzigd en ingetrokken.

EncryptionAtRestWithPlatformAndCustomerKeys

Bron die diskEncryptionSet gebruikt, wordt in rust versleuteld met twee versleutelingslagen. Een van de sleutels is Customer managed en de andere key is Platform managed.

ConfidentialVmEncryptedWithCustomerKey

Vertrouwelijke VM-ondersteunde schijf en VM-gaststatus worden versleuteld met een door de klant beheerde sleutel.

DiskEncryptionSetUpdate

Resource voor het bijwerken van de set voor schijfversleuteling.

Name Type Description
identity

EncryptionSetIdentity

De beheerde identiteit voor de schijfversleutelingsset. Deze moet worden gemachtigd voor de sleutelkluis voordat deze kan worden gebruikt voor het versleutelen van schijven.

properties.activeKey

KeyForDiskEncryptionSet

Key Vault Key-URL die moet worden gebruikt voor versleuteling aan de serverzijde van beheerde schijven en snapshots

properties.encryptionType

DiskEncryptionSetType

Het type sleutel dat wordt gebruikt om de gegevens van de schijf te versleutelen.

properties.federatedClientId

string

Client-id voor toepassing met meerdere tenants voor toegang tot de sleutelkluis in een andere tenant. Als u de waarde instelt op 'Geen', wordt de eigenschap gewist.

properties.rotationToLatestKeyVersionEnabled

boolean

Stel deze vlag in op true om automatisch bijwerken van deze schijfversleuteling in te schakelen op de meest recente sleutelversie.

tags

object

Resourcetags

EncryptionSetIdentity

De beheerde identiteit voor de schijfversleutelingsset. Deze moet worden gemachtigd voor de sleutelkluis voordat deze kan worden gebruikt voor het versleutelen van schijven.

Name Type Description
principalId

string

De object-id van de beheerde identiteitsresource. Dit wordt vanuit ARM naar de RP verzonden via de header x-ms-identity-principal-id in het PUT-verzoek als de bron een systemAssigned(impliciete) identiteit heeft

tenantId

string

De tenant-id van de Managed Identity Resource. Dit wordt vanuit ARM naar de RP verzonden via de header x-ms-client-tenant-id in het PUT-verzoek als de bron een systemAssigned(impliciete) identiteit heeft

type

DiskEncryptionSetIdentityType

Het type beheerde identiteit dat wordt gebruikt door de DiskEncryptionSet. Alleen SystemAssigned wordt ondersteund voor nieuwe creaties. Schijfversleutelingssets kunnen worden bijgewerkt met identiteitstype Geen tijdens de migratie van het abonnement naar een nieuwe Azure Active Directory-tenant; dit zorgt ervoor dat de versleutelde resources geen toegang meer hebben tot de sleutels.

userAssignedIdentities

<string,  UserAssignedIdentitiesValue>

De lijst met gebruikersidentiteiten die zijn gekoppeld aan de schijfversleutelingsset. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

InnerError

Interne foutdetails.

Name Type Description
errordetail

string

De interne foutmelding of uitzonderingsdump.

exceptiontype

string

Het uitzonderingstype.

KeyForDiskEncryptionSet

Key Vault Key-URL die moet worden gebruikt voor versleuteling aan de serverzijde van beheerde schijven en snapshots

Name Type Description
keyUrl

string

Volledige versie van de sleutel-URL die verwijst naar een sleutel in KeyVault. Versiesegment van de URL is vereist, ongeacht de waarde rotationToLatestKeyVersionEnabled.

sourceVault

SourceVault

Resource-id van de KeyVault die de sleutel of het geheim bevat. Deze eigenschap is optioneel en kan niet worden gebruikt als het KeyVault-abonnement niet hetzelfde is als het abonnement schijfversleutelingsset.

SourceVault

De kluis-id is een Azure Resource Manager-resource-id in de vorm /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Name Type Description
id

string

Resource-id

systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit waarmee de resource is gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAssignedIdentitiesValue

Name Type Description
clientId

string

De client-id van de door de gebruiker toegewezen identiteit.

principalId

string

De principal-id van de door de gebruiker toegewezen identiteit.