Update-AzPolicySetDefinition
Essa operação atualiza uma definição de conjunto de políticas existente na assinatura ou grupo de gerenciamento fornecido com o nome fornecido.
Sintaxe
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 grupo de gerenciamento fornecido com o nome fornecido.
Exemplos
Exemplo 1: atualizar a descrição de uma definição de conjunto de políticas
$PolicySetDefinition = Get-AzPolicySetDefinition -Id '/subscriptions/mySub/Microsoft.Authorization/policySetDefinitions/myPSSetDefinition'
Update-AzPolicySetDefinition -Id $PolicySetDefinition.Id -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 identificada pela propriedade de ID de $PolicySetDefinition.
Exemplo 2: atualizar os metadados de uma definição de conjunto de políticas
Update-AzPolicySetDefinition -Name 'VMPolicySetDefinition' -Metadata '{"category":"Virtual Machine"}'
Esse 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" }]'
Esse 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
Esse 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"}'
Esse 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 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 a 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 do conjunto de políticas.
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 do conjunto de políticas.
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: | IPolicySetDefinition |
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 do conjunto de políticas. Metadados é um objeto aberto e normalmente é uma coleção de pares de valores de chave.
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 do conjunto de políticas a ser atualizada.
Tipo: | String |
Aliases: | PolicySetDefinitionName |
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 no conjunto de políticas. 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: | True |
Aceitar caracteres curinga: | False |
-PolicyDefinition
A matriz de definição de política no formulário de cadeia de caracteres JSON.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | 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 NOTES para propriedades POLICYDEFINITIONGROUP e crie uma tabela de hash.
Tipo: | String |
Aliases: | GroupDefinition |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
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
Saídas
Observações
ALIASES
Set-AzPolicySetDefinition