Policy Assignments - Create By Id

Référence

Service:: Policy

API Version:: 2023-04-01

Crée ou met à jour une affectation de stratégie.
Cette opération crée ou met à jour l’affectation de stratégie avec l’ID donné. Les affectations de stratégie effectuées sur une étendue s’appliquent à toutes les ressources contenues dans cette étendue. Par exemple, lorsque vous affectez une stratégie à un groupe de ressources, cette stratégie s’applique à toutes les ressources du groupe. Les ID d’affectation de stratégie ont le format suivant : « {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} ». Les étendues valides sont les suivantes : 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}'.

PUT https://management.azure.com/{policyAssignmentId}?api-version=2023-04-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
policyAssignmentId	path	True	string	ID de l’affectation de stratégie à créer. Utilisez le format « {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} ».
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
identity	Identity	Identité managée associée à l’attribution de stratégie.
location	string	Emplacement de l’affectation de stratégie. Obligatoire uniquement lors de l’utilisation de l’identité managée.
properties.description	string	Ce message fera partie de la réponse en cas de violation de stratégie.
properties.displayName	string	Nom complet de l’affectation de stratégie.
properties.enforcementMode	enforcementMode	Mode d’application de l’attribution de stratégie. Les valeurs possibles sont Default et DoNotEnforce.
properties.metadata	object	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.
properties.nonComplianceMessages	NonComplianceMessage[]	Messages décrivant la raison pour laquelle une ressource n’est pas conforme à la stratégie.
properties.notScopes	string[]	Étendues exclues de la stratégie.
properties.overrides	Override[]	La valeur de la propriété de stratégie remplace.
properties.parameters	<string, ParameterValuesValue>	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 affectée.
properties.resourceSelectors	ResourceSelector[]	Liste de sélecteurs de ressources pour filtrer les stratégies par propriétés de ressource.

Réponses

Nom	Type	Description
201 Created	PolicyAssignment	Créé : retourne des informations sur l’attribution de stratégie.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update policy assignment by ID

Create or update policy assignment with a managed identity by ID

Create or update policy assignment by ID

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Sample Response

Status code:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  },
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Create or update policy assignment with a managed identity by ID

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  }
}

Sample Response

Status code:: 201

{
  "properties": {
    "displayName": "Enforce storage account SKU",
    "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created",
    "metadata": {
      "assignedBy": "Cheapskate Boss"
    },
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1",
    "notScopes": [],
    "parameters": {
      "listOfAllowedSKUs": {
        "value": [
          "Standard_GRS",
          "Standard_LRS"
        ]
      }
    },
    "enforcementMode": "Default"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "eastus",
  "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "LowCostStorage"
}

Définitions

Nom	Description
CloudError	Réponse d’erreur d’une opération de stratégie.
createdByType	Type d’identité qui a créé la ressource.
enforcementMode	Mode d’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. Les affectations de stratégie prennent en charge un maximum d’une identité. Il s’agit d’une identité affectée par le système ou d’une identité affectée par l’utilisateur unique.
NonComplianceMessage	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.
Override	La valeur de la propriété de stratégie remplace.
OverrideKind	Type de remplacement.
ParameterValuesValue	Valeur d’un paramètre.
PolicyAssignment	Affectation de stratégie.
ResourceIdentityType	Type d’identité. Il s’agit du seul champ obligatoire lors de l’ajout d’une identité affectée par le système ou l’utilisateur à une ressource.
ResourceSelector	Sélecteur de ressources permettant de filtrer les stratégies par propriétés de ressource.
Selector	Expression du sélecteur.
SelectorKind	Type de sélecteur.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UserAssignedIdentities	Identité de l’utilisateur associée à la stratégie. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

CloudError

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

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

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

Mode d’application de l’attribution de stratégie. Les valeurs possibles sont Default et DoNotEnforce.

Nom	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 stratégie n’est pas appliqué lors de la création ou de la mise à jour des ressources.

ErrorAdditionalInfo

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

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

Identity

Identité de la ressource. Les affectations de stratégie prennent en charge un maximum d’une identité. Il s’agit d’une identité affectée par le système ou d’une identité affectée par l’utilisateur unique.

Nom	Type	Description
principalId	string	ID principal de l’identité de ressource. Cette propriété est fournie uniquement pour une identité affectée par le système
tenantId	string	ID de locataire de l’identité de ressource. Cette propriété est fournie uniquement pour une identité affectée par le système
type	ResourceIdentityType	Type d’identité. Il s’agit du seul champ obligatoire lors de l’ajout d’une identité affectée par le système ou l’utilisateur à une ressource.
userAssignedIdentities	UserAssignedIdentities	Identité de l’utilisateur associée à la stratégie. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

NonComplianceMessage

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.

Nom	Type	Description
message	string	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.
policyDefinitionReferenceId	string	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.

Override

La valeur de la propriété de stratégie remplace.

Nom	Type	Description
kind	OverrideKind	Type de remplacement.
selectors	Selector[]	Liste des expressions du sélecteur.
value	string	Valeur à remplacer la propriété de stratégie.

OverrideKind

Type de remplacement.

Nom	Type	Description
policyEffect	string	Il remplacera le type d’effet de stratégie.

ParameterValuesValue

Valeur d’un paramètre.

Nom	Type	Description
value	object	Valeur du paramètre.