Microsoft.Authorization policyAssignments 2020-09-01
Définition de ressource Bicep
Le type de ressource policyAssignments 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.
Les étendues de déploiement valides pour la ressource policyAssignments sont les suivantes :
- Groupes de ressources - Voir commandes de déploiement de groupes de ressources
- Abonnements - Voir Commandes de déploiement d’abonnement
- Groupes d’administration - Voir Commandes de déploiement de groupe d’administration
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/policyAssignments, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Authorization/policyAssignments@2020-09-01' = {
name: 'string'
location: 'string'
scope: resourceSymbolicName
identity: {
type: 'string'
}
properties: {
description: 'string'
displayName: 'string'
enforcementMode: 'string'
metadata: any()
nonComplianceMessages: [
{
message: 'string'
policyDefinitionReferenceId: 'string'
}
]
notScopes: [
'string'
]
parameters: {}
policyDefinitionId: 'string'
}
}
Valeurs de propriétés
policyAssignments
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) 1-24 (nom de la ressource dans l’étendue du groupe d’administration) 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. |
location | Emplacement de l’attribution de stratégie. Obligatoire uniquement lors de l’utilisation de l’identité managée. | string |
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. |
identité | Identité managée associée à l’attribution de stratégie. | Identité |
properties | Propriétés de l’affectation de stratégie. | PolicyAssignmentProperties |
Identité
Nom | Description | Valeur |
---|---|---|
type | Type d’identité. Il s’agit du seul champ obligatoire lors de l’ajout d’une identité affectée par le système à une ressource. | 'None' 'SystemAssigned' |
PolicyAssignmentProperties
Nom | Description | Valeur |
---|---|---|
description | Ce message fera partie de la réponse en cas de violation de stratégie. | string |
displayName | Nom d’affichage de l’attribution de stratégie. | string |
enforcementMode | Mode d’application de l’affectation de stratégie. Les valeurs possibles sont Default et DoNotEnforce. | 'Par défaut' 'DoNotEnforce' |
metadata | Métadonnées d’affectation 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(). |
nonComplianceMessages | Messages qui décrivent la raison pour laquelle une ressource n’est pas conforme à la stratégie. | Non-conformitéMessage[] |
notScopes | Étendues exclues de la stratégie. | string[] |
parameters | Valeurs de paramètre pour la règle de stratégie affectée. Les clés sont les noms des paramètres. | object |
policyDefinitionId | ID de la définition de stratégie ou de la définition de jeu de stratégies affectée. | string |
Non-conformitéMessage
Nom | Description | Valeur |
---|---|---|
message | Message qui décrit la raison pour laquelle une ressource n’est pas conforme à la stratégie. Cela s’affiche dans les messages d’erreur « refuser » et sur les résultats de conformité non conformes de la ressource. | chaîne (obligatoire) |
policyDefinitionReferenceId | ID de référence de définition de stratégie dans une définition de jeu de stratégies pour laquelle le message est destiné. Cela s’applique uniquement si l’affectation de stratégie affecte une définition d’ensemble de stratégies. Si ce n’est pas fourni, le message s’applique à toutes les stratégies affectées par cette attribution de stratégie. | string |
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 |
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 l’affecter à plusieurs groupes Mgmt |
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. |
Affecter une stratégie intégrée à un groupe de ressources existant |
Ce modèle affecte une stratégie intégrée à un groupe de ressources existant. |
Créer un gestionnaire de Réseau virtuel Azure et des exemples de réseaux virtuels |
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 ressources de modèle ARM
Le type de ressource policyAssignments 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.
Les étendues de déploiement valides pour la ressource policyAssignments sont les suivantes :
- Groupes de ressources - Voir commandes de déploiement de groupes de ressources
- Abonnements - Voir Commandes de déploiement d’abonnement
- Groupes d’administration - Voir Commandes de déploiement de groupe d’administration
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/policyAssignments, ajoutez le JSON suivant à votre modèle.
{
"type": "Microsoft.Authorization/policyAssignments",
"apiVersion": "2020-09-01",
"name": "string",
"location": "string",
"scope": "string",
"identity": {
"type": "string"
},
"properties": {
"description": "string",
"displayName": "string",
"enforcementMode": "string",
"metadata": {},
"nonComplianceMessages": [
{
"message": "string",
"policyDefinitionReferenceId": "string"
}
],
"notScopes": [ "string" ],
"parameters": {},
"policyDefinitionId": "string"
}
}
Valeurs de propriétés
policyAssignments
Nom | Description | Valeur |
---|---|---|
type | Type de ressource | « Microsoft.Authorization/policyAssignments » |
apiVersion | Version de l’API de ressource | '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) 1-24 (nom de la ressource dans l’étendue du groupe d’administration) 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. |
location | Emplacement de l’attribution de stratégie. Obligatoire uniquement lors de l’utilisation de l’identité managée. | string |
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 JSON, définissez la valeur sur le nom complet de la ressource à laquelle appliquer la ressource d’extension . |
identité | Identité managée associée à l’attribution de stratégie. | Identité |
properties | Propriétés de l’affectation de stratégie. | PolicyAssignmentProperties |
Identité
Nom | Description | Valeur |
---|---|---|
type | Type d’identité. Il s’agit du seul champ obligatoire lors de l’ajout d’une identité affectée par le système à une ressource. | 'None' 'SystemAssigned' |
PolicyAssignmentProperties
Nom | Description | Valeur |
---|---|---|
description | Ce message fera partie de la réponse en cas de violation de stratégie. | string |
displayName | Nom d’affichage de l’attribution de stratégie. | string |
enforcementMode | Mode d’application de l’affectation de stratégie. Les valeurs possibles sont Default et DoNotEnforce. | 'Par défaut' 'DoNotEnforce' |
metadata | Métadonnées d’affectation de stratégie. Les métadonnées sont un objet ouvert et sont généralement une collection de paires de valeurs de clé. | |
nonComplianceMessages | Messages qui décrivent la raison pour laquelle une ressource n’est pas conforme à la stratégie. | Non-conformitéMessage[] |
notScopes | Étendues exclues de la stratégie. | string[] |
parameters | Valeurs de paramètre pour la règle de stratégie affectée. Les clés sont les noms des paramètres. | object |
policyDefinitionId | ID de la définition de stratégie ou de la définition de jeu de stratégies affectée. | string |
Non-conformitéMessage
Nom | Description | Valeur |
---|---|---|
message | Message qui décrit la raison pour laquelle une ressource n’est pas conforme à la stratégie. Cela s’affiche dans les messages d’erreur « refuser » et sur les résultats de conformité non conformes de la ressource. | chaîne (obligatoire) |
policyDefinitionReferenceId | ID de référence de définition de stratégie dans une définition de jeu de stratégies pour laquelle le message est destiné. Cela s’applique uniquement si l’affectation de stratégie affecte une définition d’ensemble de stratégies. Si ce n’est pas fourni, le message s’applique à toutes les stratégies affectées par cette attribution de stratégie. | string |
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 |
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 l’affecter à plusieurs groupes Mgmt |
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. |
Affecter une stratégie intégrée à un groupe de ressources existant |
Ce modèle affecte une stratégie intégrée à un groupe de ressources existant. |
Créer un gestionnaire de Réseau virtuel Azure et des exemples de réseaux virtuels |
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 policyAssignments 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.
Les étendues de déploiement valides pour la ressource policyAssignments sont les suivantes :
- Groupes de ressources
- Abonnements
- Groupes d’administration
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/policyAssignments, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/policyAssignments@2020-09-01"
name = "string"
location = "string"
parent_id = "string"
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
description = "string"
displayName = "string"
enforcementMode = "string"
nonComplianceMessages = [
{
message = "string"
policyDefinitionReferenceId = "string"
}
]
notScopes = [
"string"
]
parameters = {}
policyDefinitionId = "string"
}
})
}
Valeurs de propriétés
policyAssignments
Nom | Description | Valeur |
---|---|---|
type | Type de ressource | « Microsoft.Authorization/policyAssignments@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) 1-24 (nom de la ressource dans l’étendue du groupe d’administration) 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. |
location | Emplacement de l’attribution de stratégie. Obligatoire uniquement lors de l’utilisation de l’identité managée. | string |
parent_id | ID de la ressource à laquelle appliquer cette ressource d’extension. | chaîne (obligatoire) |
identité | Identité managée associée à l’attribution de stratégie. | Identité |
properties | Propriétés de l’affectation de stratégie. | PolicyAssignmentProperties |
Identité
Nom | Description | Valeur |
---|---|---|
type | Type d’identité. Il s’agit du seul champ obligatoire lors de l’ajout d’une identité affectée par le système à une ressource. | « SystemAssigned » |
PolicyAssignmentProperties
Nom | Description | Valeur |
---|---|---|
description | Ce message fera partie de la réponse en cas de violation de stratégie. | string |
displayName | Nom d’affichage de l’attribution de stratégie. | string |
enforcementMode | Mode d’application de l’attribution de stratégie. Les valeurs possibles sont Default et DoNotEnforce. | « Par défaut » « DoNotEnforce » |
metadata | Métadonnées d’affectation de stratégie. Les métadonnées sont un objet ouvert et sont généralement une collection de paires clé-valeur. | |
nonComplianceMessages | Messages décrivant la raison pour laquelle une ressource n’est pas conforme à la stratégie. | NonComplianceMessage[] |
notScopes | Étendues exclues de la stratégie. | string[] |
parameters | Valeurs de paramètre pour la règle de stratégie affectée. Les clés sont les noms des paramètres. | object |
policyDefinitionId | ID de la définition de stratégie ou de la définition d’ensemble de stratégies affectée. | string |
NonComplianceMessage
Nom | Description | Valeur |
---|---|---|
message | Message qui décrit la raison pour laquelle une ressource n’est pas conforme à la stratégie. Cela est indiqué dans les messages d’erreur « refuser » et dans les résultats de conformité non conformes de la ressource. | string (obligatoire) |
policyDefinitionReferenceId | ID de référence de définition de stratégie dans une définition de jeu de stratégies pour laquelle le message est destiné. Cela s’applique uniquement si l’affectation de stratégie affecte une définition de jeu de stratégies. Si ce n’est pas fourni, le message s’applique à toutes les stratégies affectées par cette attribution de stratégie. | string |