Update-AzKeyVaultSecret

  • リファレンス
モジュール:
Az.KeyVault

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

構文

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

説明

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

例

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

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Nbf = (Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
$ContentType= 'xml'
Update-AzKeyVaultSecret -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: シークレットのタグとコンテンツ タイプを削除する

Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{}

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

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

$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False

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

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

$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType

最初の 3 つのコマンドでは、VaultName、Name、および ContentType パラメーターに使用する文字列変数を定義します。 4 番目のコマンドでは、Get-AzKeyVaultKey コマンドレットを使用して指定したキーを取得し、キーを Update-AzKeyVaultSecret コマンドレットにパイプしてコンテンツ タイプを 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:AzContext, 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

出力

PSKeyVaultSecret