Update-AzKeyVaultSecret

참조

모듈:: Az.KeyVault

키 자격 증명 모음에서 비밀의 특성을 업데이트.

Syntax

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>]

Description

Update-AzKeyVaultSecret cmdlet은 키 자격 증명 모음에 있는 비밀의 편집 가능한 특성을 업데이트합니다.

예제

예제 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

처음 네 개의 명령은 만료 날짜, 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 변수에 저장합니다. 두 번째 명령은 문자열 값 IT를 $Prefix 변수에 저장합니다. 세 번째 명령은 Get-AzKeyVaultSecret cmdlet을 사용하여 지정된 키 자격 증명 모음의 비밀을 가져와서 Where-Object cmdlet에 전달합니다. Where-Object cmdlet은 IT 문자로 시작하는 이름의 비밀을 필터링합니다. 이 명령은 필터와 일치하는 비밀을 Update-AzKeyVaultSecret cmdlet에 파이프하여 사용하지 않도록 설정합니다.

예제 4: 모든 버전의 비밀에 대한 ContentType 설정

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

처음 세 명령은 VaultName, Name 및 ContentType 매개 변수에 사용할 문자열 변수를 정의합니다. 네 번째 명령은 Get-AzKeyVaultKey cmdlet을 사용하여 지정된 키를 가져와서 Update-AzKeyVaultSecret cmdlet에 키를 파이프하여 해당 콘텐츠 형식을 XML로 설정합니다.

매개 변수

-Confirm

cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.

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

비밀 이름입니다. Cmdlet은 자격 증명 모음 이름, 현재 선택된 환경 및 비밀 이름에서 비밀의 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

Cmdlet은 기본적으로 개체를 반환하지 않습니다. 이 스위치를 지정하면 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

자격 증명 모음 이름. Cmdlet은 이름 및 현재 선택된 환경에 따라 자격 증명 모음의 FQDN을 생성합니다.

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

-Version

비밀 버전입니다. Cmdlet은 자격 증명 모음 이름, 현재 선택된 환경, 비밀 이름 및 비밀 버전에서 비밀의 FQDN을 생성합니다.

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

-WhatIf

cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다.

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

입력

PSKeyVaultSecretIdentityItem

출력

PSKeyVaultSecret

Share via