Partilhar via

Add-AzVmssSecret

Módulo:
Az.Compute Module

Adiciona um segredo a um VMSS.

Sintaxe

Default (Predefinição) 

Add-AzVmssSecret
    [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
    [[-SourceVaultId] <String>]
    [[-VaultCertificate] <VaultCertificate[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O cmdlet Add-AzVmssSecret adiciona um segredo ao VMSS (Virtual Machine Scale set). O segredo deve ser guardado num Azure Key Vault. Para mais informações relacionadas com Key Vault, veja O que é Azure Key Vault? (https://learn.microsoft.com/azure/key-vault/general/basic-concepts). Para mais informações sobre os cmdlets, veja Azure Key Vault Cmdlets ou o cmdlet Set-AzKeyVaultSecret.

Exemplos

Exemplo 1: Adicionar um segredo ao VMSS usando a extensão de máquina virtual Azure Key Vault

# Build settings
$settings = @{
    secretsManagementSettings = @{
        pollingIntervalInS       = "<pollingInterval>"
        certificateStoreName     = "<certStoreName>"
        certificateStoreLocation = "<certStoreLoc>"
        observedCertificates     = @("<observedCert1>", "<observedCert2>")
    }
} | ConvertTo-Json
$extName = "KeyVaultForLinux"
$extPublisher = "Microsoft.Azure.KeyVault"
$extType = "KeyVaultForLinux"
# Add Extension to VMSS
$vmss = Get-AzVmss -ResourceGroupName <ResourceGroupName> -VMScaleSetName <VmssName>
Add-AzVmssExtension -VirtualMachineScaleSet $vmss  -Name $extName -Publisher $extPublisher -Type $extType -TypeHandlerVersion "2.0" -Setting $settings
# Start the deployment
Update-AzVmss -ResourceGroupName <ResourceGroupName> -VMScaleSetName <VmssName> -VirtualMachineScaleSet $vmss

Para instalar certificados numa máquina virtual, recomenda-se usar a extensão Azure Key Vault para Linux ou a extensão Azure Key Vault para máquina virtual para Windows.

Exemplo 2: Adicionar um segredo ao VMSS usando Add-AzVmssSecret

$Vault = Get-AzKeyVault -VaultName "ContosoVault"
$CertConfig = New-AzVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "Certificates"
$VMSS = New-AzVmssConfig
Add-AzVmssSecret -VirtualMachineScaleSet $VMSS -SourceVaultId $Vault.ResourceId -VaultCertificate $CertConfig

Este exemplo adiciona um segredo ao VMSS. O primeiro comando usa o cmdlet Get-AzKeyVault para obter um segredo do cofre chamado ContosoVault e armazena o resultado na variável chamada $Vault. O segundo comando utiliza o cmdlet New-AzVmssVaultCertificateConfig para criar uma configuração de certificado Key Vault usando a URL de certificado especificada da loja de certificados chamada Certificates e armazena os resultados na variável chamada $CertConfig. O terceiro comando usa o cmdlet New-AzVmssConfig para criar um objeto de configuração do VMSS e armazena o resultado na variável chamada $VMSS. O quarto comando adiciona um segredo ao VMSS usando o segredo do vault usando o ID do recurso de chave e o certificado do vault armazenado nas variáveis $Vault e $CertConfig.

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
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

-SourceVaultId

Especifica o ID de recurso do Key Vault que contém os certificados que podes adicionar à máquina virtual. Esse valor também atua como a chave para adicionar vários certificados. Isto significa que pode usar o mesmo valor para o parâmetro SourceVaultId quando adiciona vários certificados do mesmo Key Vault.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

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

-VaultCertificate

Especifica o objeto Vault Certificate que contém a URL e o nome do certificado. Você pode usar o cmdlet New-AzVmssVaultCertificateConfig para criar esse objeto.

Propriedades dos parâmetros

Tipo:

VaultCertificate[]

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

Conjuntos de parâmetros

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

-VirtualMachineScaleSet

Especifica o objeto VMSS. Você pode usar o cmdlet New-AzVmssConfig para criar esse objeto.

Propriedades dos parâmetros

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

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:True
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:None
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.

Entradas

PSVirtualMachineScaleSet

String

VaultCertificate

Saídas

PSVirtualMachineScaleSet