Microsoft.Authorization policyDefinitions 2023-04-01
Definición de recursos de Bicep
El tipo de recurso policyDefinitions 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 policyDefinitions se puede implementar con operaciones que tienen como destino:
- 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/policyDefinitions, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.Authorization/policyDefinitions@2023-04-01' = {
name: 'string'
scope: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
metadata: any()
mode: 'string'
parameters: {
{customized property}: {
allowedValues: [
any
]
defaultValue: any()
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
{customized property}: any()
}
schema: any()
type: 'string'
}
}
policyRule: any()
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Valores de propiedad
policyDefinitions
| 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. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la definición de directiva. | string |
| DisplayName | Nombre para mostrar de la definición de directiva. | string |
| metadata | Metadatos de definición de directiva. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor. | Para Bicep, puede usar la función any(). |
| mode | Modo de definición de directiva. Algunos ejemplos son All, Indexed, Microsoft.KeyVault.Data. | string |
| parámetros | Las definiciones de parámetros para los parámetros usados en la regla de directiva. Las claves son los nombres de parámetro. | ParameterDefinitions |
| policyRule | Regla de directiva. | Para Bicep, puede usar la función any(). |
| policyType | Tipo de definición de directiva. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. | 'BuiltIn' 'Personalizado' 'NotSpecified' 'Static' |
| version | La versión de definición de directiva en formato #.#.# | string |
| versions | Lista de versiones disponibles para esta definición de directiva. | string[] |
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 |
| 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 2019-09 del esquema Json.NET. Puede obtener más información sobre el uso de esquemas en https://json-schema.org/ y probar esquemas en . https://www.jsonschemavalidator.net/. |
Para Bicep, puede usar la función any(). |
| 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} | Para Bicep, puede usar la función any(). |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
Implementación de una definición de directiva y asignación a un grupo de administración |
Esta plantilla es una plantilla de nivel de grupo de administración que creará una definición de directiva y asignará esa directiva al grupo de administración de destino. Actualmente, esta plantilla no se puede implementar a través de Azure Portal. |
| Implementación de una directiva def y asignación a varios Grupos mgmt |
Esta plantilla es una plantilla de nivel de grupo de administración que creará una definición de directiva y asignará esa directiva a varios grupos de administración. |
| Create una instancia de Azure Virtual Network Manager y redes virtuales de ejemplo |
Esta plantilla implementa una instancia de Azure Virtual Network Manager y redes virtuales de ejemplo en el grupo de recursos con nombre. Admite varias topologías de conectividad y tipos de pertenencia a grupos de red. |
Definición de recursos de plantilla de ARM
El tipo de recurso policyDefinitions 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 policyDefinitions se puede implementar con operaciones que tienen como destino:
- 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/policyDefinitions, agregue el siguiente json a la plantilla.
{
"type": "Microsoft.Authorization/policyDefinitions",
"apiVersion": "2023-04-01",
"name": "string",
"scope": "string",
"properties": {
"description": "string",
"displayName": "string",
"metadata": {},
"mode": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ object ],
"defaultValue": {},
"metadata": {
"assignPermissions": "bool",
"description": "string",
"displayName": "string",
"strongType": "string",
"{customized property}": {}
},
"schema": {},
"type": "string"
}
},
"policyRule": {},
"policyType": "string",
"version": "string",
"versions": [ "string" ]
}
}
Valores de propiedad
policyDefinitions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.Authorization/policyDefinitions" |
| apiVersion | La versión de la API de recursos | '2023-04-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 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. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la definición de directiva. | string |
| DisplayName | Nombre para mostrar de la definición de directiva. | string |
| metadata | Metadatos de definición de directiva. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor. | |
| mode | Modo de definición de directiva. Algunos ejemplos son All, Indexed, Microsoft.KeyVault.Data. | string |
| parámetros | Las definiciones de parámetros para los parámetros usados en la regla de directiva. Las claves son los nombres de parámetro. | ParameterDefinitions |
| policyRule | Regla de directiva. | |
| policyType | Tipo de definición de directiva. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. | 'BuiltIn' 'Personalizado' 'NotSpecified' 'Static' |
| version | La versión de definición de directiva en formato #.#.# | string |
| versions | Lista de versiones disponibles para esta definición de directiva. | string[] |
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 |
| 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 2019-09 del esquema Json.NET. Puede obtener más información sobre el uso de esquemas en https://json-schema.org/ y probar esquemas en . https://www.jsonschemavalidator.net/. |
|
| 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} |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
| Implementación de una definición de directiva y asignación a un grupo de administración |
Esta plantilla es una plantilla de nivel de grupo de administración que creará una definición de directiva y asignará esa directiva al grupo de administración de destino. Actualmente, esta plantilla no se puede implementar a través de Azure Portal. |
| Implementación de una directiva def y asignación a varios Grupos mgmt |
Esta plantilla es una plantilla de nivel de grupo de administración que creará una definición de directiva y asignará esa directiva a varios grupos de administración. |
| Create una instancia de Azure Virtual Network Manager y redes virtuales de ejemplo |
Esta plantilla implementa una instancia de Azure Virtual Network Manager y redes virtuales de ejemplo en el grupo de recursos con nombre. Admite varias topologías de conectividad y tipos de pertenencia a grupos de red. |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso policyDefinitions 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 policyDefinitions se puede implementar con operaciones que tienen como destino:
- 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/policyDefinitions, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyDefinitions@2023-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
mode = "string"
parameters = {
{customized property} = {
allowedValues = [ object ]
metadata = {
assignPermissions = bool
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
policyType = "string"
version = "string"
versions = [
"string"
]
}
})
}
Valores de propiedad
policyDefinitions
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.Authorization/policyDefinitions@2023-04-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. | PolicyDefinitionProperties |
PolicyDefinitionProperties
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la definición de directiva. | string |
| DisplayName | Nombre para mostrar de la definición de directiva. | string |
| metadata | Metadatos de definición de directiva. Los metadatos son un objeto abierto y normalmente es una colección de pares clave-valor. | |
| mode | Modo de definición de directiva. Algunos ejemplos son All, Indexed, Microsoft.KeyVault.Data. | string |
| parámetros | Definiciones de parámetros para parámetros usados en la regla de directiva. Las claves son los nombres de parámetro. | ParameterDefinitions |
| policyRule | Regla de directiva. | |
| policyType | Tipo de definición de directiva. Los valores posibles son NotSpecified, BuiltIn, Custom y Static. | "BuiltIn" "Custom" "NotSpecified" "Estático" |
| version | La versión de definición de directiva en formato #.#.#. | string |
| versions | Lista de versiones disponibles para esta definición de directiva. | string[] |
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 |
| 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 2019-09 del esquema Json.NET. Puede obtener más información sobre el uso de esquemas en y probar esquemas en https://json-schema.org/ . https://www.jsonschemavalidator.net/. |
|
| 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} |
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de