Microsoft.Authorization policySetDefinitions

Definición de recursos de Bicep

El tipo de recurso policySetDefinitions es un recurso de extensión, lo que significa que puede aplicarlo a otro recurso.

Use la scope propiedad de este recurso para establecer el ámbito de este recurso. Consulte Establecimiento del ámbito en los recursos de extensión en Bicep.

Los ámbitos de implementación válidos para el recurso policySetDefinitions son:

Puede hacer referencia a este tipo de recurso como un recurso de solo lectura en el nivel de: Inquilinos.

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Authorization/policySetDefinitions, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2021-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any()
    parameters: {}
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        groupNames: [
          'string'
        ]
        parameters: {}
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
  }
}

Valores de propiedades

policySetDefinitions

Nombre Descripción Value
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-128 nombre para mostrar

1-64 nombre de recurso

Caracteres válidos:
El nombre para mostrar puede contener cualquier carácter.

El nombre del recurso no puede usar:
<>*%&:\?.+/ ni caracteres de control.

No puede terminar con un punto ni un espacio.
scope Use al crear un recurso de extensión en un ámbito diferente al ámbito de implementación. Recurso de destino

Para Bicep, establezca esta propiedad en el nombre simbólico del recurso para aplicar el recurso de extensión.
properties Propiedades de definición de directiva. PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nombre Descripción Valor
description Descripción de la definición del conjunto de directivas. string
DisplayName Nombre para mostrar de la definición del conjunto de directivas. string
metadata Metadatos de definición del conjunto de directivas. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor. Para Bicep, puede usar la función any().
parámetros Parámetros de definición del conjunto de directivas que se pueden usar en las referencias de definición de directiva. object
policyDefinitionGroups Metadatos que describen grupos de referencias de definición de directiva dentro de la definición del conjunto de directivas. PolicyDefinitionGroup[]
policyDefinitions Matriz de referencias de definición de directiva. PolicyDefinitionReference[] (obligatorio)
policyType Tipo de definición de directiva. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Static'

PolicyDefinitionGroup

Nombre Descripción Valor
additionalMetadataId Identificador de recurso de un recurso que contiene metadatos adicionales sobre el grupo. string
category Categoría del grupo. string
description Descripción del grupo. string
DisplayName El nombre para mostrar del grupo. string
name Nombre del grupo. string (obligatorio)

PolicyDefinitionReference

Nombre Descripción Valor
groupNames Nombre de los grupos a los que pertenece esta referencia de definición de directiva. string[]
parámetros Los valores de parámetro de la regla de directiva a la que se hace referencia. Las claves son los nombres de parámetro. object
policyDefinitionId Identificador de la definición de directiva o definición del conjunto de directivas. string (obligatorio)
policyDefinitionReferenceId Identificador único (dentro de la definición del conjunto de directivas) para esta referencia de definición de directiva. string

Definición de recursos de plantilla de ARM

El tipo de recurso policySetDefinitions es un recurso de extensión, lo que significa que puede aplicarlo a otro recurso.

Use la scope propiedad de este recurso para establecer el ámbito de este recurso. Consulte Establecimiento del ámbito en los recursos de extensión en plantillas de ARM.

Los ámbitos de implementación válidos para el recurso policySetDefinitions son:

Puede hacer referencia a este tipo de recurso como un recurso de solo lectura en el nivel de: Inquilinos.

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Authorization/policySetDefinitions, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2021-06-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {},
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "groupNames": [ "string" ],
        "parameters": {},
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string"
  }
}

Valores de propiedades

policySetDefinitions

Nombre Descripción Value
type Tipo de recurso "Microsoft.Authorization/policySetDefinitions"
apiVersion La versión de la API de recursos '2021-06-01'
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-128 nombre para mostrar

1-64 nombre de recurso

Caracteres válidos:
El nombre para mostrar puede contener cualquier carácter.

El nombre del recurso no puede usar:
<>*%&:\?.+/ ni caracteres de control.

No puede terminar con un punto ni un espacio.
scope Use al crear un recurso de extensión en un ámbito diferente al ámbito de implementación. Recurso de destino

Para JSON, establezca el valor en el nombre completo del recurso al que se aplicará el recurso de extensión .
properties Propiedades de definición de directiva. PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nombre Descripción Valor
description Descripción de la definición del conjunto de directivas. string
DisplayName Nombre para mostrar de la definición del conjunto de directivas. string
metadata Metadatos de definición del conjunto de directivas. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor.
parámetros Parámetros de definición del conjunto de directivas que se pueden usar en las referencias de definición de directiva. object
policyDefinitionGroups Metadatos que describen grupos de referencias de definición de directiva dentro de la definición del conjunto de directivas. PolicyDefinitionGroup[]
policyDefinitions Matriz de referencias de definición de directiva. PolicyDefinitionReference[] (obligatorio)
policyType Tipo de definición de directiva. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Static'

PolicyDefinitionGroup

Nombre Descripción Valor
additionalMetadataId Identificador de recurso de un recurso que contiene metadatos adicionales sobre el grupo. string
category Categoría del grupo. string
description Descripción del grupo. string
DisplayName El nombre para mostrar del grupo. string
name Nombre del grupo. string (obligatorio)

PolicyDefinitionReference

Nombre Descripción Valor
groupNames Nombre de los grupos a los que pertenece esta referencia de definición de directiva. string[]
parámetros Los valores de parámetro de la regla de directiva a la que se hace referencia. Las claves son los nombres de parámetro. object
policyDefinitionId Identificador de la definición de directiva o definición del conjunto de directivas. string (obligatorio)
policyDefinitionReferenceId Identificador único (dentro de la definición del conjunto de directivas) para esta referencia de definición de directiva. string

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso policySetDefinitions es un recurso de extensión, lo que significa que puede aplicarlo a otro recurso.

Use la parent_id propiedad de este recurso para establecer el ámbito de este recurso.

Los ámbitos de implementación válidos para el recurso policySetDefinitions son:

  • Grupos de administración
  • Suscripciones

Puede hacer referencia a este tipo de recurso como un recurso de solo lectura en el nivel de: Inquilinos.

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Authorization/policySetDefinitions, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      parameters = {}
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          groupNames = [
            "string"
          ]
          parameters = {}
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
    }
  })
}

Valores de propiedades

policySetDefinitions

Nombre Descripción Value
type Tipo de recurso "Microsoft.Authorization/policySetDefinitions@2021-06-01"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-128 nombre para mostrar

1-64 nombre de recurso

Caracteres válidos:
El nombre para mostrar puede contener cualquier carácter.

El nombre del recurso no puede usar:
<>*%&:\?.+/ ni caracteres de control.

No puede terminar con un punto ni un espacio.
parent_id Identificador del recurso al que se va a aplicar este recurso de extensión. string (obligatorio)
properties Propiedades de definición de directiva. PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nombre Descripción Valor
description Descripción de la definición del conjunto de directivas. string
DisplayName Nombre para mostrar de la definición del conjunto de directivas. string
metadata Metadatos de definición del conjunto de directivas. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor.
parámetros Parámetros de definición del conjunto de directivas que se pueden usar en las referencias de definición de directiva. object
policyDefinitionGroups Metadatos que describen grupos de referencias de definición de directiva dentro de la definición del conjunto de directivas. PolicyDefinitionGroup[]
policyDefinitions Matriz de referencias de definición de directiva. PolicyDefinitionReference[] (obligatorio)
policyType Tipo de definición de directiva. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. "BuiltIn"
"Custom"
"NotSpecified"
"Estático"

PolicyDefinitionGroup

Nombre Descripción Valor
additionalMetadataId Identificador de recurso de un recurso que contiene metadatos adicionales sobre el grupo. string
category Categoría del grupo. string
description Descripción del grupo. string
DisplayName El nombre para mostrar del grupo. string
name Nombre del grupo. string (obligatorio)

PolicyDefinitionReference

Nombre Descripción Valor
groupNames Nombre de los grupos a los que pertenece esta referencia de definición de directiva. string[]
parámetros Valores de parámetro para la regla de directiva a la que se hace referencia. Las claves son los nombres de parámetro. object
policyDefinitionId Identificador de la definición de directiva o definición del conjunto de directivas. string (obligatorio)
policyDefinitionReferenceId Identificador único (dentro de la definición del conjunto de directivas) para esta referencia de definición de directiva. string