Compartilhar via

Get-AzPolicyDefinition

Módulo:
Az.Resources Module

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

Sintaxe

Name (Default) 

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

ManagementGroupName 

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

SubscriptionId 

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

Version 

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

ListVersion 

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

Id 

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

Builtin 

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

Custom 

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

Static 

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

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

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 do leitor de uma definição do Azure Policy. Você pode analisar a propriedade Metadados para descobrir o número de versão e a atribuição de categoria da definição de política.

Exemplo 7: [Backcompat] 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 -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 do leitor de uma definição do Azure Policy. Você pode analisar a propriedade Metadados 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.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Builtin

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Builtin
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Custom

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Custom
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades do parâmetro

Tipo:PSObject
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Id

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:ResourceId

Conjuntos de parâmetros

Version
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ListVersion
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ListVersion

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ListVersion
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ManagementGroupName

O nome do grupo de gerenciamento.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ManagementGroupName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Name

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:PolicyDefinitionName

Conjuntos de parâmetros

Name
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ManagementGroupName
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
SubscriptionId
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
Version
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False
ListVersion
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Static

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Static
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SubscriptionId

A ID da assinatura de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SubscriptionId
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Version

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:PolicyDefinitionVersion

Conjuntos de parâmetros

Version
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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

SwitchParameter

String

Saídas

IPolicyDefinition