Microsoft.Authorization policySetDefinitions 2024-05-01
Définition de ressource Bicep
Le type de ressource policySetDefinitions peut être déployé avec des opérations qui ciblent :
- de locataire - Voir commandes de déploiement de locataire* groupes d’administration - Voir commandes de déploiement de groupe d’administration* Abonnement - Voir commandes de déploiement d’abonnement
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.Authorization/policySetDefinitions, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Authorization/policySetDefinitions@2024-05-01' = {
name: 'string'
properties: {
description: 'string'
displayName: 'string'
metadata: any(Azure.Bicep.Types.Concrete.AnyType)
parameters: {
{customized property}: {
allowedValues: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
metadata: {
assignPermissions: bool
description: 'string'
displayName: 'string'
strongType: 'string'
}
schema: any(Azure.Bicep.Types.Concrete.AnyType)
type: 'string'
}
}
policyDefinitionGroups: [
{
additionalMetadataId: 'string'
category: 'string'
description: 'string'
displayName: 'string'
name: 'string'
}
]
policyDefinitions: [
{
definitionVersion: 'string'
groupNames: [
'string'
]
parameters: {
{customized property}: {
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
policyDefinitionId: 'string'
policyDefinitionReferenceId: 'string'
}
]
policyType: 'string'
version: 'string'
versions: [
'string'
]
}
}
Valeurs de propriété
Microsoft.Authorization/policySetDefinitions
Nom | Description | Valeur |
---|---|---|
nom | Nom de la ressource | corde Contraintes: Modèle = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obligatoire) |
Propriétés | Propriétés de définition du jeu de stratégies. | PolicySetDefinitionProperties |
ParameterDefinitions
Nom | Description | Valeur |
---|
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. | quelconque |
métadonnées | Métadonnées générales pour le paramètre. | ParameterDefinitionsValueMetadata |
schéma | Fournit la validation des entrées de paramètre pendant l’affectation à l’aide d’un schéma JSON autodéfinis. Cette propriété est uniquement prise en charge pour les paramètres de type objet et suit l’implémentation Json.NET Schema 2019-09. Vous pouvez en savoir plus sur l’utilisation de schémas à https://json-schema.org/ et tester des schémas brouillons à https://www.jsonschemavalidator.net/. | quelconque |
type | Type de données du paramètre. | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
Nom | Description | Valeur |
---|---|---|
assignPermissions | Définissez la valeur true pour que le portail Azure crée 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’affectation. | Bool |
description | Description du paramètre. | corde |
displayName | Nom complet du paramètre. | corde |
strongType | Utilisé lors de l’attribution de la définition de stratégie via le portail. Fournit une liste contextuelle des valeurs à choisir pour l’utilisateur. | corde |
ParameterValues
Nom | Description | Valeur |
---|
ParameterValuesValue
Nom | Description | Valeur |
---|---|---|
valeur | Valeur du paramètre. | quelconque |
PolicyDefinitionGroup
Nom | Description | Valeur |
---|---|---|
additionalMetadataId | ID de ressource d’une ressource qui contient des métadonnées supplémentaires sur le groupe. | corde |
catégorie | Catégorie du groupe. | corde |
description | Description du groupe. | corde |
displayName | Nom complet du groupe. | corde |
nom | Nom du groupe. | chaîne (obligatoire) |
PolicyDefinitionReference
Nom | Description | Valeur |
---|---|---|
definitionVersion | Version de la définition de stratégie à utiliser. | corde |
groupNames | Nom des groupes auxquels appartient cette référence de définition de stratégie. | string[] |
Paramètres | Valeurs des paramètres de la règle de stratégie référencée. Les clés sont les noms de paramètres. | ParameterValues |
policyDefinitionId | ID de la définition de stratégie ou de la définition de jeu de stratégies. | chaîne (obligatoire) |
policyDefinitionReferenceId | ID unique (dans la définition du jeu de stratégies) pour cette référence de définition de stratégie. | corde |
PolicySetDefinitionProperties
Nom | Description | Valeur |
---|---|---|
description | Description de la définition du jeu de stratégies. | corde |
displayName | Nom complet de la définition du jeu de stratégies. | corde |
métadonnées | 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 clé-valeur. | quelconque |
Paramètres | 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 | Métadonnées décrivant les 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 du jeu de stratégies. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static. | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
Version | Version de définition du jeu de stratégies au format #.#.#. | corde |
Versions | Liste des versions disponibles pour cette définition de jeu de stratégies. | string[] |
Définition de ressource de modèle ARM
Le type de ressource policySetDefinitions peut être déployé avec des opérations qui ciblent :
- de locataire - Voir commandes de déploiement de locataire* groupes d’administration - Voir commandes de déploiement de groupe d’administration* Abonnement - Voir commandes de déploiement d’abonnement
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.Authorization/policySetDefinitions, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.Authorization/policySetDefinitions",
"apiVersion": "2024-05-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" ]
}
}
Valeurs de propriété
Microsoft.Authorization/policySetDefinitions
Nom | Description | Valeur |
---|---|---|
apiVersion | Version de l’API | '2024-05-01' |
nom | Nom de la ressource | corde Contraintes: Modèle = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obligatoire) |
Propriétés | Propriétés de définition du jeu de stratégies. | PolicySetDefinitionProperties |
type | Type de ressource | 'Microsoft.Authorization/policySetDefinitions' |
ParameterDefinitions
Nom | Description | Valeur |
---|
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. | quelconque |
métadonnées | Métadonnées générales pour le paramètre. | ParameterDefinitionsValueMetadata |
schéma | Fournit la validation des entrées de paramètre pendant l’affectation à l’aide d’un schéma JSON autodéfinis. Cette propriété est uniquement prise en charge pour les paramètres de type objet et suit l’implémentation Json.NET Schema 2019-09. Vous pouvez en savoir plus sur l’utilisation de schémas à https://json-schema.org/ et tester des schémas brouillons à https://www.jsonschemavalidator.net/. | quelconque |
type | Type de données du paramètre. | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
Nom | Description | Valeur |
---|---|---|
assignPermissions | Définissez la valeur true pour que le portail Azure crée 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’affectation. | Bool |
description | Description du paramètre. | corde |
displayName | Nom complet du paramètre. | corde |
strongType | Utilisé lors de l’attribution de la définition de stratégie via le portail. Fournit une liste contextuelle des valeurs à choisir pour l’utilisateur. | corde |
ParameterValues
Nom | Description | Valeur |
---|
ParameterValuesValue
Nom | Description | Valeur |
---|---|---|
valeur | Valeur du paramètre. | quelconque |
PolicyDefinitionGroup
Nom | Description | Valeur |
---|---|---|
additionalMetadataId | ID de ressource d’une ressource qui contient des métadonnées supplémentaires sur le groupe. | corde |
catégorie | Catégorie du groupe. | corde |
description | Description du groupe. | corde |
displayName | Nom complet du groupe. | corde |
nom | Nom du groupe. | chaîne (obligatoire) |
PolicyDefinitionReference
Nom | Description | Valeur |
---|---|---|
definitionVersion | Version de la définition de stratégie à utiliser. | corde |
groupNames | Nom des groupes auxquels appartient cette référence de définition de stratégie. | string[] |
Paramètres | Valeurs des paramètres de la règle de stratégie référencée. Les clés sont les noms de paramètres. | ParameterValues |
policyDefinitionId | ID de la définition de stratégie ou de la définition de jeu de stratégies. | chaîne (obligatoire) |
policyDefinitionReferenceId | ID unique (dans la définition du jeu de stratégies) pour cette référence de définition de stratégie. | corde |
PolicySetDefinitionProperties
Nom | Description | Valeur |
---|---|---|
description | Description de la définition du jeu de stratégies. | corde |
displayName | Nom complet de la définition du jeu de stratégies. | corde |
métadonnées | 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 clé-valeur. | quelconque |
Paramètres | 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 | Métadonnées décrivant les 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 du jeu de stratégies. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static. | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
Version | Version de définition du jeu de stratégies au format #.#.#. | corde |
Versions | Liste des versions disponibles pour cette définition de jeu de stratégies. | string[] |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource policySetDefinitions peut être déployé avec des opérations qui ciblent :
- groupes d’administration* clients* abonnement
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.Authorization/policySetDefinitions, ajoutez terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policySetDefinitions@2024-05-01"
name = "string"
body = jsonencode({
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"
]
}
})
}
Valeurs de propriété
Microsoft.Authorization/policySetDefinitions
Nom | Description | Valeur |
---|---|---|
nom | Nom de la ressource | corde Contraintes: Modèle = ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$ (obligatoire) |
Propriétés | Propriétés de définition du jeu de stratégies. | PolicySetDefinitionProperties |
type | Type de ressource | « Microsoft.Authorization/policySetDefinitions@2024-05-01 » |
ParameterDefinitions
Nom | Description | Valeur |
---|
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. | quelconque |
métadonnées | Métadonnées générales pour le paramètre. | ParameterDefinitionsValueMetadata |
schéma | Fournit la validation des entrées de paramètre pendant l’affectation à l’aide d’un schéma JSON autodéfinis. Cette propriété est uniquement prise en charge pour les paramètres de type objet et suit l’implémentation Json.NET Schema 2019-09. Vous pouvez en savoir plus sur l’utilisation de schémas à https://json-schema.org/ et tester des schémas brouillons à https://www.jsonschemavalidator.net/. | quelconque |
type | Type de données du paramètre. | 'Array' 'Boolean' 'DateTime' 'Float' 'Integer' 'Object' 'String' |
ParameterDefinitionsValueMetadata
Nom | Description | Valeur |
---|---|---|
assignPermissions | Définissez la valeur true pour que le portail Azure crée 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’affectation. | Bool |
description | Description du paramètre. | corde |
displayName | Nom complet du paramètre. | corde |
strongType | Utilisé lors de l’attribution de la définition de stratégie via le portail. Fournit une liste contextuelle des valeurs à choisir pour l’utilisateur. | corde |
ParameterValues
Nom | Description | Valeur |
---|
ParameterValuesValue
Nom | Description | Valeur |
---|---|---|
valeur | Valeur du paramètre. | quelconque |
PolicyDefinitionGroup
Nom | Description | Valeur |
---|---|---|
additionalMetadataId | ID de ressource d’une ressource qui contient des métadonnées supplémentaires sur le groupe. | corde |
catégorie | Catégorie du groupe. | corde |
description | Description du groupe. | corde |
displayName | Nom complet du groupe. | corde |
nom | Nom du groupe. | chaîne (obligatoire) |
PolicyDefinitionReference
Nom | Description | Valeur |
---|---|---|
definitionVersion | Version de la définition de stratégie à utiliser. | corde |
groupNames | Nom des groupes auxquels appartient cette référence de définition de stratégie. | string[] |
Paramètres | Valeurs des paramètres de la règle de stratégie référencée. Les clés sont les noms de paramètres. | ParameterValues |
policyDefinitionId | ID de la définition de stratégie ou de la définition de jeu de stratégies. | chaîne (obligatoire) |
policyDefinitionReferenceId | ID unique (dans la définition du jeu de stratégies) pour cette référence de définition de stratégie. | corde |
PolicySetDefinitionProperties
Nom | Description | Valeur |
---|---|---|
description | Description de la définition du jeu de stratégies. | corde |
displayName | Nom complet de la définition du jeu de stratégies. | corde |
métadonnées | 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 clé-valeur. | quelconque |
Paramètres | 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 | Métadonnées décrivant les 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 du jeu de stratégies. Les valeurs possibles sont NotSpecified, BuiltIn, Custom et Static. | 'BuiltIn' 'Custom' 'NotSpecified' 'Static' |
Version | Version de définition du jeu de stratégies au format #.#.#. | corde |
Versions | Liste des versions disponibles pour cette définition de jeu de stratégies. | string[] |