通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

说明

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 对象。 该对象指定未来两年的时间。 该命令将该日期存储在$Expires变量中。 有关详细信息，请键入 Get-Help Get-Date。 第二个命令创建一个变量来存储高严重性和会计的标记值。 最后一个命令修改名为 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
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Enable

如果值为 true，则启用键，值为 false 会禁用该键。 如果未指定，则现有启用/禁用状态保持不变。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Expires

密钥的过期时间（UTC 时间）。 如果未指定，则密钥的现有过期时间保持不变。 请注意，BYOK 过程中使用的密钥 Exchange 密钥将忽略过期。

参数属性

类型:

Nullable<T>[DateTime]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-HsmName

HSM 名称。 Cmdlet 基于名称和当前所选环境构造托管 HSM 的 FQDN。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

HsmInteractive
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Immutable

将发布策略设置为不可变状态。 标记为不可变后，无法重置此标志，并且在任何情况下都无法更改策略。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

HsmInteractive
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-InputObject

Key 对象

参数属性

类型:PSKeyVaultKeyIdentityItem
默认值:None
支持通配符:False
不显示:False

参数集

InputObject
Position:0
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-KeyOps

可以使用密钥执行的作。 如果未指定，则密钥的现有密钥作保持不变。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Name

密钥名称。 Cmdlet 从保管库名称（当前选定的环境和密钥名称）构造密钥的 FQDN。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:键名

参数集

Default
Position:1
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
HsmInteractive
Position:1
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-NotBefore

无法使用密钥的 UTC 时间。 如果未指定，则密钥的现有 NotBefore 属性保持不变。

参数属性

类型:

Nullable<T>[DateTime]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-PassThru

默认情况下，Cmdlet 不返回对象。 如果指定了此开关，则返回更新后的密钥捆绑对象。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ReleasePolicyPath

包含 JSON 策略定义的文件的路径。 可在其中导出密钥的策略规则。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

HsmInteractive
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Tag

哈希表表示键标记。 如果未指定，则密钥的现有标记保持不变。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False
别名:标记

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-VaultName

保管库名称。 Cmdlet 基于名称和当前所选环境构造保管库的 FQDN。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

Default
Position:0
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Version

密钥版本。 Cmdlet 从保管库名称（当前选定的环境、密钥名称和密钥版本）构造密钥的 FQDN。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:KeyVersion

参数集

(All)
Position:2
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示: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