Policy States - List Query Results For Resource Group Level Policy Assignment
Fragt Richtlinienzustände für die Richtlinienzuweisung auf Ressourcengruppenebene ab.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-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 |
---|---|---|---|---|
authorization
|
path | True |
Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig. |
|
policy
|
path | True |
string |
Name der Richtlinienzuweisung. |
policy
|
path | True |
Die virtuelle Ressource unter Dem Ressourcentyp PolicyStates. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar, während "standard" alle Richtlinienzustände darstellt. |
|
resource
|
path | True |
string |
Ressourcengruppenname |
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". |
|
$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 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 at resource group level policy assignment scope |
Query latest at resource group level policy assignment scope with next link |
Query latest at resource group level policy assignment scope
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01
Sample Response
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/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.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Security/policies",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"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": null,
"policyAssignmentVersion": "1.0.0"
},
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Authorization/policyAssignments",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"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": null,
"policyAssignmentVersion": "1.0.0"
}
]
}
Query latest at resource group level policy assignment scope with next link
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$skiptoken=WpmWfBSvPhkAK6QD
Sample Response
{
"@odata.nextLink": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/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.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": false,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Security/policies",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"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.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
"timestamp": "2019-10-13T00:38:50Z",
"resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test",
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"effectiveParameters": null,
"isCompliant": true,
"subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
"resourceType": "/Microsoft.Authorization/policyAssignments",
"resourceLocation": null,
"resourceGroup": "myResourceGroup",
"resourceTags": "tbd",
"policyAssignmentName": "myPolicyAssignment",
"policyAssignmentOwner": "tbd",
"policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}",
"policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup",
"policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionAction": "audit",
"policyDefinitionCategory": "tbd",
"policySetDefinitionId": null,
"policySetDefinitionName": null,
"policySetDefinitionOwner": null,
"policySetDefinitionCategory": null,
"policySetDefinitionParameters": null,
"managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
"policyDefinitionReferenceId": null,
"complianceState": "Compliant",
"policyDefinitionGroupNames": [
"myGroup"
]
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Authorization |
Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig. |
Component |
Komponentenstatusdetails. |
Error |
Fehlerdefinition. |
Expression |
Auswertungsdetails von Richtliniensprachausdrücken. |
If |
Auswertungsdetails des IfNotExists-Effekts. |
Policy |
Details zur Richtlinienauswertung. |
Policy |
Richtlinienstatusdatensatz. |
Policy |
Abfrageergebnisse. |
Policy |
Die virtuelle Ressource unter Dem Ressourcentyp PolicyStates. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar, während "standard" alle Richtlinienzustände darstellt. |
Query |
Fehlerantwort. |
AuthorizationNamespaceType
Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
Name | Typ | Beschreibung |
---|---|---|
Microsoft.Authorization |
string |
ComponentStateDetails
Komponentenstatusdetails.
Name | Typ | Beschreibung |
---|---|---|
complianceState |
string |
Komponentenkonformitätsstatus. |
id |
string |
Komponenten-ID. |
name |
string |
Komponentenname |
timestamp |
string |
Zeitstempel der Komponentenkonformitätsauswertung. |
type |
string |
Komponententyp. |
Error
Fehlerdefinition.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient. |
message |
string |
Beschreibung des Fehlers |
ExpressionEvaluationDetails
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. |
IfNotExistsEvaluationDetails
Auswertungsdetails des IfNotExists-Effekts.
Name | Typ | Beschreibung |
---|---|---|
resourceId |
string |
ID der zuletzt ausgewerteten Ressource für den IfNotExists-Effekt. |
totalResources |
integer |
Gesamtanzahl der Ressourcen, für die die Existenzbedingung gilt. |
PolicyEvaluationDetails
Details zur Richtlinienauswertung.
Name | Typ | Beschreibung |
---|---|---|
evaluatedExpressions |
Details der ausgewerteten Ausdrücke. |
|
ifNotExistsDetails |
Auswertungsdetails des IfNotExists-Effekts. |
PolicyState
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; legen Sie immer auf NULL fest, da Richtlinienstatusdatensätze keine Entitäts-ID aufweisen. |
complianceState |
string |
Kompatibilitätsstatus der Ressource. |
components |
Komponentenzustandskonformitätsdatensätze werden nur aufgefüllt, wenn die URL $expand=components-Klausel enthält. |
|
effectiveParameters |
string |
Effektive Parameter für die Richtlinienzuweisung. |
isCompliant |
boolean |
Kennzeichnen, das angibt, ob die Ressource mit der Richtlinienzuweisung kompatibel ist, für die sie ausgewertet wurde. Diese Eigenschaft ist veraltet. verwenden Sie stattdessen ComplianceState. |
managementGroupIds |
string |
Durch Kommas getrennte Liste der Verwaltungsgruppen-IDs, die die Hierarchie der Verwaltungsgruppen darstellen, unter denen sich die Ressource befindet. |
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. |
|
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 |
resourceTags |
string |
Liste der Ressourcentags. |
resourceType |
string |
Der Ressourcentyp. |
subscriptionId |
string |
Abonnement-ID |
timestamp |
string |
Zeitstempel für den Richtlinienstatusdatensatz. |
PolicyStatesQueryResults
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. |
@odata.nextLink |
string |
Odata nächster Link; URL, um den nächsten Satz von Ergebnissen abzurufen. |
value |
Abfrageergebnisse. |
PolicyStatesResource
Die virtuelle Ressource unter Dem Ressourcentyp PolicyStates. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar, während "standard" alle Richtlinienzustände darstellt.
Name | Typ | Beschreibung |
---|---|---|
default |
string |
|
latest |
string |
QueryFailure
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlerdefinition. |