Add-AzureRmVmssSecret
VMSS にシークレットを追加します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Add-AzureRmVmssSecret
[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>
[[-SourceVaultId] <String>]
[[-VaultCertificate] <VaultCertificate[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Add-AzureRmVmssSecret コマンドレットは、仮想マシン スケール セット (VMSS) にシークレットを追加します。 シークレットは Azure Key Vault に格納する必要があります。 Key Vault に関する詳細については、「Azure Key Vaulthttps://azure.microsoft.com/en-us/documentation/articles/key-vault-whatis/ とは()」を参照してください。 コマンドレットの詳細については、Microsoft Developer Network ライブラリまたは Set-AzureKeyVaultSecret コマンドレットの Azure Key Vault コマンドレットを参照してください。
例
例 1: VMSS にシークレットを追加する
PS C:\> $Vault = Get-AzureRmKeyVault -VaultName "ContosoVault"
PS C:\> $CertConfig = New-AzureRmVmssVaultCertificateConfig -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion" -CertificateStore "Certificates"
PS C:\> $VMSS = New-AzureRmVmssConfig
PS C:\> Add-AzureRmVmssSecret -VirtualMachineScaleSet $VMSS -SourceVaultId $Vault.ResourceId -VaultCertificate $CertConfigこの例では、VMSS にシークレットを追加します。 最初のコマンドでは、Get-AzureRmKeyVault コマンドレットを使用して ContosoVault という名前のコンテナーからコンテナー シークレットを取得し、結果を $Vault という名前の変数に格納します。 2 番目の コマンドでは、New-AzureRmVmssVaultCertificateConfig コマンドレットを使用して、証明書という名前の証明書ストアから指定された証明書 URL を使用して Key Vault 証明書構成を作成し、結果を $CertConfig という名前の変数に格納します。 3 番目のコマンドでは、 New-AzureRmVmssConfig コマンドレットを使用して VMSS 構成オブジェクトを作成し、結果を $VMSS という名前の変数に格納します。 4 番目のコマンドは、キー リソース ID と、$Vaultおよび$CertConfig変数に格納されているコンテナー証明書を使用して、コンテナー シークレットを使用して VMSS にシークレットを追加します。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourceVaultId
仮想マシンに追加できる証明書を含む Key Vault のリソース ID を指定します。 この値は、複数の証明書を追加するためのキーとしても機能します。 つまり、同じ Key Vault から複数の証明書を 追加するときに、SourceVaultId パラメーターに同じ値を使用できます。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VaultCertificate
証明書の URL と証明書名を含むコンテナー証明書オブジェクトを指定します。 New-AzureRmVmssVaultCertificateConfig コマンドレットを使用して、このオブジェクトを作成できます。
| Type: | VaultCertificate[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualMachineScaleSet
VMSS オブジェクトを指定します。 New-AzureRmVmssConfig コマンドレットを使用して、このオブジェクトを作成できます。
| Type: | PSVirtualMachineScaleSet |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |