Update-AzPolicyDefinition

Módulo:
Az.Resources Module

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>]
    [-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>]

InputObject 

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>]

Descrição

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

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

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 4: Atualize uma definição de política para adicionar uma versão mais antiga usando um ficheiro de política

Update-AzPolicyDefinition -Name 'LocationDefinition' -Policy C:\LocationPolicy.json -Version '1.1.0'

Este 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.jsseguintes.

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-EndpointSettingDetail

Os detalhes do ponto de extremidade.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-EndpointSettingKind

O tipo de ponto final.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-ExternalEvaluationEnforcementSettingMissingTokenAction

O que fazer ao avaliar uma política de aplicação que requer uma avaliação externa e o token está faltando. Os valores possíveis são Audit e Deny e expressões de linguagem são suportadas.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos: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 as expressões de idioma são suportadas.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-ExternalEvaluationEnforcementSettingRoleDefinitionId

Uma matriz dos IDs de definição de função que o MSI da atribuição precisará para invocar o ponto de extremidade.

Propriedades dos parâmetros

Tipo:

String[]

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:ResourceId

Conjuntos de parâmetros

Id
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-InputObject

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

Propriedades dos parâmetros

Tipo:IPolicyDefinition
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

InputObject
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ManagementGroupName
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos: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 de chave.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:PolicyDefinitionName

Conjuntos de parâmetros

Name
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
SubscriptionId
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
ManagementGroupName
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto: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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

Name
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
SubscriptionId
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
ManagementGroupName
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
InputObject
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-SubscriptionId

O ID da assinatura de destino.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

SubscriptionId
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Version

A versão de definição de política no formato #.#.#.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:PolicyDefinitionVersion

Conjuntos de parâmetros

Name
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
SubscriptionId
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False
ManagementGroupName
Posto:Named
Obrigatório:False
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
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Posto: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.

Entradas

IPolicyDefinition

String

String

Saídas

IPolicyDefinition

Notas

PSEUDÓNIMOS

Set-AzPolicyDefinition