Policy Assignments - List

Référence

Service:: Policy

API Version:: 2023-04-01

Récupère toutes les affectations de stratégie qui s’appliquent à un abonnement.
Cette opération récupère la liste de toutes les affectations de stratégie associées à l’abonnement donné qui correspondent à la $filter facultative donnée. Les valeurs valides pour $filter sont : « atScope() », « atExactScope() » ou « policyDefinitionId eq « {value} ». Si $filter n’est pas fourni, la liste non filtrée inclut toutes les affectations de stratégie associées à l’abonnement, y compris celles qui s’appliquent directement ou à partir de groupes d’administration qui contiennent l’abonnement donné, ainsi que toutes les affectations appliquées aux objets contenus dans l’abonnement. Si $filter=atScope() est fourni, la liste retournée inclut toutes les affectations de stratégie qui s’appliquent à l’abonnement, à savoir tout ce qui se trouve dans la liste non filtrée, à l’exception de celles appliquées aux objets contenus dans l’abonnement. Si $filter=atExactScope() est fourni, la liste retournée inclut uniquement toutes les affectations de stratégie de l’abonnement. Si $filter=policyDefinitionId eq « {value} » est fourni, la liste retournée inclut toutes les affectations de stratégie de la définition de stratégie dont l’ID est {value}.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments?api-version=2023-04-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$top={$top}&api-version=2023-04-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string uuid	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$filter	query		string	Filtre à appliquer à l’opération. Les valeurs valides pour $filter sont : « atScope() », « atExactScope() » ou « policyDefinitionId eq « {value} ». Si $filter n’est pas fourni, aucun filtrage n’est effectué. Si $filter=atScope() est fourni, la liste retournée inclut uniquement toutes les affectations de stratégie qui s’appliquent à l’étendue, à savoir tout ce qui se trouve dans la liste non filtrée, à l’exception de celles appliquées aux sous-étendues contenues dans l’étendue donnée. Si $filter=atExactScope() est fourni, la liste retournée inclut uniquement toutes les affectations de stratégie qui se situent dans l’étendue donnée. Si $filter=policyDefinitionId eq « {value} » est fourni, la liste retournée inclut toutes les affectations de stratégie de la définition de stratégie dont l’ID est {value}.
$top	query		integer int32	Nombre maximal d’enregistrements à retourner. Lorsque le filtre $top n’est pas fourni, il retourne 500 enregistrements.

Réponses

Nom	Type	Description
200 OK	PolicyAssignmentListResult	OK : retourne un tableau d’attributions 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

List policy assignments that apply to a subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments?$filter=atScope()&api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "CostManagement",
      "location": "eastus",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      },
      "properties": {
        "displayName": "Storage Cost Management",
        "description": "Minimize the risk of accidental cost overruns",
        "metadata": {
          "category": "Cost Management"
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/TagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    }
  ]
}

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’affectation 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 un seul utilisateur.
NonComplianceMessage	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.
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.
PolicyAssignmentListResult	Liste des affectations 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 pour 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é d’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’affectation 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 un seul utilisateur.

Nom	Type	Description
principalId	string	ID principal de l’identité de ressource. Cette propriété sera fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité de ressource. Cette propriété sera 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é d’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 s’affiche dans les messages d’erreur « refuser » et sur 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 s’affiche dans les messages d’erreur « refuser » et sur 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 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.

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.