Microsoft.Authorization policySetDefinitions 2020-09-01
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.
El tipo de recurso policySetDefinitions se puede implementar con operaciones destinadas a:
- Grupos de administración: consulte comandos de implementación de grupos de administración.
- Suscripciones: consulte los comandos de implementación de 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 bicep a la plantilla.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2020-09-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any()
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
}
}
Valores de propiedad
policySetDefinitions
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: nombre para mostrar de 1 a 128 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. | ParameterDefinitions |
| 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' |
ParameterDefinitions
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Nombre | Descripción | Valor |
|---|---|---|
| allowedValues | Valores permitidos para el parámetro . | any[] |
| defaultValue | Valor predeterminado del parámetro si no se proporciona ningún valor. | Para Bicep, puede usar la función any(). |
| metadata | Metadatos generales para el parámetro . | ParameterDefinitionsValueMetadata |
| tipo | El 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 directiva. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación. | bool |
| description | La descripción del parámetro. | string |
| DisplayName | Nombre para mostrar del parámetro . | string |
| 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 debe elegir. | string |
| {propiedad personalizada} | Para Bicep, puede usar la función any(). |
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. | ParameterValues |
| 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 |
ParameterValues
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterValuesValuesValue |
ParameterValuesValuesValue
| Nombre | Descripción | Valor |
|---|---|---|
| value | Valor del parámetro. | Para Bicep, puede usar la función any(). |
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.
El tipo de recurso policySetDefinitions se puede implementar con operaciones destinadas a:
- Grupos de administración: consulte comandos de implementación de grupos de administración.
- Suscripciones: consulte los comandos de implementación de 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 json a la plantilla.
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2020-09-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"type": "string"
}
},
"policyDefinitionGroups": [
{
"additionalMetadataId": "string",
"category": "string",
"description": "string",
"displayName": "string",
"name": "string"
}
],
"policyDefinitions": [
{
"groupNames": [ "string" ],
"parameters": {
"{customized property}": {
"value": {}
}
},
"policyDefinitionId": "string",
"policyDefinitionReferenceId": "string"
}
],
"policyType": "string"
}
}
Valores de propiedad
policySetDefinitions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | 'Microsoft.Authorization/policySetDefinitions' |
| apiVersion | La versión de la API de recursos | '2020-09-01' |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: nombre para mostrar de 1 a 128 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 del ámbito de implementación. | Recurso de destino En JSON, establezca el valor en el nombre completo del recurso al que se va a 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. | ParameterDefinitions |
| 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' |
ParameterDefinitions
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Nombre | Descripción | Valor |
|---|---|---|
| allowedValues | Valores permitidos para el parámetro . | any[] |
| defaultValue | Valor predeterminado del parámetro si no se proporciona ningún valor. | |
| metadata | Metadatos generales para el parámetro . | ParameterDefinitionsValueMetadata |
| tipo | El 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 directiva. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación. | bool |
| description | La descripción del parámetro. | string |
| DisplayName | Nombre para mostrar del parámetro . | string |
| 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 debe elegir. | string |
| {propiedad personalizada} |
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. | ParameterValues |
| 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 |
ParameterValues
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterValuesValue |
ParameterValuesValue
| Nombre | Descripción | Valor |
|---|---|---|
| value | Valor del parámetro. |
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.
El tipo de recurso policySetDefinitions se puede implementar con operaciones destinadas a:
- 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@2020-09-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyDefinitionGroups = [
{
additionalMetadataId = "string"
category = "string"
description = "string"
displayName = "string"
name = "string"
}
]
policyDefinitions = [
{
groupNames = [
"string"
]
parameters = {
{customized property} = {}
}
policyDefinitionId = "string"
policyDefinitionReferenceId = "string"
}
]
policyType = "string"
}
})
}
Valores de propiedad
policySetDefinitions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.Authorization/policySetDefinitions@2020-09-01" |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: nombre para mostrar de 1 a 128 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. | ParameterDefinitions |
| 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" |
ParameterDefinitions
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterDefinitionsValue |
ParameterDefinitionsValue
| Nombre | Descripción | Valor |
|---|---|---|
| allowedValues | Valores permitidos para el parámetro . | any[] |
| defaultValue | Valor predeterminado del parámetro si no se proporciona ningún valor. | |
| metadata | Metadatos generales para el parámetro . | ParameterDefinitionsValueMetadata |
| tipo | El 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 directiva. Esta propiedad es útil en caso de que desee asignar permisos fuera del ámbito de asignación. | bool |
| description | La descripción del parámetro. | string |
| DisplayName | Nombre para mostrar del parámetro. | string |
| strongType | Se usa al asignar la definición de directiva a través del portal. Proporciona una lista contextual de valores para que el usuario elija. | string |
| {propiedad personalizada} |
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. | ParameterValues |
| 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 |
ParameterValues
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterValuesValue |
ParameterValuesValue
| Nombre | Descripción | Valor |
|---|---|---|
| value | Valor del parámetro. |