Set-AzKeyVaultSecret

키 자격 증명 모음에서 비밀을 만들거나 업데이트합니다.

Syntax

Set-AzKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzKeyVaultSecret
   [-InputObject] <PSKeyVaultSecretIdentityItem>
   [-SecretValue] <SecureString>
   [-Disable]
   [-Expires <DateTime>]
   [-NotBefore <DateTime>]
   [-ContentType <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Set-AzKeyVaultSecret cmdlet은 Azure Key Vault의 키 자격 증명 모음에서 비밀을 만들거나 업데이트합니다. 비밀이 없으면 이 cmdlet을 만듭니다. 비밀이 이미 있는 경우 이 cmdlet은 해당 비밀의 새 버전을 만듭니다.

예제

예제 1: 기본 특성을 사용하여 비밀 값 수정

$Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force
Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret

Vault Name   : Contoso
Name         : ITSecret
Version      : 8b5c0cb0326e4350bd78200fac932b51
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/8b5c0cb0326e4350bd78200fac932b51
Enabled      : True
Expires      :
Not Before   :
Created      : 5/25/2018 6:39:30 PM
Updated      : 5/25/2018 6:39:30 PM
Content Type :
Tags         :

첫 번째 명령은 ConvertTo-SecureString cmdlet을 사용하여 문자열을 보안 문자열로 변환한 다음 해당 문자열을 $Secret 변수에 저장합니다. 자세한 내용은 다음을 입력합니다 Get-Help ConvertTo-SecureString. 두 번째 명령은 Contoso라는 키 자격 증명 모음에서 ITSecret이라는 비밀의 값을 수정합니다. 비밀 값은 $Secret 저장된 값이 됩니다.

예제 2: 사용자 지정 특성을 사용하여 비밀 값 수정

$Secret = ConvertTo-SecureString -String 'Password' -AsPlainText -Force
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$NBF =(Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'IT' = 'true'}
$ContentType = 'txt'
Set-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -SecretValue $Secret -Expires $Expires -NotBefore $NBF -ContentType $ContentType -Disable -Tags $Tags

Vault Name   : Contoso
Name         : ITSecret
Version      : a2c150be3ea24dd6b8286986e6364851
Id           : https://contoso.vault.azure.net:443/secrets/ITSecret/a2c150be3ea24dd6b8286986e6364851
Enabled      : False
Expires      : 5/25/2020 6:40:00 PM
Not Before   : 5/25/2018 6:40:05 PM
Created      : 5/25/2018 6:41:22 PM
Updated      : 5/25/2018 6:41:22 PM
Content Type : txt
Tags         : Name      Value
               Severity  medium
               IT        true

첫 번째 명령은 ConvertTo-SecureString cmdlet을 사용하여 문자열을 보안 문자열로 변환한 다음 해당 문자열을 $Secret 변수에 저장합니다. 자세한 내용은 다음을 입력합니다 Get-Help ConvertTo-SecureString. 다음 명령은 만료 날짜, 태그 및 컨텍스트 형식에 대한 사용자 지정 특성을 정의하고 특성을 변수에 저장합니다. 마지막 명령은 이전에 변수로 지정된 값을 사용하여 Contoso라는 키 자격 증명 모음에서 ITSecret이라는 비밀의 값을 수정합니다.

예제 3: Microsoft.PowerShell.SecretManagement 모듈에서 Set-Secret 명령을 사용하여 Azure Key Vault에 비밀 만들기

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "Password" -AsPlainText -Force
Set-Secret -Name secureSecret -SecureStringSecret $secure -Vault AzKeyVault

None

다음은 모듈의 명령 Set-Secret 으로 Azure Key Vault test-kv 에 명명된 secureSecret 비밀을 설정하는 예제입니다Microsoft.PowerShell.SecretManagement.

매개 변수

-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

-Disable

이 cmdlet이 비밀을 사용하지 않도록 설정함을 나타냅니다.

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

-Expires

이 cmdlet이 업데이트하는 비밀에 대한 만료 시간을 DateTime 개체로 지정합니다. 이 매개 변수는 UTC(협정 세계시)를 사용합니다. DateTime 개체를 가져오려면 Get-Date cmdlet을 사용합니다. 자세한 내용은 다음을 입력합니다 Get-Help Get-Date.

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(정규화된 do기본 이름)을 생성합니다.

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

-NotBefore

비밀을 사용할 수 없는 DateTime 개체로 시간을 지정합니다. 이 매개 변수는 UTC를 사용합니다. DateTime 개체를 가져오려면 Get-Date cmdlet을 사용합니다.

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

-SecretValue

비밀의 값을 SecureString 개체로 지정합니다. SecureString 개체를 가져오려면 ConvertTo-SecureString cmdlet을 사용합니다. 자세한 내용은 다음을 입력합니다 Get-Help ConvertTo-SecureString.

Type:SecureString
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Tag

해시 테이블 형식의 키-값 쌍입니다. 예: @{key0="value0"; key1=$null; key2="value2"}

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

-WhatIf

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

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

입력

PSKeyVaultSecretIdentityItem

출력

PSKeyVaultSecret