Update-AzureKeyVaultSecret

リファレンス

モジュール:: AzureRM.KeyVault

キーコンテナー内のシークレットの属性を更新します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Update-AzureKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Update-AzureKeyVaultSecret コマンドレットは、キーコンテナー内のシークレットの編集可能な属性を更新します。

例

例 1: シークレットの属性を変更する

PS C:\> $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\> $Nbf = (Get-Date).ToUniversalTime()
PS C:\> $Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
PS C:\> $ContentType= 'xml'
PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru

Vault Name   : ContosoVault
Name         : HR
Version      : d476edfcd3544017a03bc49c1f3abec0
Id           : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0
Enabled      : True
Expires      : 5/25/2020 8:01:58 PM
Not Before   : 5/25/2018 8:02:02 PM
Created      : 4/11/2018 11:45:06 PM
Updated      : 5/25/2018 8:02:45 PM
Content Type : xml
Tags         : Name      Value
               Severity  medium
               HR        true

最初の 4 つのコマンドでは、有効期限、NotBefore 日付、タグ、コンテキスト型の属性を定義し、属性を変数に格納します。最後のコマンドは、格納されている変数を使用して、ContosoVault という名前のキーコンテナー内の HR という名前のシークレットの属性を変更します。

例 2: シークレットのタグとコンテンツタイプを削除する

PS C:\> Update-AzureKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag -@{}

このコマンドは、Contoso という名前のキーコンテナー内の HR という名前のシークレットの指定されたバージョンのタグとコンテンツタイプを削除します。

例 3: 名前が IT で始まるシークレットの現在のバージョンを無効にする

PS C:\> $Vault = 'ContosoVault'
PS C:\> $Prefix = 'IT'
PS C:\> Get-AzureKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzureKeyVaultSecret -Enable $False

最初のコマンドは、文字列値 Contoso を $Vault 変数に格納します。 2 番目のコマンドは、文字列値 IT を $Prefix 変数に格納します。 3 番目のコマンドでは、Get-AzureKeyVaultSecret コマンドレットを使用して、指定したキーコンテナー内のシークレットを取得し、それらのシークレットを Where-Object コマンドレットに渡します。 Where-Object コマンドレットは、文字 IT で始まる名前のシークレットをフィルター処理します。このコマンドは、フィルターに一致するシークレットを Update-AzureKeyVaultSecret コマンドレットにパイプし、無効にします。

例 4: シークレットのすべてのバージョンの ContentType を設定する

PS C:\> $VaultName = 'ContosoVault'
PS C:\> $Name = 'HR'
PS C:\> $ContentType = 'xml'
PS C:\> Get-AzureKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzureKeyVaultSecret -ContentType $ContentType

最初の 3 つのコマンドでは、VaultName、Name、および ContentType パラメーターに使用する文字列変数を定義します。 4 番目のコマンドでは、Get-AzureKeyVaultKey コマンドレットを使用して指定したキーを取得し、キーを Update-AzureKeyVaultSecret コマンドレットにパイプしてコンテンツタイプを XML に設定します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContentType

シークレットのコンテンツタイプ。指定しない場合、シークレットのコンテンツタイプの既存の値メイン変更されません。空の文字列を指定して、既存のコンテンツタイプの値を削除します。

Type:	String
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

-Enable

存在する場合は、値が true の場合はシークレットを有効にします。値が false の場合はシークレットを無効にします。指定しない場合、シークレットの有効/無効状態の既存の値メイン変更されません。

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Expires

シークレットの有効期限 (UTC 時刻)。指定しない場合、シークレットの有効期限の既存の値メイン変更されません。

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

シークレットオブジェクト

Type:	PSKeyVaultSecretIdentityItem
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

シークレット名。コマンドレットは、コンテナー名 (現在選択されている環境とシークレット名) からシークレットの FQDN を構築します。

Type:	String
Aliases:	SecretName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NotBefore

シークレットを使用できない UTC 時刻。指定しない場合、シークレットの NotBefore 属性の既存の値メイン変更されません。

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

コマンドレットは、既定ではオブジェクトを返しません。このスイッチが指定されている場合は、Secret オブジェクトを返します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

シークレットタグを表すハッシュテーブル。指定しない場合、シークレットの既存のタグメイン変更されません。空のハッシュテーブルを指定してタグを削除します。

Type:	Hashtable
Aliases:	Tags
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

コンテナー名。コマンドレットは、名前と現在選択されている環境に基づいて、コンテナーの FQDN を構築します。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Version

シークレットバージョン。コマンドレットは、コンテナー名、現在選択されている環境、シークレット名、シークレットバージョンからシークレットの FQDN を構築します。

Type:	String
Aliases:	SecretVersion
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSKeyVaultSecretIdentityItem

Parameters: InputObject (ByValue)

出力

PSKeyVaultSecret