Get-AzPolicyDefinition

Módulo:

Az.Resources

Obtém definições de conjunto de políticas.

Sintaxe

Get-AzPolicyDefinition
   [-Name <String>]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   [-Name <String>]
   -ManagementGroupName <String>
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   [-Name <String>]
   -SubscriptionId <String>
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   [-Name <String>]
   [-Id <String>]
   [-BackwardCompatible]
   -Version <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   [-Name <String>]
   [-Id <String>]
   [-ListVersion]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   -Id <String>
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   [-SubscriptionId <String>]
   [-ManagementGroupName <String>]
   [-Builtin]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   [-SubscriptionId <String>]
   [-ManagementGroupName <String>]
   [-Custom]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPolicyDefinition
   [-SubscriptionId <String>]
   [-ManagementGroupName <String>]
   [-Static]
   [-BackwardCompatible]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

O cmdlet Get-AzPolicyDefinition obtém uma coleção de definições de conjunto de políticas ou uma definição de conjunto de políticas específica identificada por nome ou ID.

Exemplos

Exemplo 1: Obter todas as definições de política

Get-AzPolicyDefinition

Esse comando obtém todas as definições de política.

Exemplo 2: Obter definição de política da assinatura atual por nome

Get-AzPolicyDefinition -Name 'VMPolicyDefinition'

Esse comando obtém a definição de política chamada VMPolicyDefinition da assinatura padrão atual.

Exemplo 3: Obter definição de política do grupo de gerenciamento por nome

Get-AzPolicyDefinition -Name 'VMPolicyDefinition' -ManagementGroupName 'Dept42'

Esse comando obtém a definição de política chamada VMPolicyDefinition do grupo de gerenciamento chamado Dept42.

Exemplo 4: Obter todas as definições de política internas da assinatura

Get-AzPolicyDefinition -SubscriptionId '3bf44b72-c631-427a-b8c8-53e2595398ca' -Builtin

Esse comando obtém todas as definições de política internas da assinatura com a ID 3bf44b72-c631-427a-b8c8-53e2595398ca.

Exemplo 5: Obter definições de política de uma determinada categoria

Get-AzPolicyDefinition | Where-Object {$_.Properties.metadata.category -eq 'Tags'}

Este comando obtém todas as definições de política na categoria Tags.

Exemplo 6: Obter o nome de exibição, a descrição, o tipo de política e os metadados de todas as definições de política formatadas como uma lista

Get-AzPolicyDefinition | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

Esse comando é útil quando você precisa encontrar a propriedade DisplayName amigável de uma definição do Azure Policy. Você pode analisar a propriedade Metadata para descobrir o número de versão e a atribuição de categoria da definição de política.

Exemplo 7: [Backcompat] Obtenha o nome de exibição, a descrição, o tipo de política e os metadados de todas as definições de política formatadas como uma lista

Get-AzPolicyDefinition -BackwardCompatible | Select-Object -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

Esse comando é útil quando você precisa encontrar a propriedade DisplayName amigável de uma definição do Azure Policy. Você pode analisar a propriedade Metadata para descobrir o número de versão e a atribuição de categoria da definição de política.

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

-Builtin

Faz com que o cmdlet retorne apenas definições de política internas.

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

-Custom

Faz com que o cmdlet retorne apenas definições de política personalizadas.

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

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

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

-Id

A ID completa da definição de política a ser obtida.

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

-ListVersion

Faz com que o cmdlet retorne apenas definições de política personalizadas.

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

-ManagementGroupName

O nome 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

-Name

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

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

-Static

Faz com que o cmdlet retorne apenas definições de política estática.

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
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

-Version

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

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

Entradas

SwitchParameter

String

Saídas

IPolicyDefinition