Policy States - Summarize For Resource Group Level Policy Assignment
Fasst Richtlinienzustände für die Richtlinienzuweisung auf Ressourcengruppenebene zusammen.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top={$top}&$from={$from}&$to={$to}&$filter={$filter}
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 PolicyStates-Ressourcentyp für die Zusammenfassungsaktion. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert. |
|
resource
|
path | True |
string |
Ressourcengruppenname |
subscription
|
path | True |
string |
Microsoft Azure-Abonnement-ID. |
api-version
|
query | True |
string |
Client-API-Version. |
$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). |
|
$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 |
Fassen Sie die Ergebnisse zusammen. |
|
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
Summarize at policy assignment scope
Sample Request
POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01
Sample Response
{
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary",
"@odata.count": 1,
"value": [
{
"@odata.id": null,
"@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
"results": {
"queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-22 23:54:22Z&$to=2019-10-23 23:54:22Z&$filter=IsCompliant eq false",
"nonCompliantResources": 7,
"nonCompliantPolicies": 1,
"resourceDetails": [
{
"complianceState": "compliant",
"count": 140
},
{
"complianceState": "noncompliant",
"count": 7
}
],
"policyDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
],
"policyGroupDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
]
},
"policyAssignments": [
{
"policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2",
"policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad",
"results": {
"queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-22 23:54:22Z&$to=2019-10-23 23:54:22Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2'",
"nonCompliantResources": 7,
"nonCompliantPolicies": 1,
"resourceDetails": [
{
"complianceState": "compliant",
"count": 140
},
{
"complianceState": "noncompliant",
"count": 7
}
],
"policyDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
],
"policyGroupDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
]
},
"policyDefinitions": [
{
"policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60",
"policyDefinitionReferenceId": "2134906828137356512",
"policyDefinitionGroupNames": [
"group1"
],
"effect": "audit",
"results": {
"queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-22 23:54:22Z&$to=2019-10-23 23:54:22Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60'",
"nonCompliantResources": 7,
"resourceDetails": [
{
"complianceState": "compliant",
"count": 140
},
{
"complianceState": "noncompliant",
"count": 7
}
],
"policyDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
],
"policyGroupDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
]
}
}
],
"policyGroups": [
{
"policyGroupName": "group1",
"results": {
"queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2' and 'group1' IN PolicyDefinitionGroupNames",
"nonCompliantResources": 557,
"resourceDetails": [
{
"complianceState": "compliant",
"count": 140
},
{
"complianceState": "noncompliant",
"count": 7
}
],
"policyDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
],
"policyGroupDetails": [
{
"complianceState": "noncompliant",
"count": 1
}
]
}
}
]
}
]
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Authorization |
Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig. |
Compliance |
Das Kompatibilitätsstatusrollup. |
Error |
Fehlerdefinition. |
Policy |
Zusammenfassung der Richtlinienzuweisung. |
Policy |
Zusammenfassung der Richtliniendefinition. |
Policy |
Zusammenfassung der Richtliniendefinitionsgruppe. |
Policy |
Die virtuelle Ressource unter PolicyStates-Ressourcentyp für die Zusammenfassungsaktion. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert. |
Query |
Fehlerantwort. |
Summarize |
Fassen Sie die Aktionsergebnisse zusammen. |
Summary |
Zusammenfassungsergebnisse. |
Summary |
Konformitätszusammenfassung auf einer bestimmten Zusammenfassungsebene. |
AuthorizationNamespaceType
Der Namespace für den Microsoft-Autorisierungsressourcenanbieter; nur "Microsoft.Authorization" ist zulässig.
Name | Typ | Beschreibung |
---|---|---|
Microsoft.Authorization |
string |
ComplianceDetail
Das Kompatibilitätsstatusrollup.
Name | Typ | Beschreibung |
---|---|---|
complianceState |
string |
Der Konformitätsstatus. |
count |
integer |
Zusammengefasster Zählwert für diesen Konformitätsstatus. |
Error
Fehlerdefinition.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient. |
message |
string |
Beschreibung des Fehlers |
PolicyAssignmentSummary
Zusammenfassung der Richtlinienzuweisung.
Name | Typ | Beschreibung |
---|---|---|
policyAssignmentId |
string |
Richtlinienzuweisungs-ID. |
policyDefinitions |
Zusammenfassung von Richtliniendefinitionen. |
|
policyGroups |
Zusammenfassung der Richtliniendefinitionsgruppe. |
|
policySetDefinitionId |
string |
Richtliniensatzdefinitions-ID, wenn die Richtlinienzuweisung für einen Richtliniensatz gilt. |
results |
Konformitätszusammenfassung für die Richtlinienzuweisung. |
PolicyDefinitionSummary
Zusammenfassung der Richtliniendefinition.
Name | Typ | Beschreibung |
---|---|---|
effect |
string |
Richtlinieneffekt, d. h. Richtliniendefinitionsaktion. |
policyDefinitionGroupNames |
string[] |
Richtliniendefinitionsgruppennamen. |
policyDefinitionId |
string |
Richtliniendefinitions-ID. |
policyDefinitionReferenceId |
string |
Referenz-ID der Richtliniendefinition. |
results |
Konformitätszusammenfassung für die Richtliniendefinition. |
PolicyGroupSummary
Zusammenfassung der Richtliniendefinitionsgruppe.
Name | Typ | Beschreibung |
---|---|---|
policyGroupName |
string |
Name der Richtliniengruppe. |
results |
Konformitätszusammenfassung für die Richtliniendefinitionsgruppe. |
PolicyStatesSummaryResourceType
Die virtuelle Ressource unter PolicyStates-Ressourcentyp für die Zusammenfassungsaktion. In einem bestimmten Zeitbereich stellt "latest" den neuesten Richtlinienstatus dar und ist der einzige zulässige Wert.
Name | Typ | Beschreibung |
---|---|---|
latest |
string |
QueryFailure
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlerdefinition. |
SummarizeResults
Fassen Sie die Aktionsergebnisse zusammen.
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 Zusammenfassungen dar; immer auf 1 festgelegt. |
value |
Summary[] |
Fassen Sie die Aktionsergebnisse zusammen. |
Summary
Zusammenfassungsergebnisse.
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 Zusammenfassungen keine Entitäts-ID aufweisen. |
policyAssignments |
Zusammenfassung der Richtlinienzuweisungen. |
|
results |
Konformitätszusammenfassung für alle Richtlinienzuweisungen. |
SummaryResults
Konformitätszusammenfassung auf einer bestimmten Zusammenfassungsebene.
Name | Typ | Beschreibung |
---|---|---|
nonCompliantPolicies |
integer |
Anzahl nicht konformer Richtlinien. |
nonCompliantResources |
integer |
Anzahl nicht konformer Ressourcen. |
policyDetails |
Die Zusammenfassung des Richtlinienartefakts auf dieser Ebene. Für Abfragebereichsebene stellt es eine Richtlinienzuweisungszusammenfassung dar. Für die Richtlinienzuweisungsebene stellt er die Zusammenfassung von Richtliniendefinitionen dar. |
|
policyGroupDetails |
Die Zusammenfassung der Richtliniendefinitionsgruppe auf dieser Ebene. |
|
queryResultsUri |
string |
HTTP POST-URI für queryResults-Aktion in Microsoft.PolicyInsights, um Rohergebnisse für die Konformitätszusammenfassung abzurufen. Diese Eigenschaft ist in zukünftigen API-Versionen standardmäßig nicht verfügbar, kann aber explizit abgefragt werden. |
resourceDetails |
Die Ressourcenzusammenfassung auf dieser Ebene. |