Microsoft.Authorization policySetDefinitions 2020-09-01

Article
05/09/2024

Définition de ressource Bicep

Le type de ressource policySetDefinitions 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 policySetDefinitions peut être déployé avec des opérations qui ciblent :

Groupes d’administration - Voir Commandes de déploiement de groupe d’administration
Abonnements - Voir Commandes de déploiement d’abonnement

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/policySetDefinitions, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

policySetDefinitions

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.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nom	Description	Valeur
description	Description de la définition du jeu de stratégies.	string
displayName	Nom d’affichage de la définition du jeu de stratégies.	string
metadata	Métadonnées de définition du jeu de stratégies. 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().
parameters	Paramètres de définition du jeu de stratégies qui peuvent être utilisés dans les références de définition de stratégie.	ParameterDefinitions
policyDefinitionGroups	Les métadonnées décrivant des groupes de définition de stratégie font référence dans la définition de l’ensemble de stratégies.	PolicyDefinitionGroup[]
policyDefinitions	Tableau de références de définition de stratégie.	PolicyDefinitionReference[] (obligatoire)
policyType	Type de définition de stratégie. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static.	'BuiltIn' 'Personnalisé' 'NotSpecified' 'Statique'

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
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().

PolicyDefinitionGroup

Nom	Description	Valeur
additionalMetadataId	ID de ressource d’une ressource qui contient des métadonnées supplémentaires sur le groupe.	string
catégorie	Catégorie du groupe.	string
description	Description du groupe.	string
displayName	nom complet du groupe.	string
name	Nom du groupe.	string (obligatoire)

PolicyDefinitionReference

Nom	Description	Valeur
groupNames	Nom des groupes auxquels cette définition de stratégie fait référence.	string[]
parameters	Valeurs de paramètre pour la règle de stratégie référencée. Les clés sont les noms des paramètres.	ParameterValues
policyDefinitionId	ID de la définition de stratégie ou de la définition de l’ensemble de stratégies.	string (obligatoire)
policyDefinitionReferenceId	ID unique (dans la définition de l’ensemble de stratégies) pour cette référence de définition de stratégie.	string

ParameterValues

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

ParameterValuesValue

Nom	Description	Valeur
value	Valeur du paramètre.	Pour Bicep, vous pouvez utiliser la fonction any().

Définition de ressources de modèle ARM

Le type de ressource policySetDefinitions 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 policySetDefinitions peut être déployé avec des opérations qui ciblent :

Groupes d’administration - Voir commandes de déploiement de groupe d’administration
Abonnements - Voir les commandes de déploiement d’abonnement

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/policySetDefinitions, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriétés

policySetDefinitions

Nom	Description	Valeur
type	Type de ressource	'Microsoft.Authorization/policySetDefinitions'
apiVersion	Version de l’API de ressource	'2020-09-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.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nom	Description	Valeur
description	Description de la définition du jeu de stratégies.	string
displayName	Nom complet de la définition du jeu de stratégies.	string
metadata	Métadonnées de définition de l’ensemble de stratégies. Les métadonnées sont un objet ouvert et sont généralement une collection de paires clé-valeur.
parameters	Paramètres de définition d’ensemble de stratégies qui peuvent être utilisés dans les références de définition de stratégie.	ParameterDefinitions
policyDefinitionGroups	Métadonnées décrivant des groupes de références de définition de stratégie dans la définition du jeu de stratégies.	PolicyDefinitionGroup[]
policyDefinitions	Tableau de références de définition de stratégie.	PolicyDefinitionReference[] (obligatoire)
policyType	Type de définition de stratégie. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static.	'BuiltIn' 'Personnalisé' 'NotSpecified' 'Static'

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

PolicyDefinitionGroup

Nom	Description	Valeur
additionalMetadataId	ID de ressource d’une ressource qui contient des métadonnées supplémentaires sur le groupe.	string
catégorie	Catégorie du groupe.	string
description	Description du groupe.	string
displayName	nom complet du groupe.	string
name	Nom du groupe.	chaîne (obligatoire)

PolicyDefinitionReference

Nom	Description	Valeur
groupNames	Nom des groupes auxquels cette référence de définition de stratégie appartient.	string[]
parameters	Valeurs de paramètre pour la règle de stratégie référencée. Les clés sont les noms des paramètres.	ParameterValues
policyDefinitionId	ID de la définition de stratégie ou de l’ensemble de stratégies.	chaîne (obligatoire)
policyDefinitionReferenceId	Id unique (dans la définition de l’ensemble de stratégies) pour cette référence de définition de stratégie.	string

ParameterValues

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

ParameterValuesValue

Nom	Description	Valeur
value	Valeur du paramètre.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource policySetDefinitions 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 policySetDefinitions 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/policySetDefinitions, ajoutez le Terraform suivant à votre modèle.

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

Valeurs de propriétés

policySetDefinitions

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Authorization/policySetDefinitions@2020-09-01 »
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.
parent_id	ID de la ressource à laquelle appliquer cette ressource d’extension.	chaîne (obligatoire)
properties	Propriétés de définition de stratégie.	PolicySetDefinitionProperties

PolicySetDefinitionProperties

Nom	Description	Valeur
description	Description de la définition du jeu de stratégies.	string
displayName	Nom d’affichage de la définition du jeu de stratégies.	string
metadata	Métadonnées de définition du jeu de stratégies. Les métadonnées sont un objet ouvert et sont généralement une collection de paires de valeurs de clé.
parameters	Paramètres de définition du jeu de stratégies qui peuvent être utilisés dans les références de définition de stratégie.	ParameterDefinitions
policyDefinitionGroups	Les métadonnées décrivant des groupes de définition de stratégie font référence dans la définition de l’ensemble de stratégies.	PolicyDefinitionGroup[]
policyDefinitions	Tableau de références de définition de stratégie.	PolicyDefinitionReference[] (obligatoire)
policyType	Type de définition de stratégie. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static.	« BuiltIn » "Custom" « NotSpecified » « Statique »

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
type	Type de données du paramètre.	« Tableau » « Boolean » « DateTime » « Float » « Integer » « Objet » « 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}

PolicyDefinitionGroup

Nom	Description	Valeur
additionalMetadataId	ID de ressource d’une ressource qui contient des métadonnées supplémentaires sur le groupe.	string
catégorie	Catégorie du groupe.	string
description	Description du groupe.	string
displayName	nom complet du groupe.	string
name	Nom du groupe.	chaîne (obligatoire)

PolicyDefinitionReference

Nom	Description	Valeur
groupNames	Nom des groupes auxquels cette référence de définition de stratégie appartient.	string[]
parameters	Valeurs de paramètre pour la règle de stratégie référencée. Les clés sont les noms des paramètres.	ParameterValues
policyDefinitionId	ID de la définition de stratégie ou de l’ensemble de stratégies.	chaîne (obligatoire)
policyDefinitionReferenceId	Id unique (dans la définition de l’ensemble de stratégies) pour cette référence de définition de stratégie.	string

ParameterValues

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

ParameterValuesValue

Nom	Description	Valeur
value	Valeur du paramètre.

Partager via

Microsoft.Authorization policySetDefinitions 2020-09-01

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

policySetDefinitions

PolicySetDefinitionProperties

ParameterDefinitions

ParameterDefinitionsValue

ParameterDefinitionsValueMetadata

PolicyDefinitionGroup

PolicyDefinitionReference

ParameterValues

ParameterValuesValue

Commentaires

Ressources supplémentaires