Get-AzPolicyDefinition

  • Referência
Módulo:
Az.Resources

Obtém definições de política.

Syntax

Get-AzPolicyDefinition
   [-Name <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-Name <String>]
   -ManagementGroupName <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-Name <String>]
   -SubscriptionId <Guid>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   -Id <String>
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-ManagementGroupName <String>]
   [-SubscriptionId <Guid>]
   [-Builtin]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzPolicyDefinition
   [-ManagementGroupName <String>]
   [-SubscriptionId <Guid>]
   [-Custom]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

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

Exemplos

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

Get-AzPolicyDefinition

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

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

Este 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

Este comando obtém todas as definições de política internas da assinatura com 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 para 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 -ExpandProperty properties | Select-Object -Property DisplayName, Description, PolicyType, Metadata | Format-List

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

Parâmetros

-ApiVersion

Especifica a versão da API do provedor de recursos a ser usada. Se você não especificar uma versão, esse cmdlet usará a versão mais recente disponível.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Builtin

Limita a lista de resultados apenas a definições de política internas.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Custom

Limita a lista de resultados apenas a definições de política personalizadas.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Especifica a ID de recurso totalmente qualificada para a definição de política obtida por esse cmdlet.

Type:String
Aliases:ResourceId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ManagementGroupName

O nome do grupo de gerenciamento da(s) definição(ões) de política a obter.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Especifica o nome da definição de política obtida por esse cmdlet.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Pre

Indica que esse cmdlet considera versões de API de pré-lançamento quando determina automaticamente qual versão usar.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

O ID de assinatura da(s) definição(ões) de política a obter.

Type:Nullable<T>[Guid]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Entradas

String

Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Saídas

PSObject