Partager via

Policy Assignments - List

  • Référence
Service:
Policy
Version d'API:
2023-04-01

Récupère toutes les attributions 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 attributions 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 les objets appliqués aux objets contenus dans l’abonnement. Si $filter=atScope() est fourni, la liste retournée inclut toutes les attributions de stratégie qui s’appliquent à l’abonnement, qui est tout dans la liste non filtrée, sauf celles appliquées aux objets contenus dans l’abonnement. Si $filter=atExactScope() est fourni, la liste retournée inclut uniquement toutes les attributions de stratégie qui se situent dans l’abonnement. Si $filter=policyDefinitionId eq '{value}' est fourni, la liste retournée inclut toutes les attributions 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
Avec des paramètres facultatifs: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$expand={$expand}&$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.
$expand
 query

string

Liste séparée par des virgules des propriétés supplémentaires à inclure dans la réponse. Les valeurs prises en charge sont « LatestDefinitionVersion, EffectiveDefinitionVersion ».
$filter
 query

string

Filtre à appliquer sur 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 renvoyée inclut uniquement toutes les attributions de stratégie qui s’appliquent à l’étendue, qui est tout dans la liste non filtrée, sauf 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 attributions 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’affectations de stratégie.
Other Status Codes

CloudError

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

List policy assignments that apply to a subscription

Exemple de requête

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

Exemple de réponse

Code d’état:
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",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "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",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "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’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 un seul utilisateur.
NonComplianceMessage

Message décrivant pourquoi 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

Remplacement de la valeur de propriété de stratégie.
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 de 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 seront des ID de ressource ARM sous la forme : « /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 afin de retourner les détails de l’erreur pour 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é lors de la création ou de la mise à jour des ressources.
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émentaire.

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é de l’utilisateur associée à la stratégie. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

NonComplianceMessage

Message décrivant pourquoi 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 décrivant pourquoi 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’attribution de stratégie affecte une définition d’ensemble de stratégies. S’il n’est pas fourni, le message s’applique à toutes les stratégies affectées par cette affectation de stratégie.

Override

Remplacement de la valeur de propriété de stratégie.

Nom Type Description
kind

OverrideKind

Type de remplacement.
selectors

Selector[]

Liste des expressions de sélecteur.
value

string

Valeur à remplacer la propriété de stratégie.

OverrideKind

Type de remplacement.

Nom Type Description
policyEffect

string

Il remplace le type d’effet de stratégie.

ParameterValuesValue

Valeur d’un paramètre.

Nom Type Description
value

object

Valeur du paramètre.

PolicyAssignment

Affectation de stratégie.

Nom Type Valeur par défaut Description
id

string

ID de l’affectation de stratégie.
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.
name

string

Nom de l’attribution de stratégie.
properties.definitionVersion

string

Version de la définition de stratégie à utiliser.
properties.description

string

Ce message fait partie de la réponse en cas de violation de stratégie.
properties.displayName

string

Nom complet de l’attribution de stratégie.
properties.effectiveDefinitionVersion

string

Version effective de la définition de stratégie en cours d’utilisation. Ceci n’est présent que s’il est demandé via le paramètre de requête $expand.
properties.enforcementMode

enforcementMode

Default

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

string

Dernière version de la définition de stratégie disponible. Ceci n’est présent que s’il est demandé via le paramètre de requête $expand.
properties.metadata

object

Métadonnées d’attribution 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 qui décrivent pourquoi une ressource n’est pas conforme à la stratégie.
properties.notScopes

string[]

Étendues exclues de la stratégie.
properties.overrides

Override[]

Remplacement de la valeur de propriété de stratégie.
properties.parameters

<string,  ParameterValuesValue>

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

string

ID de la définition de stratégie ou de la définition de jeu de stratégies attribuée.
properties.resourceSelectors

ResourceSelector[]

Liste de sélecteurs de ressources pour filtrer les stratégies par propriétés de ressource.
properties.scope

string

Étendue de l’attribution de stratégie.
systemData

systemData

Métadonnées système relatives à cette ressource.
type

string

Type de l’affectation de stratégie.

PolicyAssignmentListResult

Liste des affectations de stratégie.

Nom Type Description
nextLink

string

URL à utiliser pour obtenir l’ensemble de résultats suivant.
value

PolicyAssignment[]

Tableau d’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.

Nom 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.
UserAssigned

string

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

ResourceSelector

Sélecteur de ressources pour filtrer les stratégies par propriétés de ressource.

Nom Type Description
name

string

Nom du sélecteur de ressources.
selectors

Selector[]

Liste des expressions de sélecteur.

Selector

Expression de sélecteur.

Nom Type Description
in

string[]

Liste des valeurs à filtrer.
kind

SelectorKind

Type de sélecteur.
notIn

string[]

Liste des valeurs à filtrer.

SelectorKind

Type de sélecteur.

Nom Type Description
policyDefinitionReferenceId

string

Type de sélecteur pour filtrer les stratégies par l’ID de référence de définition de stratégie.
resourceLocation

string

Type de sélecteur pour filtrer les stratégies selon l’emplacement de la ressource.
resourceType

string

Type de sélecteur pour filtrer les stratégies par type de ressource.
resourceWithoutLocation

string

Type de sélecteur pour filtrer les stratégies par la ressource sans emplacement.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

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

string

Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UserAssignedIdentities

Identité de l’utilisateur associée à la stratégie. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

Nom Type Description