Component Policy States - List Query Results For Resource Group
Interroge les états de stratégie des composants sous l’étendue du groupe de ressources.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
component
|
path | True |
Type de ressource virtuel sous ComponentPolicyStates. Dans un intervalle de temps donné, « latest » représente le ou les derniers états de stratégie de composant. |
|
resource
|
path | True |
string |
Nom du groupe de ressources. |
subscription
|
path | True |
string |
ID d’abonnement Microsoft Azure. |
api-version
|
query | True |
string |
Version de l’API cliente. |
$apply
|
query |
string |
Appliquer une expression OData pour les agrégations. |
|
$filter
|
query |
string |
Expression de filtre OData. |
|
$from
|
query |
string date-time |
Horodatage au format ISO 8601 spécifiant l’heure de début de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise ($to - 1 jour). |
|
$orderby
|
query |
string |
Classement de l’expression à l’aide de la notation OData. Un ou plusieurs noms de colonnes séparés par des virgules avec un « desc » facultatif (valeur par défaut) ou « asc », par exemple « $orderby=PolicyAssignmentId, ResourceId asc ». |
|
$select
|
query |
string |
Sélectionnez une expression à l’aide de la notation OData. Limite les colonnes de chaque enregistrement à celles demandées, par exemple « $select=PolicyAssignmentId, ResourceId ». |
|
$to
|
query |
string date-time |
Horodatage au format ISO 8601 spécifiant l’heure de fin de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise l’heure de la demande. |
|
$top
|
query |
integer int32 |
Nombre maximal d’enregistrements à retourner. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Résultats de la requête. |
|
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
Query latest component policy compliance state count grouped by component type at resource group scope filtered by given assignment. |
Query latest component policy states at resource group scope |
Query latest component policy compliance state count grouped by component type at resource group scope filtered by given assignment.
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$filter=policyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'&$apply=groupby((type,complianceState),aggregate($count as count))
Sample Response
{
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
"@odata.count": 2,
"value": [
{
"componentType": "Certificate",
"complianceState": "NonCompliant",
"count": 26
},
{
"componentType": "Certificate",
"complianceState": "Compliant",
"count": 10
}
]
}
Query latest component policy states at resource group scope
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01
Sample Response
{
"@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest",
"@odata.count": 2,
"value": [
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
"componentId": "cert-RSA-cert-3",
"componentType": "Certificate",
"componentName": "cert-RSA-cert-3",
"timestamp": "2022-04-09T16:04:31Z",
"resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
"policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test",
"policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56",
"subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
"resourceType": "/Microsoft.KeyVault/vaults",
"resourceLocation": "eastus",
"resourceGroup": "myResourceGroup",
"policyAssignmentName": "test",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": null,
"policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
"policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df56",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"policyDefinitionReferenceId": null,
"complianceState": "NonCompliant",
"complianceReasonCode": "tbd",
"policyDefinitionGroupNames": [
"myGroup"
],
"policyDefinitionVersion": "1.0.0-preview",
"policySetDefinitionVersion": null,
"policyAssignmentVersion": "1.0.0"
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity",
"componentId": "cert-RSA-cert-2",
"componentType": "Certificate",
"componentName": "cert-RSA-cert-2",
"timestamp": "2022-04-09T16:04:31Z",
"resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName",
"policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test",
"policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59",
"subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5",
"resourceType": "/Microsoft.KeyVault/vaults",
"resourceLocation": "eastus",
"resourceGroup": "myResourceGroup",
"policyAssignmentName": "test",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": null,
"policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5",
"policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"policyDefinitionReferenceId": null,
"complianceState": "NonCompliant",
"complianceReasonCode": "tbd",
"policyDefinitionGroupNames": [
"myGroup"
],
"policyDefinitionVersion": "1.0.0-preview",
"policySetDefinitionVersion": null,
"policyAssignmentVersion": "1.0.0"
}
]
}
Définitions
Nom | Description |
---|---|
Component |
Détails de l’évaluation des expressions de langage de stratégie. |
Component |
Détails de l’évaluation de la stratégie. |
Component |
Enregistrement d’état de la stratégie de composant. |
Component |
Résultats de la requête. |
Component |
Type de ressource virtuel sous ComponentPolicyStates. Dans un intervalle de temps donné, « latest » représente le ou les derniers états de stratégie de composant. |
Error |
Définition de l’erreur. |
Error |
Réponse d’erreur. |
Typed |
Détails de l’erreur spécifique au scénario. |
ComponentExpressionEvaluationDetails
Détails de l’évaluation des expressions de langage de stratégie.
Nom | Type | Description |
---|---|---|
expression |
string |
Expression évaluée. |
expressionKind |
string |
Type d’expression qui a été évalué. |
expressionValue |
object |
Valeur de l’expression. |
operator |
string |
Opérateur pour comparer la valeur d’expression et la valeur cible. |
path |
string |
Chemin d’accès à la propriété si l’expression est un champ ou un alias. |
result |
string |
Résultat de l’évaluation. |
targetValue |
object |
Valeur cible à comparer à la valeur d’expression. |
ComponentPolicyEvaluationDetails
Détails de l’évaluation de la stratégie.
Nom | Type | Description |
---|---|---|
evaluatedExpressions |
Détails des expressions évaluées. |
|
reason |
string |
Raison textuelle supplémentaire pour le résultat de l’évaluation. |
ComponentPolicyState
Enregistrement d’état de la stratégie de composant.
Nom | Type | Description |
---|---|---|
@odata.context |
string |
Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées. |
@odata.id |
string |
ID d’entité OData ; toujours défini sur null, car les enregistrements d’état de stratégie de composant n’ont pas d’ID d’entité. |
complianceState |
string |
État de conformité de la ressource. |
componentId |
string |
ID du composant. |
componentName |
string |
Nom du composant. |
componentType |
string |
Type de composant. |
policyAssignmentId |
string |
ID d’affectation de stratégie. |
policyAssignmentName |
string |
Nom de l’affectation de stratégie. |
policyAssignmentOwner |
string |
Propriétaire de l’affectation de stratégie. |
policyAssignmentParameters |
string |
Paramètres d’affectation de stratégie. |
policyAssignmentScope |
string |
Étendue de l’affectation de stratégie. |
policyAssignmentVersion |
string |
Version d’affectation de stratégie évaluée. |
policyDefinitionAction |
string |
Action de définition de stratégie, c’est-à-dire effet. |
policyDefinitionCategory |
string |
Catégorie de définition de stratégie. |
policyDefinitionGroupNames |
string[] |
Noms des groupes de définitions de stratégie. |
policyDefinitionId |
string |
ID de définition de stratégie. |
policyDefinitionName |
string |
Nom de la définition de stratégie. |
policyDefinitionReferenceId |
string |
ID de référence pour la définition de stratégie à l’intérieur de l’ensemble de stratégies, si l’affectation de stratégie concerne un ensemble de stratégies. |
policyDefinitionVersion |
string |
Version de définition de stratégie évaluée. |
policyEvaluationDetails |
Détails de l’évaluation de la stratégie. Cela n’est inclus dans la réponse que si la demande contient $expand=PolicyEvaluationDetails. |
|
policySetDefinitionCategory |
string |
Catégorie de définition d’ensemble de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies. |
policySetDefinitionId |
string |
ID de définition de jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies. |
policySetDefinitionName |
string |
Nom de la définition du jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies. |
policySetDefinitionOwner |
string |
Propriétaire de la définition d’un jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies. |
policySetDefinitionParameters |
string |
Paramètres de définition de jeu de stratégies, si l’attribution de stratégie est destinée à un ensemble de stratégies. |
policySetDefinitionVersion |
string |
Version de définition d’ensemble de stratégies évaluée. |
resourceGroup |
string |
Nom du groupe de ressources. |
resourceId |
string |
ID de la ressource |
resourceLocation |
string |
Emplacement de la ressource. |
resourceType |
string |
Type de ressource. |
subscriptionId |
string |
l'ID d'abonnement. |
timestamp |
string |
Horodatage de l’enregistrement d’état de la stratégie de composant. |
ComponentPolicyStatesQueryResults
Résultats de la requête.
Nom | Type | Description |
---|---|---|
@odata.context |
string |
Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées. |
@odata.count |
integer |
Nombre d’entités OData ; représente le nombre d’enregistrements d’état de stratégie retournés. |
value |
Résultats de la requête. |
ComponentPolicyStatesResource
Type de ressource virtuel sous ComponentPolicyStates. Dans un intervalle de temps donné, « latest » représente le ou les derniers états de stratégie de composant.
Nom | Type | Description |
---|---|---|
latest |
string |
ErrorDefinition
Définition de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Détails d’erreur supplémentaires spécifiques au scénario. |
|
code |
string |
Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP. |
details |
Détails de l’erreur interne. |
|
message |
string |
Description de l'erreur. |
target |
string |
Cible de l’erreur. |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Détails de l’erreur. |
TypedErrorInfo
Détails de l’erreur spécifique au scénario.
Nom | Type | Description |
---|---|---|
info |
Détails de l’erreur spécifique au scénario. |
|
type |
string |
Type de détails d’erreur inclus. |