Freigeben über

Add-AzVmssSecret

Modul:
Az.Compute Module

Fügt einem VMSS einen geheimen Schlüssel hinzu.

Syntax

Default (Standard) 

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

Beschreibung

Das Add-AzVmssSecret-Cmdlet fügt dem Vm Scale Set (VMSS) einen geheimen Schlüssel hinzu. Der geheime Schlüssel muss in einem Azure Key Vault gespeichert werden. Weitere Informationen zu Key Vault finden Sie unter Was ist Azure Key Vault? (https://learn.microsoft.com/azure/key-vault/general/basic-concepts). Weitere Informationen zu den Cmdlets finden Sie unter Azure Key Vault Cmdlets oder das Cmdlet Set-AzKeyVaultSecret .

Beispiele

Beispiel 1: Hinzufügen eines geheimen Schlüssels zum VMSS mithilfe der Azure Key Vault-Erweiterung für virtuelle Computer

# 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

Um Zertifikate auf einem virtuellen Computer zu installieren, empfiehlt es sich, die erweiterung des virtuellen Azure Key Vault-Computers für Linux oder die erweiterung des virtuellen Azure Key Vault-Computers für Windowszu verwenden.

Beispiel 2: Hinzufügen eines geheimen Schlüssels zum VMSS mithilfe von 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

In diesem Beispiel wird der VMSS ein Geheimnis hinzugefügt. Der erste Befehl verwendet das Cmdlet Get-AzKeyVault, um einen Tresorschlüssel aus dem Tresor namens ContosoVault abzurufen und das Ergebnis in der Variablen namens $Vault zu speichern. Der zweite Befehl verwendet das Cmdlet New-AzVmssVaultCertificateConfig , um eine Key Vault-Zertifikatkonfiguration mithilfe der angegebenen Zertifikat-URL aus dem Zertifikatspeicher namens "Zertifikate" zu erstellen und die Ergebnisse in der Variablen namens $CertConfig zu speichern. Der dritte Befehl verwendet das Cmdlet New-AzVmssConfig zum Erstellen eines VMSS-Konfigurationsobjekts und speichert das Ergebnis in der Variablen namens $VMSS. Mit dem vierten Befehl wird dem VMSS mithilfe der Schlüsselressourcen-ID und des Tresorzertifikats, das in den variablen $Vault und $CertConfig gespeichert ist, ein Geheimnis hinzugefügt.

Parameter

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:vgl

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Parametereigenschaften

Typ:IAzureContextContainer
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:AzContext, AzureRmContext, AzureCredential

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-SourceVaultId

Gibt die Ressourcen-ID des Key Vault an, die die Zertifikate enthält, die Sie dem virtuellen Computer hinzufügen können. Dieser Wert fungiert auch als Schlüssel zum Hinzufügen mehrerer Zertifikate. Dies bedeutet, dass Sie denselben Wert für den SourceVaultId-Parameter verwenden können, wenn Sie mehrere Zertifikate aus demselben Key Vault hinzufügen.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-VaultCertificate

Gibt das Vault-Zertifikatobjekt an, das die Zertifikat-URL und den Zertifikatnamen enthält. Sie können das Cmdlet New-AzVmssVaultCertificateConfig verwenden, um dieses Objekt zu erstellen.

Parametereigenschaften

Typ:

VaultCertificate[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:2
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-VirtualMachineScaleSet

Gibt das VMSS-Objekt an. Sie können das Cmdlet New-AzVmssConfig verwenden, um dieses Objekt zu erstellen.

Parametereigenschaften

Typ:PSVirtualMachineScaleSet
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:0
Obligatorisch:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

PSVirtualMachineScaleSet

String

VaultCertificate

Ausgaben

PSVirtualMachineScaleSet