Compartilhar via


Update-AzPolicySetDefinition

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

Syntax

Update-AzPolicySetDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzPolicySetDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-PolicyDefinition <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-PolicyDefinitionGroup <String>]
      [-BackwardCompatible]
      -InputObject <IPolicySetDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

Exemplos

Exemplo 1: Atualizar a descrição de uma definição de conjunto de políticas

$PolicySetDefinition = Get-AzPolicySetDefinition -ResourceId '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Update-AzPolicySetDefinition -Id $PolicySetDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

O primeiro comando obtém uma definição de conjunto de políticas usando o cmdlet Get-AzPolicySetDefinition. O comando armazena esse objeto na variável $PolicySetDefinition. O segundo comando atualiza a descrição da definição do conjunto de políticas identificado pela propriedade ResourceId de $PolicySetDefinition.

Exemplo 2: Atualizar os metadados de uma definição de conjunto de políticas

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

Este comando atualiza os metadados de uma definição de conjunto de políticas chamada VMPolicySetDefinition para indicar que sua categoria é "Máquina Virtual".

Exemplo 3: Atualizar os grupos de uma definição de conjunto de políticas

Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition '[{ "name": "group1", "displayName": "Virtual Machine Security" }, { "name": "group2" }]'

Este comando atualiza os grupos de uma definição de conjunto de políticas chamada VMPolicySetDefinition.

Exemplo 4: Atualizar os grupos de uma definição de conjunto de políticas usando uma tabela de hash

$groupsJson = ConvertTo-Json @{ name = "group1"; displayName = "Virtual Machine Security" }, @{ name = "group2" }
Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -GroupDefinition $groupsJson

Este comando atualiza os grupos de uma definição de conjunto de políticas chamada VMPolicySetDefinition de uma tabela de hash.

Exemplo 5: [Backcompat] Atualizar os metadados de uma definição de conjunto de políticas

Set-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'

Este comando atualiza os metadados de uma definição de conjunto de políticas chamada VMPolicySetDefinition para indicar que sua categoria é "Máquina Virtual".

Parâmetros

-BackwardCompatible

Faz com que o cmdlet retorne artefatos usando o formato herdado colocando propriedades específicas da política em um objeto do pacote de propriedades.

Tipo:SwitchParameter
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:False
Accept wildcard characters: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
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

A descrição da definição do conjunto de políticas.

Tipo:String
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:True
Accept wildcard characters:False

-DisplayName

O nome para exibição da definição do conjunto de políticas.

Tipo:String
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

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

Tipo:String
Aliases:ResourceId
Position:Named
valor padrão:None
Obrigatório:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Tipo:IPolicySetDefinition
Position:Named
valor padrão:None
Obrigatório:True
Accept pipeline input:True
Accept wildcard characters:False

-ManagementGroupName

A ID do grupo de gerenciamento.

Tipo:String
Position:Named
valor padrão:None
Obrigatório:True
Accept pipeline input:True
Accept wildcard characters:False

-Metadata

Os metadados de definição do conjunto de políticas. Os metadados são um objeto aberto e normalmente são uma coleção de pares de valores de chave.

Tipo:String
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

O nome da definição do conjunto de políticas a ser atualizado.

Tipo:String
Aliases:PolicySetDefinitionName
Position:Named
valor padrão:None
Obrigatório:True
Accept pipeline input:True
Accept wildcard characters:False

-Parameter

As definições de parâmetros para parâmetros usados no conjunto de políticas. As chaves são os nomes dos parâmetros.

Tipo:String
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:True
Accept wildcard characters:False

-PolicyDefinition

A matriz de definição de política no formato de cadeia de caracteres JSON.

Tipo:String
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:False
Accept wildcard characters:False

-PolicyDefinitionGroup

Os metadados que descrevem grupos de referências de definição de política dentro da definição do conjunto de políticas. Para construir, consulte a seção NOTAS para propriedades POLICYDEFINITIONGROUP e crie uma tabela de hash.

Tipo:String
Aliases:GroupDefinition
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

A ID da assinatura de destino.

Tipo:String
Position:Named
valor padrão:None
Obrigatório:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor padrão:None
Obrigatório:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

IPolicySetDefinition

String

Saídas

IPolicySetDefinition

Observações

ALIASES

Set-AzPolicySetDefinition