Compartir a través de


Directiva Microsoft.AuthorizationSetDefinitions

Definición de recursos de Bicep

El tipo de recurso policySetDefinitions se puede implementar con operaciones destinadas a:

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

Formato de recurso

Para crear un recurso Microsoft.Authorization/policySetDefinitions, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2025-03-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    metadata: any(...)
    parameters: {
      {customized property}: {
        allowedValues: [
          any(...)
        ]
        defaultValue: any(...)
        metadata: {
          assignPermissions: bool
          description: 'string'
          displayName: 'string'
          strongType: 'string'
        }
        schema: any(...)
        type: 'string'
      }
    }
    policyDefinitionGroups: [
      {
        additionalMetadataId: 'string'
        category: 'string'
        description: 'string'
        displayName: 'string'
        name: 'string'
      }
    ]
    policyDefinitions: [
      {
        definitionVersion: 'string'
        groupNames: [
          'string'
        ]
        parameters: {
          {customized property}: {
            value: any(...)
          }
        }
        policyDefinitionId: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    policyType: 'string'
    version: 'string'
    versions: [
      'string'
    ]
  }
}

Valores de propiedad

Microsoft.Authorization/policySetDefinitions

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Patrón = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obligatorio)
Propiedades Propiedades de definición del conjunto de directivas. policySetDefinitionProperties
scope Use al crear un recurso en un ámbito diferente del ámbito de implementación. Establezca esta propiedad en el nombre simbólico de un recurso para aplicar el recurso de extensión .

ParameterDefinitions

Nombre Descripción Valor

ParameterDefinitionsValue

Nombre Descripción Valor
valores permitidos Valores permitidos para el parámetro . any[]
defaultValue Valor predeterminado del parámetro si no se proporciona ningún valor. cualquier
metadatos Metadatos generales para el parámetro . ParameterDefinitionsValueMetadata
esquema Proporciona validación de entradas de parámetro durante la asignación mediante un esquema JSON autodefinido. Esta propiedad solo se admite para los parámetros de tipo de objeto y sigue la implementación del esquema de Json.NET 2019-09. Puede obtener más información sobre el uso de esquemas en https://json-schema.org/ y probar esquemas de borrador en https://www.jsonschemavalidator.net/. cualquier
tipo Tipo de datos del parámetro. 'Matriz'
'Boolean'
'DateTime'
'Float'
'Entero'
'Object'
'String'

ParameterDefinitionsValueMetadata

Nombre Descripción Valor
assignPermissions Establézcalo en true para que Azure Portal cree asignaciones de roles en el identificador de recurso o el valor de ámbito de recurso de este parámetro durante la asignación de directivas. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación. Bool
descripción Descripción del parámetro . cuerda
Nombre para mostrar Nombre para mostrar del parámetro. cuerda
strongType Se usa al asignar la definición de directiva a través del portal. Proporciona una lista con reconocimiento de contexto de valores entre los que el usuario puede elegir. cuerda

ParameterValues

Nombre Descripción Valor

ParameterValuesValue

Nombre Descripción Valor
valor Valor del parámetro . cualquier

PolicyDefinitionGroup

Nombre Descripción Valor
additionalMetadataId Identificador de recurso de un recurso que contiene metadatos adicionales sobre el grupo. cuerda
categoría Categoría del grupo. cuerda
descripción Descripción del grupo. cuerda
Nombre para mostrar Nombre para mostrar del grupo. cuerda
nombre Nombre del grupo. string (obligatorio)

PolicyDefinitionReference

Nombre Descripción Valor
definitionVersion Versión de la definición de directiva que se va a usar. cuerda
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. ParameterValues de
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. cuerda

PolicySetDefinitionProperties

Nombre Descripción Valor
descripción Descripción de la definición del conjunto de directivas. cuerda
Nombre para mostrar Nombre para mostrar de la definición del conjunto de directivas. cuerda
metadatos Metadatos de definición del conjunto de directivas. Los metadatos son un objeto terminado abierto y normalmente es una colección de pares clave-valor. cualquier
Parámetros Los parámetros de definición del conjunto de directivas que se pueden usar en las referencias de definición de directiva. ParameterDefinitions
policyDefinitionGroups Metadatos que describen grupos de referencias de definición de directiva dentro de la definición del conjunto de directivas. PolicyDefinitionGroup[]
definiciones de políticas Matriz de referencias de definición de directiva. PolicyDefinitionReference[] (obligatorio)
policyType Tipo de definición del conjunto de directivas. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Static'
Versión La versión de definición del conjunto de directivas en formato #.#.# cuerda
Versiones Lista de versiones disponibles para esta definición de conjunto de directivas. string[]

Definición de recursos de plantilla de ARM

El tipo de recurso policySetDefinitions se puede implementar con operaciones destinadas a:

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

Formato de recurso

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

{
  "type": "Microsoft.Authorization/policySetDefinitions",
  "apiVersion": "2025-03-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "metadata": {},
    "parameters": {
      "{customized property}": {
        "allowedValues": [ {} ],
        "defaultValue": {},
        "metadata": {
          "assignPermissions": "bool",
          "description": "string",
          "displayName": "string",
          "strongType": "string"
        },
        "schema": {},
        "type": "string"
      }
    },
    "policyDefinitionGroups": [
      {
        "additionalMetadataId": "string",
        "category": "string",
        "description": "string",
        "displayName": "string",
        "name": "string"
      }
    ],
    "policyDefinitions": [
      {
        "definitionVersion": "string",
        "groupNames": [ "string" ],
        "parameters": {
          "{customized property}": {
            "value": {}
          }
        },
        "policyDefinitionId": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "policyType": "string",
    "version": "string",
    "versions": [ "string" ]
  }
}

Valores de propiedad

Microsoft.Authorization/policySetDefinitions

Nombre Descripción Valor
apiVersion La versión de api '2025-03-01'
nombre El nombre del recurso cuerda

Restricciones:
Patrón = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obligatorio)
Propiedades Propiedades de definición del conjunto de directivas. policySetDefinitionProperties
tipo El tipo de recurso 'Microsoft.Authorization/policySetDefinitions'

ParameterDefinitions

Nombre Descripción Valor

ParameterDefinitionsValue

Nombre Descripción Valor
valores permitidos Valores permitidos para el parámetro . any[]
defaultValue Valor predeterminado del parámetro si no se proporciona ningún valor. cualquier
metadatos Metadatos generales para el parámetro . ParameterDefinitionsValueMetadata
esquema Proporciona validación de entradas de parámetro durante la asignación mediante un esquema JSON autodefinido. Esta propiedad solo se admite para los parámetros de tipo de objeto y sigue la implementación del esquema de Json.NET 2019-09. Puede obtener más información sobre el uso de esquemas en https://json-schema.org/ y probar esquemas de borrador en https://www.jsonschemavalidator.net/. cualquier
tipo Tipo de datos del parámetro. 'Matriz'
'Boolean'
'DateTime'
'Float'
'Entero'
'Object'
'String'

ParameterDefinitionsValueMetadata

Nombre Descripción Valor
assignPermissions Establézcalo en true para que Azure Portal cree asignaciones de roles en el identificador de recurso o el valor de ámbito de recurso de este parámetro durante la asignación de directivas. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación. Bool
descripción Descripción del parámetro . cuerda
Nombre para mostrar Nombre para mostrar del parámetro. cuerda
strongType Se usa al asignar la definición de directiva a través del portal. Proporciona una lista con reconocimiento de contexto de valores entre los que el usuario puede elegir. cuerda

ParameterValues

Nombre Descripción Valor

ParameterValuesValue

Nombre Descripción Valor
valor Valor del parámetro . cualquier

PolicyDefinitionGroup

Nombre Descripción Valor
additionalMetadataId Identificador de recurso de un recurso que contiene metadatos adicionales sobre el grupo. cuerda
categoría Categoría del grupo. cuerda
descripción Descripción del grupo. cuerda
Nombre para mostrar Nombre para mostrar del grupo. cuerda
nombre Nombre del grupo. string (obligatorio)

PolicyDefinitionReference

Nombre Descripción Valor
definitionVersion Versión de la definición de directiva que se va a usar. cuerda
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. ParameterValues de
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. cuerda

PolicySetDefinitionProperties

Nombre Descripción Valor
descripción Descripción de la definición del conjunto de directivas. cuerda
Nombre para mostrar Nombre para mostrar de la definición del conjunto de directivas. cuerda
metadatos Metadatos de definición del conjunto de directivas. Los metadatos son un objeto terminado abierto y normalmente es una colección de pares clave-valor. cualquier
Parámetros Los parámetros de definición del conjunto de directivas que se pueden usar en las referencias de definición de directiva. ParameterDefinitions
policyDefinitionGroups Metadatos que describen grupos de referencias de definición de directiva dentro de la definición del conjunto de directivas. PolicyDefinitionGroup[]
definiciones de políticas Matriz de referencias de definición de directiva. PolicyDefinitionReference[] (obligatorio)
policyType Tipo de definición del conjunto de directivas. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Static'
Versión La versión de definición del conjunto de directivas en formato #.#.# cuerda
Versiones Lista de versiones disponibles para esta definición de conjunto de directivas. string[]

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso policySetDefinitions se puede implementar con operaciones destinadas a:

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policySetDefinitions@2025-03-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      metadata = ?
      parameters = {
        {customized property} = {
          allowedValues = [
            ?
          ]
          defaultValue = ?
          metadata = {
            assignPermissions = bool
            description = "string"
            displayName = "string"
            strongType = "string"
          }
          schema = ?
          type = "string"
        }
      }
      policyDefinitionGroups = [
        {
          additionalMetadataId = "string"
          category = "string"
          description = "string"
          displayName = "string"
          name = "string"
        }
      ]
      policyDefinitions = [
        {
          definitionVersion = "string"
          groupNames = [
            "string"
          ]
          parameters = {
            {customized property} = {
              value = ?
            }
          }
          policyDefinitionId = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      policyType = "string"
      version = "string"
      versions = [
        "string"
      ]
    }
  }
}

Valores de propiedad

Microsoft.Authorization/policySetDefinitions

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Patrón = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obligatorio)
parent_id Identificador del recurso al que se va a aplicar este recurso de extensión. string (obligatorio)
Propiedades Propiedades de definición del conjunto de directivas. policySetDefinitionProperties
tipo El tipo de recurso "Microsoft.Authorization/policySetDefinitions@2025-03-01"

ParameterDefinitions

Nombre Descripción Valor

ParameterDefinitionsValue

Nombre Descripción Valor
valores permitidos Valores permitidos para el parámetro . any[]
defaultValue Valor predeterminado del parámetro si no se proporciona ningún valor. cualquier
metadatos Metadatos generales para el parámetro . ParameterDefinitionsValueMetadata
esquema Proporciona validación de entradas de parámetro durante la asignación mediante un esquema JSON autodefinido. Esta propiedad solo se admite para los parámetros de tipo de objeto y sigue la implementación del esquema de Json.NET 2019-09. Puede obtener más información sobre el uso de esquemas en https://json-schema.org/ y probar esquemas de borrador en https://www.jsonschemavalidator.net/. cualquier
tipo Tipo de datos del parámetro. 'Matriz'
'Boolean'
'DateTime'
'Float'
'Entero'
'Object'
'String'

ParameterDefinitionsValueMetadata

Nombre Descripción Valor
assignPermissions Establézcalo en true para que Azure Portal cree asignaciones de roles en el identificador de recurso o el valor de ámbito de recurso de este parámetro durante la asignación de directivas. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación. Bool
descripción Descripción del parámetro . cuerda
Nombre para mostrar Nombre para mostrar del parámetro. cuerda
strongType Se usa al asignar la definición de directiva a través del portal. Proporciona una lista con reconocimiento de contexto de valores entre los que el usuario puede elegir. cuerda

ParameterValues

Nombre Descripción Valor

ParameterValuesValue

Nombre Descripción Valor
valor Valor del parámetro . cualquier

PolicyDefinitionGroup

Nombre Descripción Valor
additionalMetadataId Identificador de recurso de un recurso que contiene metadatos adicionales sobre el grupo. cuerda
categoría Categoría del grupo. cuerda
descripción Descripción del grupo. cuerda
Nombre para mostrar Nombre para mostrar del grupo. cuerda
nombre Nombre del grupo. string (obligatorio)

PolicyDefinitionReference

Nombre Descripción Valor
definitionVersion Versión de la definición de directiva que se va a usar. cuerda
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. ParameterValues de
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. cuerda

PolicySetDefinitionProperties

Nombre Descripción Valor
descripción Descripción de la definición del conjunto de directivas. cuerda
Nombre para mostrar Nombre para mostrar de la definición del conjunto de directivas. cuerda
metadatos Metadatos de definición del conjunto de directivas. Los metadatos son un objeto terminado abierto y normalmente es una colección de pares clave-valor. cualquier
Parámetros Los parámetros de definición del conjunto de directivas que se pueden usar en las referencias de definición de directiva. ParameterDefinitions
policyDefinitionGroups Metadatos que describen grupos de referencias de definición de directiva dentro de la definición del conjunto de directivas. PolicyDefinitionGroup[]
definiciones de políticas Matriz de referencias de definición de directiva. PolicyDefinitionReference[] (obligatorio)
policyType Tipo de definición del conjunto de directivas. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. 'BuiltIn'
'Personalizado'
'NotSpecified'
'Static'
Versión La versión de definición del conjunto de directivas en formato #.#.# cuerda
Versiones Lista de versiones disponibles para esta definición de conjunto de directivas. string[]

Ejemplos de uso

Ejemplos de Terraform

Un ejemplo básico de implementación de la definición de conjunto de directivas.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

data "azapi_client_config" "current" {}

resource "azapi_resource" "policyDefinition" {
  type      = "Microsoft.Authorization/policyDefinitions@2021-06-01"
  parent_id = "/subscriptions/${data.azurerm_client_config.current.subscription_id}"
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      displayName = "my-policy-definition"
      mode        = "All"
      parameters = {
        allowedLocations = {
          metadata = {
            description = "The list of allowed locations for resources."
            displayName = "Allowed locations"
            strongType  = "location"
          }
          type = "Array"
        }
      }
      policyRule = {
        if = {
          not = {
            field = "location"
            in    = "[parameters('allowedLocations')]"
          }
        }
        then = {
          effect = "audit"
        }
      }
      policyType = "Custom"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "policySetDefinition" {
  type      = "Microsoft.Authorization/policySetDefinitions@2025-01-01"
  parent_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}"
  name      = "acctestpolset-${var.resource_name}"
  body = {
    properties = {
      description = ""
      displayName = "acctestpolset-${var.resource_name}"
      parameters = {
        allowedLocations = {
          metadata = {
            description = "The list of allowed locations for resources."
            displayName = "Allowed locations"
            strongType  = "location"
          }
          type = "Array"
        }
      }
      policyDefinitions = [{
        groupNames = []
        parameters = {
          listOfAllowedLocations = {
            value = "[parameters('allowedLocations')]"
          }
        }
        policyDefinitionId          = azapi_resource.policyDefinition.id
        policyDefinitionReferenceId = ""
      }]
      policyType = "Custom"
    }
  }
}