Udostępnij za pośrednictwem

Add-AzVmssSecret

Moduł:
Az.Compute Module

Dodaje wpis tajny do zestawu skalowania maszyn wirtualnych.

Składnia

Default (domyślnie) 

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

Opis

Polecenie cmdlet Add-AzVmssSecret dodaje wpis tajny do zestawu skalowania maszyn wirtualnych (VMSS). Wpis tajny musi być przechowywany w Azure Key Vault. Aby uzyskać więcej informacji dotyczących Key Vault, zobacz Jak Azure Key Vault? (https://learn.microsoft.com/azure/key-vault/general/basic-concepts). Aby uzyskać więcej informacji na temat poleceń cmdlet, zobacz Azure Key Vault Cmdlets lub Set-AzKeyVaultSecret cmdlet.

Przykłady

Przykład 1. Dodawanie wpisu tajnego do zestawu skalowania maszyn wirtualnych przy użyciu rozszerzenia maszyny wirtualnej 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

Aby zainstalować certyfikaty na maszynie wirtualnej, zaleca się użycie rozszerzenia maszyny wirtualnej Azure Key Vault dla systemu Linux lub rozszerzenia maszyny wirtualnej Azure Key Vault dla Windows.

Przykład 2. Dodawanie wpisu tajnego do zestawu skalowania maszyn wirtualnych przy użyciu 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

W tym przykładzie dodano wpis tajny do zestawu skalowania maszyn wirtualnych. Pierwsze polecenie używa polecenia cmdlet Get-AzKeyVault do pobrania wpisu tajnego magazynu z magazynu o nazwie ContosoVault i zapisuje wynik w zmiennej o nazwie $Vault. Drugie polecenie używa polecenia cmdlet New-AzVmssVaultCertificateConfig w celu utworzenia konfiguracji certyfikatu Key Vault przy użyciu określonego adresu URL certyfikatu z magazynu certyfikatów o nazwie Certificates i przechowuje wyniki w zmiennej o nazwie $CertConfig. Trzecie polecenie używa polecenia cmdlet New-AzVmssConfig do utworzenia obiektu konfiguracji zestawu skalowania maszyn wirtualnych i zapisuje wynik w zmiennej o nazwie $VMSS. Czwarte polecenie dodaje wpis tajny do zestawu skalowania maszyn wirtualnych przy użyciu wpisu tajnego magazynu przy użyciu identyfikatora zasobu klucza i certyfikatu magazynu przechowywanego w zmiennych $Vault i $CertConfig.

Parametry

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:por

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Właściwości parametru

Typ:IAzureContextContainer
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-SourceVaultId

Określa identyfikator zasobu Key Vault, który zawiera certyfikaty, które można dodać do maszyny wirtualnej. Ta wartość działa również jako klucz do dodawania wielu certyfikatów. Oznacza to, że można użyć tej samej wartości dla parametru SourceVaultId podczas dodawania wielu certyfikatów z tego samego Key Vault.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:1
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-VaultCertificate

Określa obiekt certyfikatu magazynu zawierający adres URL certyfikatu i nazwę certyfikatu. Aby utworzyć ten obiekt, możesz użyć polecenia cmdlet New-AzVmssVaultCertificateConfig .

Właściwości parametru

Typ:

VaultCertificate[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:2
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-VirtualMachineScaleSet

Określa obiekt VMSS. Aby utworzyć ten obiekt, możesz użyć polecenia cmdlet New-AzVmssConfig .

Właściwości parametru

Typ:PSVirtualMachineScaleSet
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:0
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Wi

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

PSVirtualMachineScaleSet

String

VaultCertificate

Dane wyjściowe

PSVirtualMachineScaleSet