Update-AzPolicyDefinition

Referência

Módulo:: Az.Resources

Essa operação atualiza uma definição de política existente na assinatura ou no grupo de gerenciamento fornecido com o nome fornecido.

Sintaxe

Update-AzPolicyDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      -InputObject <IPolicyDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Essa operação atualiza uma definição de política existente na assinatura ou no 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.ResourceId -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 ResourceId de $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 mode como 'All'.

Exemplo 3: Atualizar os metadados de uma definição de política

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 3: [Backcompat] Atualizar o modo de uma definição de política

Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

Esse comando atualiza a definição de política chamada VMPolicyDefinition usando o alias 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 recipiente de propriedades.

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Confirm

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

Tipo:	SwitchParameter
Aliases:	cf
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	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.

Tipo:	PSObject
Aliases:	AzureRMContext, AzureCredential
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Description

A descrição da definição de política.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-DisplayName

O nome de exibição da definição de política.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Id

A ID do recurso da definição de política a ser atualizada.

Tipo:	String
Aliases:	ResourceId
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-InputObject

Tipo:	IPolicyDefinition
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-ManagementGroupName

A ID do grupo de gerenciamento.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Metadata

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-chave.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Mode

O modo de definição de política. Alguns exemplos são Todos, Indexado, Microsoft.KeyVault.Data.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Name

O nome da definição de política a ser atualizada.

Tipo:	String
Aliases:	PolicyDefinitionName
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	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.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Policy

A regra da política.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-SubscriptionId

A ID da assinatura de destino.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-WhatIf

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

Tipo:	SwitchParameter
Aliases:	wi
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Entradas

IPolicyDefinition

String

Saídas