Partager via


Microsoft.Authorization policyDefinitions

Définition de ressource Bicep

Le type de ressource policyDefinitions est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans Bicep.

Le type de ressource policyDefinitions peut être déployé avec des opérations qui ciblent :

Vous pouvez référencer ce type de ressource en tant que ressource en lecture seule au niveau de : Locataires

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Authorization/policyDefinitions, ajoutez le Bicep suivant à votre modèle.

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'
    ]
  }
}

Valeurs de propriétés

policyDefinitions

Nom Description Valeur
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-128 nom d’affichage

1-64 (nom de la ressource)

Caractères valides :
Le nom d’affichage peut contenir n’importe quel caractère.

Le nom de la ressource ne peut pas utiliser :
<>*%&:\?+/ ou des caractères de contrôle.

Ne peut pas se terminer par un point ou un espace.
scope Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue du déploiement. Ressource cible

Pour Bicep, définissez cette propriété sur le nom symbolique de la ressource pour appliquer la ressource d’extension.
properties Propriétés de définition de stratégie. PolicyDefinitionProperties

PolicyDefinitionProperties

Nom Description Valeur
description Description de la définition de stratégie. string
displayName Nom d’affichage de la définition de stratégie. string
metadata Métadonnées de définition de stratégie. Les métadonnées sont un objet ouvert et sont généralement une collection de paires de valeurs de clé. Pour Bicep, vous pouvez utiliser la fonction any().
mode Mode de définition de stratégie. Par exemple, All, Indexed, Microsoft.KeyVault.Data. string
parameters Définitions de paramètres pour les paramètres utilisés dans la règle de stratégie. Les clés sont les noms des paramètres. ParameterDefinitions
policyRule Règle de stratégie. Pour Bicep, vous pouvez utiliser la fonction any().
policyType Type de définition de stratégie. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static. 'BuiltIn'
'Personnalisé'
'NotSpecified'
'Statique'
version Version de la définition de stratégie au format #.#.#. string
versions Liste des versions disponibles pour cette définition de stratégie. string[]

ParameterDefinitions

Nom Description Valeur
{propriété personnalisée} ParameterDefinitionsValue

ParameterDefinitionsValue

Nom Description Valeur
allowedValues Valeurs autorisées pour le paramètre. any[]
defaultValue Valeur par défaut du paramètre si aucune valeur n’est fournie. Pour Bicep, vous pouvez utiliser la fonction any().
metadata Métadonnées générales pour le paramètre. ParameterDefinitionsValueMetadata
schéma Fournit la validation des entrées de paramètres pendant l’affectation à l’aide d’un schéma JSON auto-défini. Cette propriété est prise en charge uniquement pour les paramètres de type objet. Elle suit l’implémentation de la version du schéma Json.NET de septembre 2019. Vous pouvez en savoir plus sur l’utilisation des schémas dans https://json-schema.org/ et tester les schémas brouillons à l’adresse https://www.jsonschemavalidator.net/. Pour Bicep, vous pouvez utiliser la fonction any().
type Type de données du paramètre. 'Array'
'Boolean'
'DateTime'
'Float'
'Integer'
'Object'
'String'

ParameterDefinitionsValueMetadata

Nom Description Valeur
assignPermissions Définissez sur true pour avoir Portail Azure créer des attributions de rôle sur l’ID de ressource ou la valeur d’étendue de ressource de ce paramètre pendant l’attribution de stratégie. Cette propriété est utile si vous souhaitez attribuer des autorisations en dehors de l’étendue d’attribution. bool
description Description du paramètre. string
displayName Nom complet du paramètre. string
strongType Utilisé lors de l’attribution de la définition de stratégie via le portail. Fournit une liste contextuelle de valeurs parmi lesquelles l’utilisateur peut choisir. string
{propriété personnalisée} Pour Bicep, vous pouvez utiliser la fonction any().

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Déployer une définition de stratégie et l’affecter à un groupe d’administration

Déployer sur Azure
Ce modèle est un modèle au niveau du groupe d’administration qui crée une définition de stratégie et affecte cette stratégie au groupe d’administration cible. Actuellement, ce modèle ne peut pas être déployé via le portail Azure.
Déployer une stratégie def et l’affecter à plusieurs Groupes mgmt

Déployer sur Azure
Ce modèle est un modèle au niveau du groupe d’administration qui crée une définition de stratégie et affecte cette stratégie à plusieurs groupes d’administration.
Create azure Réseau virtuel Manager et des exemples de réseaux virtuels

Déployer sur Azure
Ce modèle déploie azure Réseau virtuel Manager et des exemples de réseaux virtuels dans le groupe de ressources nommé. Il prend en charge plusieurs topologies de connectivité et types d’appartenance à un groupe réseau.

Définition de ressources de modèle ARM

Le type de ressource policyDefinitions est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans les modèles ARM.

Le type de ressource policyDefinitions peut être déployé avec des opérations qui ciblent :

Vous pouvez référencer ce type de ressource en tant que ressource en lecture seule au niveau de : Locataires

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Authorization/policyDefinitions, ajoutez le JSON suivant à votre modèle.

{
  "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" ]
  }
}

Valeurs de propriétés

policyDefinitions

Nom Description Valeur
type Type de ressource 'Microsoft.Authorization/policyDefinitions'
apiVersion Version de l’API de ressource '2023-04-01'
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-128 nom d’affichage

1-64 (nom de la ressource)

Caractères valides :
Le nom d’affichage peut contenir n’importe quel caractère.

Le nom de la ressource ne peut pas utiliser :
<>*%&:\?+/ ou des caractères de contrôle.

Ne peut pas se terminer par un point ou un espace.
scope Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue de déploiement. Ressource cible

Pour JSON, définissez la valeur sur le nom complet de la ressource à laquelle appliquer la ressource d’extension .
properties Propriétés de définition de stratégie. PolicyDefinitionProperties

PolicyDefinitionProperties

Nom Description Valeur
description Description de la définition de stratégie. string
displayName Nom complet de la définition de stratégie. string
metadata Métadonnées de définition de stratégie. Les métadonnées sont un objet ouvert et sont généralement une collection de paires clé-valeur.
mode Mode de définition de stratégie. Par exemple, All, Indexed, Microsoft.KeyVault.Data. string
parameters Définitions de paramètres pour les paramètres utilisés dans la règle de stratégie. Les clés sont les noms des paramètres. ParameterDefinitions
policyRule Règle de stratégie.
policyType Type de définition de stratégie. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static. 'BuiltIn'
'Personnalisé'
'NotSpecified'
'Statique'
version Version de la définition de stratégie au format #.#.#. string
versions Liste des versions disponibles pour cette définition de stratégie. string[]

ParameterDefinitions

Nom Description Valeur
{propriété personnalisée} ParameterDefinitionsValue

ParameterDefinitionsValue

Nom Description Valeur
allowedValues Valeurs autorisées pour le paramètre. any[]
defaultValue Valeur par défaut du paramètre si aucune valeur n’est fournie.
metadata Métadonnées générales pour le paramètre. ParameterDefinitionsValueMetadata
schéma Fournit la validation des entrées de paramètres pendant l’affectation à l’aide d’un schéma JSON auto-défini. Cette propriété est prise en charge uniquement pour les paramètres de type objet. Elle suit l’implémentation de la version du schéma Json.NET de septembre 2019. Vous pouvez en savoir plus sur l’utilisation des schémas dans https://json-schema.org/ et tester les schémas brouillons à l’adresse https://www.jsonschemavalidator.net/.
type Type de données du paramètre. 'Array'
'Boolean'
'DateTime'
'Float'
'Integer'
'Object'
'String'

ParameterDefinitionsValueMetadata

Nom Description Valeur
assignPermissions Définissez sur true pour avoir Portail Azure créer des attributions de rôles sur l’ID de ressource ou la valeur d’étendue de ressource de ce paramètre pendant l’attribution de stratégie. Cette propriété est utile si vous souhaitez attribuer des autorisations en dehors de l’étendue d’attribution. bool
description Description du paramètre. string
displayName Nom d’affichage du paramètre. string
strongType Utilisé lors de l’attribution de la définition de stratégie via le portail. Fournit une liste de valeurs contextuelles que l’utilisateur peut choisir. string
{propriété personnalisée}

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Déployer une définition de stratégie et l’affecter à un groupe d’administration

Déployer sur Azure
Ce modèle est un modèle au niveau du groupe d’administration qui va créer une définition de stratégie et affecter cette stratégie au groupe d’administration cible. Actuellement, ce modèle ne peut pas être déployé via le portail Azure.
Déployer une stratégie def et attribuer à plusieurs mgmt Groupes

Déployer sur Azure
Ce modèle est un modèle au niveau du groupe d’administration qui va créer une définition de stratégie et affecter cette stratégie à plusieurs groupes d’administration.
Create un Gestionnaire de Réseau virtuel Azure et des exemples de réseaux virtuels

Déployer sur Azure
Ce modèle déploie un azure Réseau virtuel Manager et des exemples de réseaux virtuels dans le groupe de ressources nommé. Il prend en charge plusieurs topologies de connectivité et types d’appartenance à un groupe réseau.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource policyDefinitions est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la parent_id propriété sur cette ressource pour définir l’étendue de cette ressource.

Le type de ressource policyDefinitions peut être déployé avec des opérations qui ciblent :

  • Groupes d’administration
  • Abonnements

Vous pouvez référencer ce type de ressource en tant que ressource en lecture seule au niveau de : Locataires

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Authorization/policyDefinitions, ajoutez le Terraform suivant à votre modèle.

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"
      ]
    }
  })
}

Valeurs de propriétés

policyDefinitions

Nom Description Valeur
type Type de ressource « Microsoft.Authorization/policyDefinitions@2023-04-01 »
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-128 nom d’affichage

1-64 (nom de la ressource)

Caractères valides :
Le nom d’affichage peut contenir n’importe quel caractère.

Le nom de la ressource ne peut pas utiliser :
<>*%&:\?+/ ou des caractères de contrôle.

Ne peut pas se terminer par un point ou un espace.
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. string (obligatoire)
properties Propriétés de définition de stratégie. PolicyDefinitionProperties

PolicyDefinitionProperties

Nom Description Valeur
description Description de la définition de stratégie. string
displayName Nom complet de la définition de stratégie. string
metadata Métadonnées de définition de stratégie. Les métadonnées sont un objet ouvert et sont généralement une collection de paires clé-valeur.
mode Mode de définition de stratégie. En voici quelques exemples : All, Indexed, Microsoft.KeyVault.Data. string
parameters Définitions de paramètres pour les paramètres utilisés dans la règle de stratégie. Les clés sont les noms des paramètres. ParameterDefinitions
policyRule Règle de stratégie.
policyType Type de définition de stratégie. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static. « BuiltIn »
"Custom"
« NotSpecified »
« Statique »
version Version de définition de stratégie au format #.#.#. string
versions Liste des versions disponibles pour cette définition de stratégie. string[]

ParameterDefinitions

Nom Description Valeur
{propriété personnalisée} ParameterDefinitionsValue

ParameterDefinitionsValue

Nom Description Valeur
allowedValues Valeurs autorisées pour le paramètre. any[]
defaultValue Valeur par défaut du paramètre si aucune valeur n’est fournie.
metadata Métadonnées générales pour le paramètre . ParameterDefinitionsValueMetadata
schéma Fournit la validation des entrées de paramètres pendant l’affectation à l’aide d’un schéma JSON autodéfini. Cette propriété est prise en charge uniquement pour les paramètres de type objet. Elle suit l’implémentation de la version du schéma Json.NET de septembre 2019. Vous pouvez en savoir plus sur l’utilisation des schémas dans https://json-schema.org/ et tester les schémas brouillons à l’adresse https://www.jsonschemavalidator.net/.
type Type de données du paramètre. « Array »
« Boolean »
« DateTime »
« Float »
« Integer »
« Object »
« String »

ParameterDefinitionsValueMetadata

Nom Description Valeur
assignPermissions Définissez sur true pour avoir Portail Azure créer des attributions de rôle sur l’ID de ressource ou la valeur d’étendue de ressource de ce paramètre pendant l’attribution de stratégie. Cette propriété est utile si vous souhaitez attribuer des autorisations en dehors de l’étendue d’attribution. bool
description Description du paramètre. string
displayName Nom complet du paramètre. string
strongType Utilisé lors de l’attribution de la définition de stratégie via le portail. Fournit une liste contextuelle de valeurs parmi lesquelles l’utilisateur peut choisir. string
{propriété personnalisée}