Add-AzureRmVMSecret
仮想マシンにシークレットを追加します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Add-AzureRmVMSecret
[-VM] <PSVirtualMachine>
[[-SourceVaultId] <String>]
[[-CertificateStore] <String>]
[[-CertificateUrl] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Add-AzureRmVMSecret コマンドレットは、仮想マシンにシークレットを追加します。 この値を使用すると、仮想マシンに証明書を追加できます。 シークレットは Key Vault に格納する必要があります。 Key Vault の詳細については、Azure Key Vault の概要に関する記事を参照してください。 コマンドレットの詳細については、Microsoft Developer Network ライブラリまたは Set-AzureKeyVaultSecret コマンドレットの Azure Key Vault コマンドレットを参照してください。
例
例 1: 仮想マシンにシークレットを追加する
PS C:\> $VirtualMachine = New-AzureRmVMConfig -VMName "VirtualMachine07" -VMSize "Standard_A1" -AvailabilitySetID $AvailabilitySet.Id
PS C:\> $Credential = Get-Credential
PS C:\> $VirtualMachine = Set-AzureRmVMOperatingSystem -VM $VirtualMachine -Windows -ComputerName "Contoso26" -Credential $Credential
PS C:\> $SourceVaultId = "/subscriptions/46f8cea4-2de6-4179-8ab1-365da4211af4/resourceGroups/vault/providers/Microsoft.KeyVault/vaults/keyvault"
PS C:\> $CertificateStore01 = "My"
PS C:\> $CertificateUrl01 = "https://contosovault.vault.azure.net/secrets/514ceb769c984379a7e0230bdd703272"
PS C:\> $VirtualMachine = Add-AzureRmVMSecret -VM $VirtualMachine -SourceVaultId $SourceVaultId -CertificateStore $CertificateStore01 -CertificateUrl $CertificateUrl01最初のコマンドは、仮想マシン オブジェクトを作成し、それを $VirtualMachine 変数に格納します。
このコマンドは、仮想マシンに名前とサイズを割り当てます。
2 番目のコマンドは、Get-Credential コマンドレットを使用して資格情報オブジェクトを作成し、結果を $Credential 変数に格納します。
コマンドによって、ユーザー名とパスワードの入力が求められます。
詳細を表示するには「Get-Help Get-Credential」を入力します。
3 番目のコマンドでは、 Set-AzureRmVMOperatingSystem コマンドレットを使用して、$VirtualMachineに格納されている仮想マシンを構成します。
4 番目のコマンドは、後で使用するためにソース コンテナー ID を $SourceVaultId 変数に割り当てます。
このコマンドは、$SubscriptionId変数に適切な値があることを前提としています。
5 番目のコマンドは、後で使用するために $CertificateStore 01 変数に値を割り当てます。
6 番目のコマンドは、証明書ストアの URL を割り当てます。
7 番目のコマンドは、$VirtualMachineに格納されている仮想マシンにシークレットを追加します。
SourceVaultId パラメーターは、Key Vault を指定します。
このコマンドは、証明書ストアの名前と証明書の URL を指定します。
Add-AzureRmVMSecret を繰り返し実行して、他の証明書のシークレットを追加できます。
パラメーター
-CertificateStore
Windows オペレーティング システムを実行する仮想マシン上の証明書ストアの名前を指定します。 このコマンドレットは、このパラメーターが指定するストアに証明書を追加します。 このパラメーターは、Windows オペレーティング システムを実行する仮想マシンにのみ指定できます。
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CertificateUrl
証明書を含む Key Vault シークレットを指す URL を指定します。 証明書は、次の JavaScript Object Notation (JSON) オブジェクトの Base64 エンコードであり、UTF-8 でエンコードされます。 { "data": "<Base64-encoded-file>", "dataType": "<file-format>", "password": "<pfx-file-password>" } 現在、dataType は .pfx ファイルのみを受け入れます。
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Aliases: | Id |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VM
このコマンドレットが変更する仮想マシン オブジェクトを指定します。 仮想マシン オブジェクトを取得するには、Get-AzureRmVM コマンドレットを使用します。 New-AzureRmVMConfig コマンドレットを使用して、仮想マシン オブジェクトを作成できます。
| Type: | PSVirtualMachine |
| Aliases: | VMProfile |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |