Policy Assignments - Get By Id
L’opération récupère l’affectation de stratégie avec l’ID donné. 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}'.
GET https://management.azure.com/{policyAssignmentId}?api-version=2023-04-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
policy
|
path | True |
string |
ID de l’affectation de stratégie à obtenir. Utilisez le format « {scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} ». |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
OK : retourne des informations sur l’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
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
Retrieve a policy assignment by ID |
Retrieve a policy assignment with a managed identity by ID |
Retrieve a policy assignment by ID
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01
Sample Response
{
"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"
}
Retrieve a policy assignment with a managed identity by ID
Sample Request
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage?api-version=2023-04-01
Sample Response
{
"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": "westus",
"id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage",
"type": "Microsoft.Authorization/policyAssignments",
"name": "LowCostStorage"
}
Définitions
Nom | Description |
---|---|
Cloud |
Réponse d’erreur d’une opération de stratégie. |
created |
Type d’identité qui a créé la ressource. |
enforcement |
Mode d’application de l’affectation de stratégie. Les valeurs possibles sont Default et DoNotEnforce. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
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. |
Non |
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. |
Override |
Type de remplacement. |
Parameter |
Valeur d’un paramètre. |
Policy |
Affectation de stratégie. |
Resource |
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. |
Resource |
Sélecteur de ressources pour filtrer les stratégies par propriétés de ressource. |
Selector |
Expression du sélecteur. |
Selector |
Type de sélecteur. |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
User |
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 |
Réponse d’erreur |
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 |
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 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 |
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 |
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 |
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. |
PolicyAssignment
Affectation de stratégie.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
id |
string |
ID de l’attribution de stratégie. |
|
identity |
Identité managée associée à l’attribution de stratégie. |
||
location |
string |
Emplacement de l’attribution de stratégie. Obligatoire uniquement lors de l’utilisation de l’identité managé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 stratégie. |
|
properties.displayName |
string |
Nom d’affichage de l’attribution de stratégie. |
|
properties.enforcementMode | Default |
Mode d’application de l’affectation 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 de valeurs de clé. |
|
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.overrides |
Override[] |
La valeur de la propriété de stratégie remplace. |
|
properties.parameters |
<string,
Parameter |
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 de jeu de stratégies affectée. |
|
properties.resourceSelectors |
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 |
Métadonnées système relatives à cette ressource. |
||
type |
string |
Type de l’attribution 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 du sélecteur. |
Selector
Expression du sélecteur.
Nom | Type | Description |
---|---|---|
in |
string[] |
Liste des valeurs à filtrer. |
kind |
Type de sélecteur. |
|
notIn |
string[] |
Liste des valeurs à filtrer. |
SelectorKind
Type de sélecteur.
Nom | Type | Description |
---|---|---|
policyDefinitionReferenceId |
string |
Type de sélecteur permettant de 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 en fonction de l’emplacement de la ressource. |
resourceType |
string |
Type de sélecteur permettant de filtrer les stratégies par type de ressource. |
resourceWithoutLocation |
string |
Type de sélecteur permettant de filtrer les stratégies en fonction de 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 |
Type d’identité qui a créé la ressource. |
|
lastModifiedAt |
string |
Horodatage de la dernière modification de la ressource (UTC) |
lastModifiedBy |
string |
Identité qui a modifié la dernière ressource. |
lastModifiedByType |
Type d’identité qui a modifié la dernière 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} ».
Nom | Type | Description |
---|---|---|
|