Compartir a través de

Get-AzPolicyDefinition

Módulo:
Az.Resources Module

Obtiene las definiciones del conjunto de directivas.

Sintaxis

Name (valor predeterminado) 

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

El cmdlet Get-AzPolicyDefinition obtiene una colección de definiciones de conjuntos de directivas o una definición de conjunto de directivas específica identificada por nombre o identificador.

Ejemplos

Ejemplo 1: Obtener todas las definiciones de directiva

Get-AzPolicyDefinition

Este comando obtiene todas las definiciones de directiva.

Ejemplo 2: Obtención de la definición de directiva de la suscripción actual por nombre

Get-AzPolicyDefinition -Name 'VMPolicyDefinition'

Este comando obtiene la definición de directiva denominada VMPolicyDefinition de la suscripción predeterminada actual.

Ejemplo 3: Obtención de la definición de directiva del grupo de administración por nombre

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

Este comando obtiene la definición de directiva denominada VMPolicyDefinition del grupo de administración denominado Dept42.

Ejemplo 4: Obtención de todas las definiciones de directivas integradas de la suscripción

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

Este comando obtiene todas las definiciones de directiva integradas de la suscripción con el identificador 3bf44b72-c631-427a-b8c8-53e2595398ca.

Ejemplo 5: Obtener definiciones de directiva de una categoría determinada

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

Este comando obtiene todas las definiciones de directiva de la categoría Etiquetas.

Ejemplo 6: Obtener el nombre para mostrar, la descripción, el tipo de directiva y los metadatos de todas las definiciones de directiva con formato de lista

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

Este comando es útil cuando necesita encontrar la propiedad DisplayName fácil de leer de una definición de Azure Policy. Puede analizar la propiedad Metadata para detectar el número de versión y la asignación de categoría de la definición de directiva.

Ejemplo 7: [Backcompat] Obtener el nombre para mostrar, la descripción, el tipo de directiva y los metadatos de todas las definiciones de directiva con formato de lista

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

Este comando es útil cuando necesita encontrar la propiedad DisplayName fácil de leer de una definición de Azure Policy. Puede analizar la propiedad Metadata para detectar el número de versión y la asignación de categoría de la definición de directiva.

Parámetros

-BackwardCompatible

Hace que el cmdlet devuelva artefactos mediante la colocación de propiedades específicas de la directiva en un objeto contenedor de propiedades.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Builtin

Hace que el cmdlet devuelva solo las definiciones de directiva integradas.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Builtin
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Custom

Hace que el cmdlet devuelva solo definiciones de directiva personalizadas.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Custom
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-DefaultProfile

Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.

Propiedades de parámetro

Tipo:PSObject
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:AzureRMContext, AzureCredential

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Id

Identificador completo de la definición de directiva que se va a obtener.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:ResourceId

Conjuntos de parámetros

Version
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False
ListVersion
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-ListVersion

Hace que el cmdlet devuelva solo definiciones de directiva personalizadas.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ListVersion
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-ManagementGroupName

El nombre del grupo de administración.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ManagementGroupName
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Name

Nombre de la definición de directiva que se va a obtener.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:PolicyDefinitionName

Conjuntos de parámetros

Name
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False
ManagementGroupName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False
SubscriptionId
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False
Version
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False
ListVersion
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Static

Hace que el cmdlet devuelva solo definiciones de directiva estáticas.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Static
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-SubscriptionId

Identificador de la suscripción de destino.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

SubscriptionId
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Version

La versión de definición de directiva en formato #.#.#

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:PolicyDefinitionVersion

Conjuntos de parámetros

Version
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

SwitchParameter

String

Salidas

IPolicyDefinition