Update-AzPolicyDefinition
Essa operação atualiza uma definição de política existente na assinatura ou grupo de gerenciamento fornecido com o nome fornecido.
Sintaxe
Name (Default)
Update-AzPolicyDefinition
-Name <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-Version <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SubscriptionId
Update-AzPolicyDefinition
-Name <String>
-SubscriptionId <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-Version <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ManagementGroupName
Update-AzPolicyDefinition
-Name <String>
-ManagementGroupName <String>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-Version <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Id
Update-AzPolicyDefinition
-Id <String>
[-DisplayName <String>]
[-Description <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzPolicyDefinition
-InputObject <IPolicyDefinition>
[-DisplayName <String>]
[-Description <String>]
[-Policy <String>]
[-Metadata <String>]
[-Parameter <String>]
[-Mode <String>]
[-ExternalEvaluationEnforcementSettingMissingTokenAction <String>]
[-ExternalEvaluationEnforcementSettingResultLifespan <String>]
[-ExternalEvaluationEnforcementSettingRoleDefinitionId <String[]>]
[-EndpointSettingKind <String>]
[-EndpointSettingDetail <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Essa operação atualiza uma definição de política existente na assinatura ou grupo de gerenciamento fornecido 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'
Esse comando atualiza a definição de política chamada VMPolicyDefinition usando o cmdlet Update-AzPolicyDefinition para definir sua propriedade de modo como 'All'.
Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'
Esse comando atualiza os metadados de uma definição de política chamada VMPolicyDefinition para indicar que sua categoria é "Máquina Virtual".
Exemplo 4: atualizar uma definição de política para adicionar uma versão mais antiga usando um arquivo de política
Update-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Version '1.1.0'
Esse comando atualiza a definição de política existente chamada LocationDefinition adicionando a versão 1.1.0 que contém a regra de política especificada em C:\LocationPolicy.js.
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
O parâmetro DefaultProfile não está funcional.
Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.
Propriedades do parâmetro
Tipo: PSObject
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: 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
-Description
A descrição da definição de política.
Propriedades do parâmetro
Tipo: String
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: True
Valor dos argumentos restantes: False
-DisplayName
O nome de exibição da definição de política.
Propriedades do parâmetro
Tipo: String
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: True
Valor dos argumentos restantes: False
-EndpointSettingDetail
Os detalhes do ponto de extremidade.
Propriedades do parâmetro
Tipo: String
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: True
Valor dos argumentos restantes: False
-EndpointSettingKind
O tipo de ponto de extremidade.
Propriedades do parâmetro
Tipo: String
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: True
Valor dos argumentos restantes: False
-ExternalEvaluationEnforcementSettingMissingTokenAction
O que fazer ao avaliar uma política de imposição que requer uma avaliação externa e o token está ausente.
Os valores possíveis são Auditoria e Negação e expressões de linguagem são compatíveis.
Propriedades do parâmetro
Tipo: String
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: True
Valor dos argumentos restantes: False
-ExternalEvaluationEnforcementSettingResultLifespan
O tempo de vida do resultado da invocação do ponto de extremidade após o qual ele não é mais válido.
Espera-se que o valor siga o formato de duração ISO 8601 e expressões de linguagem têm suporte.
Propriedades do parâmetro
Tipo: String
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: True
Valor dos argumentos restantes: False
-ExternalEvaluationEnforcementSettingRoleDefinitionId
Uma matriz das IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade.
Propriedades do parâmetro
Tipo: String [ ]
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: True
Valor dos argumentos restantes: False
-Id
A ID do recurso da definição de política a ser atualizada.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: ResourceId
Conjuntos de parâmetros
Id
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
Essa operação atualiza uma definição de política existente na assinatura ou grupo de gerenciamento fornecido com o nome fornecido.
InputObject
Cargo: Named
Obrigatório: True
Valor do pipeline: True
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ManagementGroupName
O ID do grupo de gerenciamento.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
ManagementGroupName
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
Os metadados de definição de política.
Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave.
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Mode
O modo de definição de política.
Alguns exemplos são All, Indexed, Microsoft.KeyVault.Data.
Propriedades do parâmetro
Tipo: String
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: True
Valor dos argumentos restantes: False
-Name
O nome da definição de política a ser atualizada.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: PolicyDefinitionName
Conjuntos de parâmetros
Name
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
SubscriptionId
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
ManagementGroupName
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Parameter
As definições de parâmetro para parâmetros usados na regra de política.
As chaves são os nomes dos parâmetros.
Propriedades do parâmetro
Tipo: String
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
-Policy
A regra de política.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
SubscriptionId
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
ManagementGroupName
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
InputObject
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-SubscriptionId
O ID da assinatura de destino.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
SubscriptionId
Cargo: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Version
A versão de definição de política no formato #.#.#.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: PolicyDefinitionVersion
Conjuntos de parâmetros
Name
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
SubscriptionId
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
ManagementGroupName
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
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 .
Saídas
Observações
ALIASES
Set-AzPolicyDefinition