Get-AzPolicyDefinition

  • Referencia
Módulo:
Az.Resources

Obtiene definiciones de directiva.

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

El cmdlet Get-AzPolicyDefinition obtiene una colección de definiciones de directiva o una definición de directiva 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 -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

-ApiVersion

Especifica la versión de la API del proveedor de recursos que se va a usar. Si no especifica una versión, este cmdlet usa la versión más reciente disponible.

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

-Builtin

Limita la lista de resultados solo a las definiciones de directiva integradas.

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

-Custom

Limita la lista de resultados a solo definiciones de directivas personalizadas.

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

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure

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

-Id

Especifica el identificador de recurso completo para la definición de directiva que obtiene este cmdlet.

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

-ManagementGroupName

Nombre del grupo de administración de las definiciones de directiva que se van a obtener.

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

-Name

Especifica el nombre de la definición de directiva que obtiene este cmdlet.

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

-Pre

Indica que este cmdlet considera las versiones de API de versión preliminar cuando determina automáticamente qué versión se va a usar.

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

-SubscriptionId

Identificador de suscripción de las definiciones de directiva que se van a obtener.

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

Salidas

PSObject