Policy Assignments - Create

Crée ou met à jour une attribution de stratégie.
Cette opération crée ou met à jour une attribution de stratégie avec l’étendue et le nom donnés. Les attributions de stratégie s’appliquent à toutes les ressources contenues dans leur étendue. Par exemple, lorsque vous affectez une stratégie au niveau de l’étendue du groupe de ressources, cette stratégie s’applique à toutes les ressources du groupe.

PUT https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2020-09-01

Paramètres URI

Name In Required Type Description
policyAssignmentName
path True
  • string

Nom de l’attribution de stratégie.

scope
path True
  • string

Portée de l’attribution de stratégie. Les étendues valides sont : groupe d’administration (format : « /providers/Microsoft.Management/managementGroups/{managementGroup} »), abonnement (format : « /subscriptions/{subscriptionId} »), groupe de ressources (format : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} » ou ressource (format : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/] {resourceType}/{resourceName} »

api-version
query True
  • string

Version de l’API à utiliser pour l’opération.

Corps de la demande

Name Type Description
identity

Identité gérée associée à l’attribution de stratégie.

location
  • string

Emplacement de l’attribution de stratégie. Obligatoire uniquement lors de l’utilisation d’une identité gérée.

properties.description
  • string

Ce message fera partie de la réponse en cas de violation de la stratégie.

properties.displayName
  • string

Nom complet de l’attribution de stratégie.

properties.enforcementMode

Mode de mise en application de l’attribution de stratégie. Les valeurs possibles sont default et DoNotEnforce.

properties.metadata
  • object

Métadonnées d’attribution de stratégie. Les métadonnées sont un objet fermé et est généralement une collection de paires clé-valeur.

properties.nonComplianceMessages

Messages qui décrivent la raison pour laquelle une ressource n’est pas conforme à la stratégie.

properties.notScopes
  • string[]

Étendues exclues de la stratégie.

properties.parameters

Valeurs de paramètre pour la règle de stratégie affectée. Les clés sont les noms des paramètres.

properties.policyDefinitionId
  • string

ID de la définition de stratégie ou de la définition d’ensemble de stratégies qui est assignée.

Réponses

Name Type Description
201 Created

Created-retourne des informations sur la nouvelle attribution de stratégie.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update a policy assignment
Create or update a policy assignment with a managed identity
Create or update a policy assignment with multiple non-compliance messages
Create or update a policy assignment without enforcing policy effect during resource creation or update.

Create or update a policy assignment

Sample Request

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2020-09-01
{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "nonComplianceMessages": [
      {
        "message": "Resource names must start with 'DeptA' and end with '-LC'."
      }
    ]
  }
}

Sample Response

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "nonComplianceMessages": [
      {
        "message": "Resource names must start with 'DeptA' and end with '-LC'."
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Create or update a policy assignment with a managed identity

Sample Request

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2020-09-01
{
  "location": "eastus",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Foo Bar"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default"
  }
}

Sample Response

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Create or update a policy assignment with multiple non-compliance messages

Sample Request

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/securityInitAssignment?api-version=2020-09-01
{
  "properties": {
    "displayName": "Enforce security policies",
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/securityInitiative",
    "nonComplianceMessages": [
      {
        "message": "Resources must comply with all internal security policies. See <internal site URL> for more info."
      },
      {
        "message": "Resource names must start with 'DeptA' and end with '-LC'.",
        "policyDefinitionReferenceId": "10420126870854049575"
      },
      {
        "message": "Storage accounts must have firewall rules configured.",
        "policyDefinitionReferenceId": "8572513655450389710"
      }
    ]
  }
}

Sample Response

{
  "properties": {
    "displayName": "Enforce security policies",
    "metadata": {
      "assignedBy": "User 1"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/securityInitiative",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "nonComplianceMessages": [
      {
        "message": "Resources must comply with all internal security policies. See <internal site URL> for more info."
      },
      {
        "message": "Resource names must start with 'DeptA' and end with '-LC'.",
        "policyDefinitionReferenceId": "10420126870854049575"
      },
      {
        "message": "Storage accounts must have firewall rules configured.",
        "policyDefinitionReferenceId": "8572513655450389710"
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/securityInitAssignment",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "securityInitAssignment"
}

Create or update a policy assignment without enforcing policy effect during resource creation or update.

Sample Request

PUT https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2020-09-01
{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "DoNotEnforce"
  }
}

Sample Response

{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "DoNotEnforce",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Définitions

CloudError

Réponse d’erreur d’une opération de stratégie.

enforcementMode

Mode de mise en application de l’attribution de stratégie. Les valeurs possibles sont default et DoNotEnforce.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorResponse

Réponse d’erreur

Identity

Identité de la ressource.

NonComplianceMessage

Message qui décrit la raison pour laquelle une ressource n’est pas conforme à la stratégie. Cela est illustré dans les messages d’erreur « refuser » et les résultats de conformité de la ressource non conformes.

ParameterValuesValue

Valeur d’un paramètre.

PolicyAssignment

Attribution de stratégie.

ResourceIdentityType

Type d’identité. Il s’agit du seul champ obligatoire lorsque vous ajoutez une identité attribuée au système à une ressource.

CloudError

Réponse d’erreur d’une opération de stratégie.

Name Type Description
error

Réponse d’erreur
Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

enforcementMode

Mode de mise en application de l’attribution de stratégie. Les valeurs possibles sont default et DoNotEnforce.

Name Type Description
Default
  • string

L’effet de stratégie est appliqué pendant la création ou la mise à jour d’une ressource.

DoNotEnforce
  • string

L’effet de la stratégie n’est pas appliqué pendant la création ou la mise à jour des ressources.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Name Type Description
info
  • object

Informations supplémentaires.

type
  • string

Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Name Type Description
additionalInfo

Informations supplémentaires sur l’erreur.

code
  • string

Code d'erreur.

details

Détails de l’erreur.

message
  • string

Message d’erreur.

target
  • string

Cible de l’erreur.

Identity

Identité de la ressource.

Name Type Description
principalId
  • string

ID du principal de l’identité de la ressource.

tenantId
  • string

ID de locataire de l’identité de la ressource.

type

Type d’identité. Il s’agit du seul champ obligatoire lorsque vous ajoutez une identité attribuée au système à une ressource.

NonComplianceMessage

Message qui décrit la raison pour laquelle une ressource n’est pas conforme à la stratégie. Cela est illustré dans les messages d’erreur « refuser » et les résultats de conformité de la ressource non conformes.

Name Type Description
message
  • string

Message qui décrit la raison pour laquelle une ressource n’est pas conforme à la stratégie. Cela est illustré dans les messages d’erreur « refuser » et les résultats de conformité de la ressource non conformes.

policyDefinitionReferenceId
  • string

ID de référence de définition de stratégie dans une définition d’ensemble de stratégies à laquelle le message est destiné. Cela s’applique uniquement si l’attribution de stratégie affecte une définition d’ensemble de stratégies. Si ce n’est pas le cas, le message s’applique à toutes les stratégies affectées par cette attribution de stratégie.

ParameterValuesValue

Valeur d’un paramètre.

Name Type Description
value
  • object

Valeur du paramètre.

PolicyAssignment

Attribution de stratégie.

Name Type Description
id
  • string

ID de l’attribution de stratégie.

identity

Identité gérée associée à l’attribution de stratégie.

location
  • string

Emplacement de l’attribution de stratégie. Obligatoire uniquement lors de l’utilisation d’une identité gérée.

name
  • string

Nom de l’attribution de stratégie.

properties.description
  • string

Ce message fera partie de la réponse en cas de violation de la stratégie.

properties.displayName
  • string

Nom complet de l’attribution de stratégie.

properties.enforcementMode

Mode de mise en application de l’attribution de stratégie. Les valeurs possibles sont default et DoNotEnforce.

properties.metadata
  • object

Métadonnées d’attribution de stratégie. Les métadonnées sont un objet fermé et est généralement une collection de paires clé-valeur.

properties.nonComplianceMessages

Messages qui décrivent la raison pour laquelle une ressource n’est pas conforme à la stratégie.

properties.notScopes
  • string[]

Étendues exclues de la stratégie.

properties.parameters

Valeurs de paramètre pour la règle de stratégie affectée. Les clés sont les noms des paramètres.

properties.policyDefinitionId
  • string

ID de la définition de stratégie ou de la définition d’ensemble de stratégies qui est assignée.

properties.scope
  • string

Étendue de l’attribution de stratégie.

type
  • string

Type de l’attribution de stratégie.

ResourceIdentityType

Type d’identité. Il s’agit du seul champ obligatoire lorsque vous ajoutez une identité attribuée au système à une ressource.

Name Type Description
None
  • string

Indique qu’aucune identité n’est associée à la ressource ou que l’identité existante doit être supprimée.

SystemAssigned
  • string

Indique qu’une identité affectée par le système est associée à la ressource.