Set-AzVMDiskEncryptionExtension

Módulo:: Az.Compute Module

Habilita a criptografia em uma máquina virtual IaaS em execução no Azure.

Sintaxe

SinglePassParameterSet (Predefinição)

Set-AzVMDiskEncryptionExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    [-DiskEncryptionKeyVaultUrl] <String>
    [-DiskEncryptionKeyVaultId] <String>
    [[-KeyEncryptionKeyUrl] <String>]
    [[-KeyEncryptionKeyVaultId] <String>]
    [[-KeyEncryptionAlgorithm] <String>]
    [[-VolumeType] <String>]
    [[-SequenceVersion] <String>]
    [[-TypeHandlerVersion] <String>]
    [[-Name] <String>]
    [[-Passphrase] <String>]
    [-EncryptionIdentity <String>]
    [-Force]
    [-DisableAutoUpgradeMinorVersion]
    [-SkipVmBackup]
    [-ExtensionType <String>]
    [-ExtensionPublisherName <String>]
    [-EncryptFormatAll]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AADClientSecretParameterSet

Set-AzVMDiskEncryptionExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    [-AadClientID] <String>
    [-AadClientSecret] <String>
    [-DiskEncryptionKeyVaultUrl] <String>
    [-DiskEncryptionKeyVaultId] <String>
    [[-KeyEncryptionKeyUrl] <String>]
    [[-KeyEncryptionKeyVaultId] <String>]
    [[-KeyEncryptionAlgorithm] <String>]
    [[-VolumeType] <String>]
    [[-SequenceVersion] <String>]
    [[-TypeHandlerVersion] <String>]
    [[-Name] <String>]
    [[-Passphrase] <String>]
    [-Force]
    [-DisableAutoUpgradeMinorVersion]
    [-SkipVmBackup]
    [-ExtensionType <String>]
    [-ExtensionPublisherName <String>]
    [-EncryptFormatAll]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AADClientCertParameterSet

Set-AzVMDiskEncryptionExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    [-AadClientID] <String>
    [-AadClientCertThumbprint] <String>
    [-DiskEncryptionKeyVaultUrl] <String>
    [-DiskEncryptionKeyVaultId] <String>
    [[-KeyEncryptionKeyUrl] <String>]
    [[-KeyEncryptionKeyVaultId] <String>]
    [[-KeyEncryptionAlgorithm] <String>]
    [[-VolumeType] <String>]
    [[-SequenceVersion] <String>]
    [[-TypeHandlerVersion] <String>]
    [[-Name] <String>]
    [[-Passphrase] <String>]
    [-Force]
    [-DisableAutoUpgradeMinorVersion]
    [-SkipVmBackup]
    [-ExtensionType <String>]
    [-ExtensionPublisherName <String>]
    [-EncryptFormatAll]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

MigrateADEVersionParameterSet

Set-AzVMDiskEncryptionExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    [[-KeyEncryptionAlgorithm] <String>]
    [[-VolumeType] <String>]
    [[-SequenceVersion] <String>]
    [[-TypeHandlerVersion] <String>]
    [[-Name] <String>]
    [[-Passphrase] <String>]
    [-Force]
    [-DisableAutoUpgradeMinorVersion]
    [-SkipVmBackup]
    [-ExtensionType <String>]
    [-ExtensionPublisherName <String>]
    [-EncryptFormatAll]
    [-Migrate]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

MigrateADEVersionRecoveryParameterSet

Set-AzVMDiskEncryptionExtension
    [-ResourceGroupName] <String>
    [-VMName] <String>
    [[-KeyEncryptionAlgorithm] <String>]
    [[-VolumeType] <String>]
    [[-SequenceVersion] <String>]
    [[-TypeHandlerVersion] <String>]
    [[-Name] <String>]
    [[-Passphrase] <String>]
    [-Force]
    [-DisableAutoUpgradeMinorVersion]
    [-SkipVmBackup]
    [-ExtensionType <String>]
    [-ExtensionPublisherName <String>]
    [-EncryptFormatAll]
    [-MigrationRecovery]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O cmdlet Set-AzVMDiskEncryptionExtension habilita a criptografia em uma máquina virtual IaaS (infraestrutura como serviço) em execução no Azure. Ele permite a criptografia instalando a extensão de criptografia de disco na máquina virtual.

Esse cmdlet requer a confirmação dos usuários, pois uma das etapas para habilitar a criptografia requer uma reinicialização da máquina virtual.

É aconselhável que você salve seu trabalho na máquina virtual antes de executar este cmdlet.

Linux: O parâmetro VolumeType é necessário ao criptografar máquinas virtuais Linux e deve ser definido como um valor ("Os", "Data" ou "All") suportado pela distribuição Linux.

Windows: O parâmetro VolumeType pode ser omitido, caso em que a operação assume como padrão All; se o parâmetro VolumeType estiver presente para uma máquina virtual do Windows, ele deverá ser definido como All ou OS.

Exemplos

Exemplo 1: Ativar encriptação

$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
$VaultName= "MyKeyVault"
$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName
$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
$KeyVaultResourceId = $KeyVault.ResourceId
$VolumeType = "All"
Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType

Este exemplo habilita a criptografia em uma VM sem especificar as credenciais do AD.

Exemplo 2: Habilitar a criptografia com entrada canalizada

$params = New-Object PSObject -Property @{
    ResourceGroupName = "[resource-group-name]"
    VMName = "[vm-name]"
    DiskEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]"
    DiskEncryptionKeyVaultUrl = "https://[keyvault-name].vault.azure.net"
    KeyEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]"
    KeyEncryptionKeyUrl = "https://[keyvault-name].vault.azure.net/keys/[kekname]/[kek-unique-id]"
    VolumeType = "All"
}

$params | Set-AzVMDiskEncryptionExtension

Este exemplo envia parâmetros usando entrada em pipeline para habilitar a criptografia em uma VM, sem especificar credenciais do AD.

Exemplo 3: Habilitar a criptografia usando a ID do Cliente do Microsoft Entra e o Segredo do Cliente

$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
$AADClientID = "<clientID of your Azure AD app>"
$AADClientSecret = "<clientSecret of your Azure AD app>"
$VaultName= "MyKeyVault"
$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName
$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
$KeyVaultResourceId = $KeyVault.ResourceId
$VolumeType = "All"
Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType

Este exemplo usa a ID do cliente Microsoft Entra e o segredo do cliente para habilitar a criptografia em uma VM.

Exemplo 4: Habilitar a criptografia usando a ID do cliente Microsoft Entra e a impressão digital da certificação do cliente

$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
#The KeyVault must have enabledForDiskEncryption property set on it
$VaultName= "MyKeyVault"
$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName
$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
$KeyVaultResourceId = $KeyVault.ResourceId
$VolumeType = "All"

# create Azure AD application and associate the certificate
$CertPath = "C:\certificates\examplecert.pfx"
$CertPassword = "Password"
$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword)
$CertValue = [System.Convert]::ToBase64String($cert.GetRawCertData())
$AzureAdApplication = New-AzADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -CertValue $CertValue
$ServicePrincipal = New-AzADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId

$AADClientID = $AzureAdApplication.ApplicationId
$aadClientCertThumbprint= $cert.Thumbprint

#Upload pfx to KeyVault
$KeyVaultSecretName = "MyAADCert"
$FileContentBytes = Get-Content $CertPath -Encoding Byte
$FileContentEncoded = [System.Convert]::ToBase64String($fileContentBytes)
$JSONObject = @"
    {
        "data" : "$filecontentencoded",
        "dataType" : "pfx",
        "password" : "$CertPassword"
    }
"@
$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($jsonObject)
$JSONEncoded = [System.Convert]::ToBase64String($jsonObjectBytes)

$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force
Set-AzKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName -SecretValue $Secret
Set-AzKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment

#deploy cert to VM
$CertUrl = (Get-AzKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id
$SourceVaultId = (Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId
$VM = Get-AzVM -ResourceGroupName $RGName -Name $VMName
$VM = Add-AzVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl
Update-AzVM -VM $VM -ResourceGroupName $RGName

#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint
Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType

Este exemplo usa a ID do cliente Microsoft Entra e impressões digitais de certificação do cliente para habilitar a criptografia em uma VM.

Exemplo 5: Habilitar a criptografia usando a ID do cliente Microsoft Entra, o segredo do cliente e a chave de criptografia do disco wrap usando a chave de criptografia de chave

$RGName = "MyResourceGroup"
$VMName = "MyTestVM"

$AADClientID = "<clientID of your Azure AD app>"
$AADClientSecret = "<clientSecret of your Azure AD app>"

$VaultName= "MyKeyVault"
$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName
$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
$KeyVaultResourceId = $KeyVault.ResourceId
$VolumeType = "All"

$KEKName = "MyKeyEncryptionKey"
$KEK = Add-AzKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software"
$KeyEncryptionKeyUrl = $KEK.Key.kid

Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -AadClientID $AADClientID -AadClientSecret $AADClientSecret -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl -KeyEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType

Este exemplo usa a ID do cliente Microsoft Entra e o segredo do cliente para habilitar a criptografia em uma VM e encapsula a chave de criptografia de disco usando uma chave de criptografia de chave.

Exemplo 6: Habilite a criptografia usando a ID do cliente Microsoft Entra, a impressão digital do certificado do cliente e a chave de criptografia do disco wrap usando a chave de criptografia de chave

$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
#The KeyVault must have enabledForDiskEncryption property set on it
$VaultName= "MyKeyVault"
$KeyVault = Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName
$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
$KeyVaultResourceId = $KeyVault.ResourceId
$KEKName = "MyKeyEncryptionKey"
$KEK = Add-AzKeyVaultKey -VaultName $VaultName -Name $KEKName -Destination "Software"
$KeyEncryptionKeyUrl = $KEK.Key.kid
$VolumeType = "All"

# create Azure AD application and associate the certificate
$CertPath = "C:\certificates\examplecert.pfx"
$CertPassword = "Password"
$Cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($CertPath, $CertPassword)
$CertValue = [System.Convert]::ToBase64String($cert.GetRawCertData())
$AzureAdApplication = New-AzADApplication -DisplayName "<Your Application Display Name>" -HomePage "<https://YourApplicationHomePage>" -IdentifierUris "<https://YouApplicationUri>" -CertValue $CertValue
$ServicePrincipal = New-AzADServicePrincipal -ApplicationId $AzureAdApplication.ApplicationId

$AADClientID = $AzureAdApplication.ApplicationId
$AADClientCertThumbprint= $Cert.Thumbprint

#Upload pfx to KeyVault
$KeyVaultSecretName = "MyAADCert"
$FileContentBytes = Get-Content $CertPath -Encoding Byte
$FileContentEncoded = [System.Convert]::ToBase64String($FileContentBytes)
$JSONObject = @"
    {
        "data" : "$filecontentencoded",
        "dataType" : "pfx",
        "password" : "$CertPassword"
    }
"@
$JSONObjectBytes = [System.Text.Encoding]::UTF8.GetBytes($JSONObject)
$JsonEncoded = [System.Convert]::ToBase64String($JSONObjectBytes)
$Secret = ConvertTo-SecureString -String $JSONEncoded -AsPlainText -Force
Set-AzKeyVaultSecret -VaultName $VaultName-Name $KeyVaultSecretName -SecretValue $Secret
Set-AzKeyVaultAccessPolicy -VaultName $VaultName -ResourceGroupName $RGName -EnabledForDeployment

#deploy cert to VM
$CertUrl = (Get-AzKeyVaultSecret -VaultName $VaultName -Name $KeyVaultSecretName).Id
$SourceVaultId = (Get-AzKeyVault -VaultName $VaultName -ResourceGroupName $RGName).ResourceId
$VM = Get-AzVM -ResourceGroupName $RGName -Name $VMName
$VM = Add-AzVMSecret -VM $VM -SourceVaultId $SourceVaultId -CertificateStore "My" -CertificateUrl $CertUrl
Update-AzVM -VM $VM -ResourceGroupName $RGName

#Enable encryption on the virtual machine using Azure AD client ID and client cert thumbprint
Set-AzVMDiskEncryptionExtension -ResourceGroupName $RGname -VMName $VMName -AadClientID $AADClientID -AadClientCertThumbprint $AADClientCertThumbprint -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId -KeyEncryptionKeyUrl $KeyEncryptionKeyUrl -KeyEncryptionKeyVaultId $KeyVaultResourceId -VolumeType $VolumeType

Este exemplo usa a ID do cliente Microsoft Entra e a impressão digital do certificado do cliente para habilitar a criptografia em uma VM e encapsula a chave de criptografia de disco usando uma chave de criptografia de chave.

Parâmetros

-AadClientCertThumbprint

Especifica a impressão digital do certificado de cliente do aplicativo Microsoft Entra que tem permissões para gravar segredos no KeyVault. Como pré-requisito, o certificado de cliente do Microsoft Entra deve ser implantado previamente no armazenamento de certificados do computador my local da máquina virtual. O cmdlet Add-AzVMSecret pode ser usado para implantar um certificado em uma máquina virtual no Azure. Para obter mais detalhes, consulte a ajuda do cmdlet Add-AzVMSecret . O certificado deve ser implantado previamente no computador local da máquina virtual meu armazenamento de certificados.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AADClientCertParameterSet

Position:	3
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-AadClientID

Especifica a ID do cliente do aplicativo Microsoft Entra que tem permissões para gravar segredos no KeyVault.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AADClientSecretParameterSet

Position:	2
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientCertParameterSet

Position:	2
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-AadClientSecret

Especifica o segredo do cliente do aplicativo Microsoft Entra que tem permissões para gravar segredos no KeyVault.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

AADClientSecretParameterSet

Position:	3
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	False
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Cf.

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Propriedades dos parâmetros

Tipo:	IAzureContextContainer
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-DisableAutoUpgradeMinorVersion

Indica que esse cmdlet desabilita a atualização automática da versão secundária da extensão.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	14
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-DiskEncryptionKeyVaultId

Especifica o ID do recurso do KeyVault para o qual as chaves de criptografia da máquina virtual devem ser carregadas.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

SinglePassParameterSet

Position:	5
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientSecretParameterSet

Position:	5
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientCertParameterSet

Position:	5
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-DiskEncryptionKeyVaultUrl

Especifica a URL do KeyVault para a qual as chaves de criptografia da máquina virtual devem ser carregadas.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

SinglePassParameterSet

Position:	4
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientSecretParameterSet

Position:	4
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientCertParameterSet

Position:	4
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-EncryptFormatAll

Encrypt-Format todas as unidades de dados que ainda não estão criptografadas

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-EncryptionIdentity

ID de recurso da identidade gerenciada com acesso ao keyvault para operações ADE.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

SinglePassParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-ExtensionPublisherName

O nome do editor da extensão. Especifique esse parâmetro apenas para substituir o valor padrão de "Microsoft.Azure.Security".

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-ExtensionType

O tipo de extensão. Especifique esse parâmetro para substituir seu valor padrão de "AzureDiskEncryption" para VMs Windows e "AzureDiskEncryptionForLinux" para VMs Linux.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-Force

Força o comando a ser executado sem pedir a confirmação do usuário.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-KeyEncryptionAlgorithm

Especifica o algoritmo usado para encapsular e desencapsular a chave de criptografia de chave da máquina virtual. O valor padrão é RSA-OAEP.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Valores aceites:	RSA-OAEP, RSA1_5
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	8
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-KeyEncryptionKeyUrl

Especifica a URL da chave de criptografia de chave usada para encapsular e desencapsular a chave de criptografia da máquina virtual. Este deve ser o URL com versão completa.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

SinglePassParameterSet

Position:	6
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientSecretParameterSet

Position:	6
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientCertParameterSet

Position:	6
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-KeyEncryptionKeyVaultId

Especifica a ID do recurso do KeyVault que contém a chave de criptografia de chave usada para encapsular e desempacotar a chave de criptografia da máquina virtual. Este deve ser um URL com versão completa.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

SinglePassParameterSet

Position:	7
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientSecretParameterSet

Position:	7
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

AADClientCertParameterSet

Position:	7
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-Migrate

Inicia a migração da VM para a versão mais recente da extensão Azure Disk Encryption (ADE sem credenciais do Microsoft Entra).

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

MigrateADEVersionParameterSet

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-MigrationRecovery

Inicia a recuperação de migração para falhas durante a migração da versão da extensão ADE com o Microsoft Entra ID para a versão da extensão ADE sem o Microsoft Entra ID.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

MigrateADEVersionRecoveryParameterSet

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-Name

Especifica o nome do recurso do Azure Resource Manager que representa a extensão. Se o parâmetro Name for omitido, a extensão instalada será denominada AzureDiskEncryption em máquinas virtuais Windows e AzureDiskEncryptionForLinux em máquinas virtuais Linux.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	ExtensionName

Conjuntos de parâmetros

(All)

Position:	12
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-Passphrase

Especifica a senha usada apenas para criptografar máquinas virtuais Linux. Este parâmetro não é usado para máquinas virtuais que executam o sistema operacional Windows.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	13
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-ResourceGroupName

Especifica o nome do grupo de recursos da máquina virtual.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	0
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-SequenceVersion

Especifica o número de sequência das operações de criptografia para uma máquina virtual. Isso é exclusivo para cada operação de criptografia executada na mesma máquina virtual. O cmdlet Get-AzVMExtension pode ser usado para recuperar o número de sequência anterior que foi usado.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	10
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-SkipVmBackup

Ignorar a criação de backup para VMs Linux

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	15
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-TypeHandlerVersion

Especifica a versão da extensão de criptografia.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	HandlerVersion, Versão

Conjuntos de parâmetros

(All)

Position:	11
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-VMName

Especifica o nome da máquina virtual.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Nome do Recurso

Conjuntos de parâmetros

(All)

Position:	1
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-VolumeType

Especifica o tipo de volumes de máquina virtual nos quais executar a operação de criptografia: SO, Dados ou Todos.

Linux: O parâmetro VolumeType é necessário ao criptografar máquinas virtuais Linux e deve ser definido como um valor ("Os", "Data" ou "All") suportado pela distribuição Linux.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Valores aceites:	OS, Data, All
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	9
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	True
Valor dos restantes argumentos:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	False
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	Wi

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Partilhar via

Set-AzVMDiskEncryptionExtension

Sintaxe

SinglePassParameterSet (Predefinição)

AADClientSecretParameterSet

AADClientCertParameterSet

MigrateADEVersionParameterSet

MigrateADEVersionRecoveryParameterSet

Description

Exemplos

Exemplo 1: Ativar encriptação

Exemplo 2: Habilitar a criptografia com entrada canalizada

Exemplo 3: Habilitar a criptografia usando a ID do Cliente do Microsoft Entra e o Segredo do Cliente

Exemplo 4: Habilitar a criptografia usando a ID do cliente Microsoft Entra e a impressão digital da certificação do cliente

Exemplo 5: Habilitar a criptografia usando a ID do cliente Microsoft Entra, o segredo do cliente e a chave de criptografia do disco wrap usando a chave de criptografia de chave

Exemplo 6: Habilite a criptografia usando a ID do cliente Microsoft Entra, a impressão digital do certificado do cliente e a chave de criptografia do disco wrap usando a chave de criptografia de chave

Parâmetros

-AadClientCertThumbprint

Propriedades dos parâmetros

Conjuntos de parâmetros

-AadClientID

Propriedades dos parâmetros

Conjuntos de parâmetros

-AadClientSecret

Propriedades dos parâmetros

Conjuntos de parâmetros

-Confirm

Propriedades dos parâmetros

Conjuntos de parâmetros

-DefaultProfile

Propriedades dos parâmetros

Conjuntos de parâmetros

-DisableAutoUpgradeMinorVersion

Propriedades dos parâmetros

Conjuntos de parâmetros

-DiskEncryptionKeyVaultId

Propriedades dos parâmetros

Conjuntos de parâmetros

-DiskEncryptionKeyVaultUrl

Propriedades dos parâmetros

Conjuntos de parâmetros

-EncryptFormatAll

Propriedades dos parâmetros

Conjuntos de parâmetros

-EncryptionIdentity

Propriedades dos parâmetros

Conjuntos de parâmetros

-ExtensionPublisherName

Propriedades dos parâmetros

Conjuntos de parâmetros

-ExtensionType

Propriedades dos parâmetros

Conjuntos de parâmetros

-Force

Propriedades dos parâmetros

Conjuntos de parâmetros

-KeyEncryptionAlgorithm

Propriedades dos parâmetros

Conjuntos de parâmetros

-KeyEncryptionKeyUrl

Propriedades dos parâmetros

Conjuntos de parâmetros

-KeyEncryptionKeyVaultId

Propriedades dos parâmetros

Conjuntos de parâmetros

-Migrate

Propriedades dos parâmetros

Conjuntos de parâmetros

-MigrationRecovery

Propriedades dos parâmetros

Conjuntos de parâmetros

-Name

Propriedades dos parâmetros

Conjuntos de parâmetros

-Passphrase

Propriedades dos parâmetros

Conjuntos de parâmetros

-ResourceGroupName

Propriedades dos parâmetros

Conjuntos de parâmetros