Update-AzPolicyDefinition

Referencia

Módulo:: Az.Resources

Esta operación actualiza una definición de directiva existente en la suscripción o el grupo de administración especificados con el nombre especificado.

Sintaxis

Update-AzPolicyDefinition
      -Name <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -SubscriptionId <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Name <String>
      -ManagementGroupName <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      -Id <String>
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzPolicyDefinition
      [-DisplayName <String>]
      [-Description <String>]
      [-Policy <String>]
      [-Metadata <String>]
      [-Parameter <String>]
      [-Mode <String>]
      [-BackwardCompatible]
      -InputObject <IPolicyDefinition>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Esta operación actualiza una definición de directiva existente en la suscripción o el grupo de administración especificados con el nombre especificado.

Ejemplos

Ejemplo 1: Actualización de la descripción de una definición de directiva

$PolicyDefinition = Get-AzPolicyDefinition -Name 'VMPolicyDefinition'
Update-AzPolicyDefinition -Id $PolicyDefinition.ResourceId -Description 'Updated policy to not allow virtual machine creation'

El primer comando obtiene una definición de directiva denominada VMPolicyDefinition mediante el cmdlet Get-AzPolicyDefinition. El comando almacena ese objeto en la variable $PolicyDefinition. El segundo comando actualiza la descripción de la definición de directiva identificada por la propiedad resourceId de de $PolicyDefinition.

Ejemplo 2: Actualización del modo de una definición de directiva

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

Este comando actualiza la definición de directiva denominada VMPolicyDefinition mediante el cmdlet Update-AzPolicyDefinition para establecer su propiedad de modo en "All".

Ejemplo 3: Actualización de los metadatos de una definición de directiva

Update-AzPolicyDefinition -Name 'VMPolicyDefinition' -Metadata '{"category":"Virtual Machine"}'

Este comando actualiza los metadatos de una definición de directiva denominada VMPolicyDefinition para indicar que su categoría es "Máquina virtual".

Ejemplo 3: [Backcompat] Actualizar el modo de una definición de directiva

Set-AzPolicyDefinition -Name 'VMPolicyDefinition' -Mode 'All'

Este comando actualiza la definición de directiva denominada VMPolicyDefinition mediante el alias Set-AzPolicyDefinition del cmdlet Update-AzPolicyDefinition para establecer su propiedad mode en "All".

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.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Tipo:	SwitchParameter
Alias:	cf
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-DefaultProfile

El parámetro DefaultProfile no es funcional. Use el parámetro SubscriptionId cuando esté disponible si ejecuta el cmdlet en otra suscripción.

Tipo:	PSObject
Alias:	AzureRMContext, AzureCredential
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Description

Descripción de la definición de directiva.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-DisplayName

Nombre para mostrar de la definición de directiva.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-Id

Identificador de recurso de la definición de directiva que se va a actualizar.

Tipo:	String
Alias:	ResourceId
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-InputObject

Tipo:	IPolicyDefinition
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-ManagementGroupName

Identificador del grupo de administración.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-Metadata

Metadatos de definición de directiva. Los metadatos son un objeto terminado abierto y normalmente es una colección de pares clave-valor.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-Mode

Modo de definición de directiva. Algunos ejemplos son All, Indexed, Microsoft.KeyVault.Data.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-Name

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

Tipo:	String
Alias:	PolicyDefinitionName
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-Parameter

Definiciones de parámetros para los parámetros usados en la regla de directiva. Las claves son los nombres de parámetro.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Policy

Regla de directiva.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-SubscriptionId

Identificador de la suscripción de destino.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Tipo:	SwitchParameter
Alias:	wi
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

Entradas

IPolicyDefinition

String

Salidas