Compartilhar via


Update-AzKeyVaultSetting

Atualize a configuração específica associada ao HSM gerenciado.

Sintaxe

UpdateSettingViaFlattenValues (Default)

Update-AzKeyVaultSetting
    [-HsmName] <String>
    [-Name] <String>
    [-Value] <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateSettingViaInputObject

Update-AzKeyVaultSetting
    [[-HsmName] <String>]
    [[-Value] <String>]
    [-InputObject] <PSKeyVaultSetting>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateSettingViaHsmObject

Update-AzKeyVaultSetting
    [-Name] <String>
    [-Value] <String>
    [-HsmObject] <PSManagedHsm>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateSettingViaHsmId

Update-AzKeyVaultSetting
    [-Name] <String>
    [-Value] <String>
    [-HsmId] <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O cmdlet Update-AzKeyVaultSetting atualiza as configurações da conta do cofre de chaves. Esse cmdlet atualiza uma configuração de conta específica do cofre de chaves.

Exemplos

Exemplo 1: atualizar uma configuração de conta específica do cofre de chaves

Update-AzKeyVaultSetting -HsmName testmhsm -Name AllowKeyManagementOperationsThroughARM -Value true -PassThru
Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm

Atualize uma configuração de conta específica do cofre de chaves nomeada AllowKeyManagementOperationsThroughARM em um Hsm Gerenciado chamado testmhsm.

Exemplo 2: atualizar uma configuração de conta específica do cofre de chaves igual a outra configuração de conta

$setting = Get-AzKeyVaultSetting -HsmName testmhsm1 -Name AllowKeyManagementOperationsThroughARM
$setting | Update-AzKeyVaultSetting -HsmName testmhsm2 -PassThru
Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm2

Atualize uma configuração de conta específica do cofre de chaves nomeada AllowKeyManagementOperationsThroughARM em um Hsm Gerenciado com o mesmo nometestmhsm2.testmhsm1

Exemplo 3: Atualizar uma configuração de conta específica do cofre de chaves por meio de HsmObject

$hsmObject = Get-AzKeyVaultManagedHsm -Name testmhsm
Update-AzKeyVaultSetting -HsmObject $hsmObject -Name AllowKeyManagementOperationsThroughARM -Value true -PassThru
Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm

Atualize uma configuração de conta específica do cofre de chaves nomeada AllowKeyManagementOperationsThroughARM em um Hsm Gerenciado nomeado testmhsm por meio de HsmObject.

Exemplo 4: Atualizar uma configuração de conta específica do cofre de chaves por meio do HsmId

$hsmObject = Get-AzKeyVaultManagedHsm -Name testmhsm
Update-AzKeyVaultSetting -HsmId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/managedHSMs/testmhsm-Name AllowKeyManagementOperationsThroughARM -Value true -PassThru
Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm

Atualize uma configuração de conta específica do cofre de chaves nomeada AllowKeyManagementOperationsThroughARM em um Hsm Gerenciado nomeado testmhsm por meio de HsmObject.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com Azure.

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HsmId

ID do recurso Hsm.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateSettingViaHsmId
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HsmName

Nome do HSM.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateSettingViaFlattenValues
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HsmObject

Objeto Hsm.

Propriedades do parâmetro

Tipo:PSManagedHsm
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateSettingViaHsmObject
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

O local do cofre excluído.

Propriedades do parâmetro

Tipo:PSKeyVaultSetting
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateSettingViaInputObject
Cargo:1
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

Nome da configuração.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateSettingViaFlattenValues
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
UpdateSettingViaHsmObject
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
UpdateSettingViaHsmId
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

O cmdlet não retorna o objeto por padrão. Se essa opção for especificada, retorne o objeto Secret.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Value

Valor da configuração.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateSettingViaFlattenValues
Cargo:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
UpdateSettingViaHsmObject
Cargo:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
UpdateSettingViaHsmId
Cargo:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSKeyVaultSetting

PSManagedHsm

Saídas

PSKeyVaultSetting