Update-AzPolicyDefinition
Esta operação atualiza uma definição de política existente na assinatura ou grupo de gerenciamento com o nome fornecido.
Sintaxe
Name (Predefinição)
Update-AzPolicyDefinition
-Name <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SubscriptionId
Update-AzPolicyDefinition
-Name <String>
-SubscriptionId <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ManagementGroupName
Update-AzPolicyDefinition
-Name <String>
-ManagementGroupName <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Id
Update-AzPolicyDefinition
-Id <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzPolicyDefinition
-InputObject <IPolicyDefinition>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Esta operação atualiza uma definição de política existente na assinatura ou grupo de gerenciamento com o nome fornecido.
Exemplos
Exemplo 1: Atualizar a descrição de uma definição de política
$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition'
Update-AzPolicyDefinition -Id $PolicyDefinition.Id -Description 'Updated policy to not allow virtual machine creation'
O primeiro comando obtém uma definição de política chamada VMPolicyDefinition usando o cmdlet Get-AzPolicyDefinition.
O comando armazena esse objeto na variável $PolicyDefinition.
O segundo comando atualiza a descrição da definição de política identificada pela propriedade Id do $PolicyDefinition.
Exemplo 2: Atualizar o modo de uma definição de política
Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'
Este comando atualiza a definição de política chamada VMPolicyDefinition usando o cmdlet Update-AzPolicyDefinition para definir sua propriedade mode como 'All'.
Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'
Este comando atualiza os metadados de uma definição de política chamada VMPolicyDefinition para indicar que sua categoria é "Máquina Virtual".
Exemplo 3: [Backcompat] Atualizar o modo de uma definição de política
Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'
Este comando atualiza a definição de política chamada VMPolicyDefinition usando o alias de Set-AzPolicyDefinition do cmdlet Update-AzPolicyDefinition para definir sua propriedade mode como 'All'.
Parâmetros
-BackwardCompatible
Faz com que o cmdlet retorne artefatos usando o formato herdado colocando propriedades específicas da política em um objeto de pacote de propriedades.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: Cf.
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-DefaultProfile
O parâmetro DefaultProfile não é funcional.
Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.
Propriedades dos parâmetros
Tipo: PSObject
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: AzureRMContext, AzureCredential
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-Description
A descrição da definição da política.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-DisplayName
O nome para exibição da definição de política.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Id
O ID do recurso da definição de política a ser atualizada.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: ResourceId
Conjuntos de parâmetros
Id
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
Esta operação atualiza uma definição de política existente na assinatura ou grupo de gerenciamento com o nome fornecido.
Tipo: IPolicyDefinition
Default value: None Suporta carateres universais: False NãoMostrar: False
InputObject
Position: Named Obrigatório: True Valor do pipeline: True Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-ManagementGroupName
O ID do grupo de gestão.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
ManagementGroupName
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
Os metadados de definição de política.
Os metadados são um objeto aberto e normalmente são uma coleção de pares de valores de chave.
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Mode
O modo de definição de política.
Alguns exemplos são All, Indexed, Microsoft. KeyVault.Data.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Name
O nome da definição de política a ser atualizada.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: PolicyDefinitionName
Conjuntos de parâmetros
Name
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
SubscriptionId
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
ManagementGroupName
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-Parameter
As definições de parâmetros para parâmetros usados na regra de política.
As chaves são os nomes dos parâmetros.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: False
-Policy
A regra política.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-SubscriptionId
A ID da assinatura de destino.
Propriedades dos parâmetros
Tipo: String
Default value: None Suporta carateres universais: False NãoMostrar: False
Conjuntos de parâmetros
SubscriptionId
Position: Named Obrigatório: True Valor do pipeline: False Valor do pipeline por nome de propriedade: True Valor dos restantes argumentos: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None Suporta carateres universais: False NãoMostrar: False Aliases: Wi
Conjuntos de parâmetros
(All)
Position: Named Obrigatório: False Valor do pipeline: False Valor do pipeline por nome de propriedade: False Valor dos restantes argumentos: 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 .
Saídas
Notas
PSEUDÓNIMOS
Set-AzPolicyDefinition
