Policy States - List Query Results For Resource Group

Dienst:: Policy

API-Version:: 2024-10-01

Abfragerichtlinienstatus für die Ressourcen unter der Ressourcengruppe.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2024-10-01

Mit optionalen Parametern:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2024-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
policyStatesResource	path	True	PolicyStatesResource	Die virtuelle Ressource unter dem Ressourcentyp "PolicyStates". In einem bestimmten Zeitraum stellt "latest" den neuesten Richtlinienzustand(n) dar, während "Standard" alle Richtlinienzustände darstellt.
resourceGroupName	path	True	string	Ressourcengruppenname.
subscriptionId	path	True	string	Microsoft Azure Subscription ID.
api-version	query	True	string	Client-API-Version.
$apply	query		string	OData wendet einen Ausdruck für Aggregationen an.
$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	Sortierungsausdruck mithilfe der OData-Schreibweise. Ein oder mehrere durch Trennzeichen getrennte Spaltennamen mit einem optionalen "desc" (Standard) oder "asc", z. B. "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Wählen Sie einen Ausdruck mit der OData-Schreibweise aus. Beschränkt die Spalten für jeden Datensatz auf die angeforderten Datensätze, z. B. "$select=PolicyAssignmentId, ResourceId".
$skiptoken	query		string	Skiptoken wird nur bereitgestellt, wenn eine vorherige Antwort ein Teilergebnis als Teil des nextLink-Elements zurückgegeben hat.
$to	query		string (date-time)	ISO 8601-formatierter Zeitstempel, der die Endzeit des abzufragenden Intervalls angibt. Wenn nicht angegeben, verwendet der Dienst die Anforderungszeit.
$top	query		integer (int32) minimum: 0	Maximale Anzahl der zurückzugebenden Datensätze.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyStatesQueryResults	Abfrageergebnisse.
Other Status Codes	QueryFailure	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Query latest at resource group scope

Query latest at resource group scope with next link

Query latest at resource group scope

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Query latest at resource group scope with next link

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$skiptoken=WpmWfBSvPhkAK6QD

Beispiel für eine Antwort

Statuscode:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
ComponentStateDetails	Komponentenstatusdetails.
Error	Fehlerdefinition.
ExpressionEvaluationDetails	Auswertungsdetails von Richtliniensprachenausdrücken.
IfNotExistsEvaluationDetails	Auswertungsdetails des IfNotExists-Effekts.
PolicyEvaluationDetails	Details zur Richtlinienauswertung.
PolicyState	Richtlinienstatusdatensatz.
PolicyStatesQueryResults	Abfrageergebnisse.
PolicyStatesResource	Die virtuelle Ressource unter dem Ressourcentyp "PolicyStates". In einem bestimmten Zeitraum stellt "latest" den neuesten Richtlinienzustand(n) dar, während "Standard" alle Richtlinienzustände darstellt.
QueryFailure	Fehlerantwort.

ComponentStateDetails

Objekt

Komponentenstatusdetails.

Name	Typ	Beschreibung
complianceState	string	Komponentenkompatibilitätsstatus.
id	string	Komponenten-ID.
name	string	Komponentenname.
timestamp	string (date-time)	Zeitstempel der Komponentenkompatibilitätsbewertung.
type	string	Komponententyp.

Error

Objekt

Fehlerdefinition.

Name	Typ	Beschreibung
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
message	string	Beschreibung des Fehlers.

ExpressionEvaluationDetails

Objekt

Auswertungsdetails von Richtliniensprachenausdrü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	Eigenschaftspfad, wenn der Ausdruck ein Feld oder ein Alias ist.
result	string	Auswertungsergebnis.
targetValue	object	Zielwert, der mit dem Ausdruckswert verglichen werden soll.

IfNotExistsEvaluationDetails

Objekt

Auswertungsdetails des IfNotExists-Effekts.

Name	Typ	Beschreibung
resourceId	string	ID der zuletzt ausgewerteten Ressource für ifNotExists-Effekt.
totalResources	integer	Die Gesamtanzahl der Ressourcen, für die die Existenzbedingung gilt.

PolicyEvaluationDetails

Objekt

Details zur Richtlinienauswertung.

Name	Typ	Beschreibung
evaluatedExpressions	ExpressionEvaluationDetails[]	Details zu den ausgewerteten Ausdrücken.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Auswertungsdetails des IfNotExists-Effekts.

PolicyState

Objekt

Richtlinienstatusdatensatz.

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 Richtlinienstatusdatensätze keine Entitäts-ID aufweisen.
complianceState	string	Compliancestatus der Ressource.
components	ComponentStateDetails[]	Komponentenstatus-Kompatibilitätsdatensätze werden nur aufgefüllt, wenn die URL $expand=components-Klausel enthält.
effectiveParameters	string	Effektive Parameter für die Richtlinienzuweisung.
isCompliant	boolean	Flag, das angibt, ob die Ressource mit der Richtlinienzuordnung kompatibel ist, für die sie ausgewertet wurde. Diese Eigenschaft ist veraltet; verwenden Sie stattdessen ComplianceState.
managementGroupIds	string	Durch Trennzeichen getrennte Liste der Verwaltungsgruppen-IDs, die die Hierarchie der Verwaltungsgruppen darstellen, unter denen die Ressource steht.
policyAssignmentId	string	Richtlinienzuweisungs-ID.
policyAssignmentName	string	Name der Richtlinienzuweisung.
policyAssignmentOwner	string	Besitzer der Richtlinienzuweisung.
policyAssignmentParameters	string	Richtlinienzuweisungsparameter.
policyAssignmentScope	string	Richtlinienzuweisungsbereich.
policyAssignmentVersion	string	Ausgewertete Richtlinienzuweisungsversion.
policyDefinitionAction	string	Richtliniendefinitionsaktion, d. h. Effekt.
policyDefinitionCategory	string	Richtliniendefinitionskategorie.
policyDefinitionGroupNames	string[]	Gruppennamen für Richtliniendefinitionen.
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 vorgesehen ist.
policyDefinitionVersion	string	Ausgewertete Richtliniendefinitionsversion.
policyEvaluationDetails	PolicyEvaluationDetails	Details zur Richtlinienauswertung.
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 vorgesehen ist.
policySetDefinitionVersion	string	Ausgewertete Definitionsversion des Richtliniensatzes.
resourceGroup	string	Ressourcengruppenname.
resourceId	string	Ressourcen-ID.
resourceLocation	string	Ressourcenspeicherort.
resourceTags	string	Liste der Ressourcentags.
resourceType	string	Ressourcentyp.
subscriptionId	string	Abonnement-ID.
timestamp	string (date-time)	Zeitstempel für den Richtlinienstatusdatensatz.

PolicyStatesQueryResults

Objekt

Abfrageergebnisse.

Name	Typ	Beschreibung
@odata.context	string	OData-Kontextzeichenfolge; wird von OData-Clients verwendet, um Typinformationen basierend auf Metadaten aufzulösen.
@odata.count	integer (int32) minimum: 0	OData-Entitätsanzahl; stellt die Anzahl der zurückgegebenen Richtlinienstatusdatensätze dar.
@odata.nextLink	string	Nächster Link zu Odata; URL, um den nächsten Satz von Ergebnissen abzurufen.
value	PolicyState[]	Abfrageergebnisse.

PolicyStatesResource

Enumeration

Die virtuelle Ressource unter dem Ressourcentyp "PolicyStates". In einem bestimmten Zeitraum stellt "latest" den neuesten Richtlinienzustand(n) dar, während "Standard" alle Richtlinienzustände darstellt.

Wert	Beschreibung
default
latest

QueryFailure

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlerdefinition.

Freigeben über

Policy States - List Query Results For Resource Group

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Query latest at resource group scope

Beispielanforderung

Beispiel für eine Antwort

Query latest at resource group scope with next link

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ComponentStateDetails

Error

ExpressionEvaluationDetails

IfNotExistsEvaluationDetails

PolicyEvaluationDetails

PolicyState

PolicyStatesQueryResults

PolicyStatesResource

QueryFailure