Update-AzKeyVaultKey

Modul:

Az.KeyVault Module

Memperbarui atribut kunci dalam brankas kunci.

Sintaks

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

Deskripsi

Cmdlet Update-AzKeyVaultKey memperbarui atribut kunci yang dapat diedit dalam brankas kunci.

Contoh

Contoh 1: Ubah kunci untuk mengaktifkannya, dan atur tanggal kedaluwarsa dan tag

$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

Perintah pertama membuat objek DateTime dengan menggunakan cmdlet Get-Date . Objek itu menentukan waktu dua tahun di masa depan. Perintah menyimpan tanggal tersebut dalam variabel $Expires. Untuk informasi selengkapnya, ketik Get-Help Get-Date. Perintah kedua membuat variabel untuk menyimpan nilai tag dengan tingkat keparahan tinggi dan Akuntansi. Perintah akhir memodifikasi kunci bernama ITSoftware. Perintah mengaktifkan kunci, mengatur waktu kedaluwarsanya ke waktu yang disimpan di $Expires, dan mengatur tag yang disimpan di $Tags.

Contoh 2: Mengubah kunci untuk menghapus semua tag

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           :

Perintah ini menghapus semua tag untuk versi kunci tertentu bernama ITSoftware.

Parameter

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	Cf

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan Azure.

Properti parameter

Jenis:	IAzureContextContainer
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	AzContext, AzureRmContext, AzureCredential

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Enable

Nilai true memungkinkan kunci dan nilai false menonaktifkan kunci. Jika tidak ditentukan, status diaktifkan/dinonaktifkan yang ada tetap tidak berubah.

Properti parameter

Jenis:	Nullable<T>[Boolean]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Expires

Waktu kedaluwarsa kunci dalam waktu UTC. Jika tidak ditentukan, waktu kedaluwarsa kunci yang ada tetap tidak berubah. Perhatikan bahwa kedaluwarsa diabaikan untuk Kunci Pertukaran Kunci yang digunakan dalam proses BYOK.

Properti parameter

Jenis:	Nullable<T>[DateTime]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-HsmName

Nama HSM. Cmdlet membangun FQDN dari HSM terkelola berdasarkan nama dan lingkungan yang saat ini dipilih.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

HsmInteractive

Position:	Named
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Immutable

Menetapkan kebijakan rilis sebagai status tidak dapat diubah. Setelah ditandai tidak dapat diubah, bendera ini tidak dapat diatur ulang dan kebijakan tidak dapat diubah dalam keadaan apa pun.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

HsmInteractive

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-InputObject

Objek kunci

Properti parameter

Jenis:	PSKeyVaultKeyIdentityItem
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

InputObject

Position:	0
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-KeyOps

Operasi yang dapat dilakukan dengan kunci. Jika tidak ditentukan, operasi kunci kunci yang ada dari kunci tetap tidak berubah.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Name

Nama kunci. Cmdlet membangun FQDN kunci dari nama vault, lingkungan dan nama kunci yang saat ini dipilih.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	Nama Kunci

Kumpulan parameter

Default

Position:	1
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

HsmInteractive

Position:	1
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-NotBefore

Waktu UTC sebelum kunci mana yang tidak dapat digunakan. Jika tidak ditentukan, atribut NotBefore yang ada dari kunci tetap tidak berubah.

Properti parameter

Jenis:	Nullable<T>[DateTime]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-PassThru

Cmdlet tidak mengembalikan objek secara default. Jika sakelar ini ditentukan, mengembalikan objek bundel kunci yang diperbarui.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ReleasePolicyPath

Jalur ke file yang berisi definisi kebijakan JSON. Aturan kebijakan tempat kunci dapat diekspor.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

HsmInteractive

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Tag

Hashtable mewakili tag kunci. Jika tidak ditentukan, tag kunci yang ada tetap tidak berubah.

Properti parameter

Jenis:	Hashtable
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	Tagar

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-VaultName

Nama vault. Cmdlet membangun FQDN vault berdasarkan nama dan lingkungan yang saat ini dipilih.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

Default

Position:	0
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Version

Versi kunci. Cmdlet membangun FQDN kunci dari nama vault, lingkungan yang saat ini dipilih, nama kunci, dan versi kunci.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	KeyVersion

Kumpulan parameter

(All)

Position:	2
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	wi

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

PSKeyVaultKeyIdentityItem

Output

PSKeyVaultKey