다음을 통해 공유

Update-AzKeyVaultKey

모듈:
Az.KeyVault Module

키 자격 증명 모음에서 키의 특성을 업데이트합니다.

구문

Default (기본값) 

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

HsmInteractive 

Update-AzKeyVaultKey
    [-Name] <String>
    [[-Version] <String>]
    -HsmName <String>
    [-Enable <Boolean>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-KeyOps <String[]>]
    [-Immutable]
    [-ReleasePolicyPath <String>]
    [-Tag <Hashtable>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObject 

Update-AzKeyVaultKey
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    [[-Version] <String>]
    [-Enable <Boolean>]
    [-Expires <DateTime>]
    [-NotBefore <DateTime>]
    [-KeyOps <String[]>]
    [-Tag <Hashtable>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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

예제

예제 1: 키를 수정하여 사용하도록 설정하고 만료 날짜 및 태그 설정

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags           : Name        Value
                 Severity    high
                 Accounting  true

첫 번째 명령은 Get-Date cmdlet을 사용하여 DateTime 개체를 만듭니다. 이 개체는 2년 후의 시간을 지정합니다. 명령은 해당 날짜를 $Expires 변수에 저장합니다. 자세한 내용은 Get-Help Get-Date입력합니다. 두 번째 명령은 높은 심각도 및 Accounting의 태그 값을 저장하는 변수를 만듭니다. 마지막 명령은 ITSoftware라는 키를 수정합니다. 이 명령은 키를 사용하도록 설정하고, 만료 시간을 $Expires 저장된 시간으로 설정하고, $Tags 저장된 태그를 설정합니다.

예제 2: 모든 태그를 삭제하도록 키 수정

Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}

Vault Name     : Contoso
Name           : ITSoftware
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        : 5/25/2020 7:58:07 PM
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags           :

이 명령은 ITSoftware라는 키의 특정 버전에 대한 모든 태그를 삭제합니다.

매개 변수

-Confirm

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

매개 변수 속성

형식:SwitchParameter
Default value:None
와일드카드 지원:False
DontShow:False
별칭:cf(cf)

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-DefaultProfile

Azure와의 통신에 사용되는 자격 증명, 계정, 테넌트 및 구독입니다.

매개 변수 속성

형식:IAzureContextContainer
Default value:None
와일드카드 지원:False
DontShow:False
별칭:AzContext, AzureRmContext, AzureCredential

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Enable

true 값은 키를 사용하도록 설정하고 false 값은 키를 사용하지 않도록 설정합니다. 지정하지 않으면 기존 사용/사용 안 함 상태는 변경되지 않은 상태로 유지됩니다.

매개 변수 속성

형식:

Nullable<T>[Boolean]

Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Expires

키의 만료 시간(UTC 시간)입니다. 지정하지 않으면 키의 기존 만료 시간은 변경되지 않은 상태로 유지됩니다. BYOK 프로세스에서 사용되는 키 Exchange 키에 대해서는 만료가 무시됩니다.

매개 변수 속성

형식:

Nullable<T>[DateTime]

Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-HsmName

HSM 이름입니다. Cmdlet은 이름 및 현재 선택된 환경에 따라 관리되는 HSM의 FQDN을 생성합니다.

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

HsmInteractive
Position:Named
필수:True
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Immutable

릴리스 정책을 변경할 수 없는 상태로 설정합니다. 변경할 수 없는 것으로 표시되면 이 플래그를 다시 설정할 수 없으며 어떤 상황에서도 정책을 변경할 수 없습니다.

매개 변수 속성

형식:SwitchParameter
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

HsmInteractive
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-InputObject

Key 개체

매개 변수 속성

형식:PSKeyVaultKeyIdentityItem
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

InputObject
Position:0
필수:True
파이프라인의 값:True
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-KeyOps

키를 사용하여 수행할 수 있는 작업입니다. 지정하지 않으면 키의 기존 키 작업은 변경되지 않은 상태로 유지됩니다.

매개 변수 속성

형식:

String[]

Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Name

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

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False
별칭:KeyName

매개 변수 집합

Default
Position:1
필수:True
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False
HsmInteractive
Position:1
필수:True
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-NotBefore

키를 사용할 수 없는 UTC 시간입니다. 지정하지 않으면 키의 기존 NotBefore 특성은 변경되지 않은 상태로 유지됩니다.

매개 변수 속성

형식:

Nullable<T>[DateTime]

Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-PassThru

Cmdlet은 기본적으로 개체를 반환하지 않습니다. 이 스위치를 지정하면 업데이트된 키 번들 개체를 반환합니다.

매개 변수 속성

형식:SwitchParameter
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-ReleasePolicyPath

JSON 정책 정의를 포함하는 파일의 경로입니다. 키를 내보낼 수 있는 정책 규칙입니다.

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

HsmInteractive
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Tag

해시 테이블은 키 태그를 나타냅니다. 지정하지 않으면 키의 기존 태그는 변경되지 않은 상태로 유지됩니다.

매개 변수 속성

형식:Hashtable
Default value:None
와일드카드 지원:False
DontShow:False
별칭:태그들

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-VaultName

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

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

Default
Position:0
필수:True
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Version

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

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False
별칭:키버전

매개 변수 집합

(All)
Position:2
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-WhatIf

cmdlet이 실행되면 어떻게 되는지 보여 주세요. cmdlet이 실행되지 않습니다.

매개 변수 속성

형식:SwitchParameter
Default value:None
와일드카드 지원:False
DontShow:False
별칭:위스콘신

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

CommonParameters

이 cmdlet은 일반적인 매개 변수인 -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction 및 -WarningVariable 매개 변수를 지원합니다. 자세한 내용은 about_CommonParameters를 참조하세요.

입력

PSKeyVaultKeyIdentityItem

출력

PSKeyVaultKey