Component Policy States - List Query Results For Subscription
Fragt Komponentenrichtlinienzustände im Abonnementbereich ab.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/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}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
component
|
path | True |
Die virtuelle Ressource unter Dem Ressourcentyp ComponentPolicyStates. In einem bestimmten Zeitbereich stellt "latest" den aktuellen Komponentenrichtlinienstatus dar. |
|
subscription
|
path | True |
string |
Microsoft Azure-Abonnement-ID. |
api-version
|
query | True |
string |
Client-API-Version. |
$apply
|
query |
string |
OData-Ausdruck für Aggregationen anwenden. |
|
$filter
|
query |
string |
OData-Filterausdruck. |
|
$from
|
query |
string date-time |
ISO 8601-formatierter Zeitstempel, der die Startzeit des Abfrageintervalls angibt. Wenn nicht angegeben, verwendet der Dienst ($to – 1 Tag). |
|
$orderby
|
query |
string |
Ordnen des Ausdrucks mithilfe der OData-Notation. Ein oder mehrere durch Trennzeichen getrennte Spaltennamen mit optionalem "desc" (Standard) oder "asc", z. B. "$orderby=PolicyAssignmentId, ResourceId asc". |
|
$select
|
query |
string |
Wählen Sie den Ausdruck mithilfe der OData-Notation aus. Schränkt die Spalten für jeden Datensatz auf die angeforderten ein, z. B. "$select=PolicyAssignmentId, ResourceId". |
|
$to
|
query |
string date-time |
ISO 8601-formatierter Zeitstempel, der die Endzeit des Abfrageintervalls angibt. Wenn dies nicht angegeben ist, verwendet der Dienst die Anforderungszeit. |
|
$top
|
query |
integer int32 |
Maximale Anzahl von Datensätzen, die zurückgegeben werden sollen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Abfrageergebnisse. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Query latest component policy compliance state count grouped by component type at subscription scope filtered by given assignment. |
Query latest component policy states at subscription scope |
Query latest component policy compliance state count grouped by component type at subscription scope filtered by given assignment.
Sample Request
POST https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/Microsoft.PolicyInsights/componentPolicyStates/latest/queryResults?api-version=2022-04-01&$filter=policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'&$apply=groupby((componentType,complianceState),aggregate($count as count))
Sample Response
{
"@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/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 subscription scope
Sample Request
POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/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/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/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/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"
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Component |
Auswertungsdetails von Richtliniensprachausdrücken. |
Component |
Details zur Richtlinienauswertung. |
Component |
Komponentenrichtlinienstatusdatensatz. |
Component |
Abfrageergebnisse. |
Component |
Die virtuelle Ressource unter Dem Ressourcentyp ComponentPolicyStates. In einem bestimmten Zeitbereich stellt "latest" den aktuellen Komponentenrichtlinienstatus dar. |
Error |
Fehlerdefinition. |
Error |
Fehlerantwort. |
Typed |
Szenariospezifische Fehlerdetails. |
ComponentExpressionEvaluationDetails
Auswertungsdetails von Richtliniensprachausdrücken.
Name | Typ | Beschreibung |
---|---|---|
expression |
string |
Ausdruck ausgewertet. |
expressionKind |
string |
Die Art des Ausdrucks, der ausgewertet wurde. |
expressionValue |
object |
Wert des Ausdrucks. |
operator |
string |
Operator zum Vergleichen des Ausdruckswerts und des Zielwerts. |
path |
string |
Eigenschaftenpfad, wenn der Ausdruck ein Feld oder ein Alias ist. |
result |
string |
Auswertungsergebnis. |
targetValue |
object |
Zielwert, der mit dem Ausdruckswert verglichen werden soll. |
ComponentPolicyEvaluationDetails
Details zur Richtlinienauswertung.
Name | Typ | Beschreibung |
---|---|---|
evaluatedExpressions |
Details der ausgewerteten Ausdrücke. |
|
reason |
string |
Zusätzlicher textlicher Grund für das Bewertungsergebnis. |
ComponentPolicyState
Komponentenrichtlinienstatusdatensatz.
Name | Typ | Beschreibung |
---|---|---|
@odata.context |
string |
OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen. |
@odata.id |
string |
OData-Entitäts-ID; immer auf NULL festgelegt, da Komponentenrichtlinienstatusdatensätze keine Entitäts-ID aufweisen. |
complianceState |
string |
Kompatibilitätsstatus der Ressource. |
componentId |
string |
Komponenten-ID. |
componentName |
string |
Komponentenname |
componentType |
string |
Komponententyp. |
policyAssignmentId |
string |
Richtlinienzuweisungs-ID. |
policyAssignmentName |
string |
Name der Richtlinienzuweisung. |
policyAssignmentOwner |
string |
Richtlinienzuweisungsbesitzer. |
policyAssignmentParameters |
string |
Richtlinienzuweisungsparameter. |
policyAssignmentScope |
string |
Richtlinienzuweisungsbereich. |
policyAssignmentVersion |
string |
Ausgewertete Richtlinienzuweisungsversion. |
policyDefinitionAction |
string |
Richtliniendefinitionsaktion, d. h. Wirkung. |
policyDefinitionCategory |
string |
Richtliniendefinitionskategorie. |
policyDefinitionGroupNames |
string[] |
Richtliniendefinitionsgruppennamen. |
policyDefinitionId |
string |
Richtliniendefinitions-ID. |
policyDefinitionName |
string |
Richtliniendefinitionsname. |
policyDefinitionReferenceId |
string |
Referenz-ID für die Richtliniendefinition innerhalb des Richtliniensatzes, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt. |
policyDefinitionVersion |
string |
Ausgewertete Richtliniendefinitionsversion. |
policyEvaluationDetails |
Details zur Richtlinienauswertung. Dies ist nur in der Antwort enthalten, wenn die Anforderung $expand=PolicyEvaluationDetails enthält. |
|
policySetDefinitionCategory |
string |
Richtliniensatzdefinitionskategorie, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt. |
policySetDefinitionId |
string |
Richtliniensatzdefinitions-ID, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt. |
policySetDefinitionName |
string |
Richtliniensatzdefinitionsname, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt. |
policySetDefinitionOwner |
string |
Richtliniensatzdefinitionsbesitzer, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt. |
policySetDefinitionParameters |
string |
Richtliniensatzdefinitionsparameter, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt. |
policySetDefinitionVersion |
string |
Ausgewertete Richtliniensatzdefinitionsversion. |
resourceGroup |
string |
Ressourcengruppenname |
resourceId |
string |
Ressourcen-ID |
resourceLocation |
string |
Ressourcenspeicherort |
resourceType |
string |
Der Ressourcentyp. |
subscriptionId |
string |
Abonnement-ID |
timestamp |
string |
Zeitstempel für den Komponentenrichtlinienstatusdatensatz. |
ComponentPolicyStatesQueryResults
Abfrageergebnisse.
Name | Typ | Beschreibung |
---|---|---|
@odata.context |
string |
OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen. |
@odata.count |
integer |
Anzahl der OData-Entitäten; stellt die Anzahl der zurückgegebenen Richtlinienstatusdatensätze dar. |
value |
Abfrageergebnisse. |
ComponentPolicyStatesResource
Die virtuelle Ressource unter Dem Ressourcentyp ComponentPolicyStates. In einem bestimmten Zeitbereich stellt "latest" den aktuellen Komponentenrichtlinienstatus dar.
Name | Typ | Beschreibung |
---|---|---|
latest |
string |
ErrorDefinition
Fehlerdefinition.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Zusätzliche szenariospezifische Fehlerdetails. |
|
code |
string |
Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient. |
details |
Interne Fehlerdetails. |
|
message |
string |
Beschreibung des Fehlers |
target |
string |
Das Ziel des Fehlers. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Fehlerdetails. |
TypedErrorInfo
Szenariospezifische Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
info |
Die szenariospezifischen Fehlerdetails. |
|
type |
string |
Der Typ der enthaltenen Fehlerdetails. |