Policy States - Summarize For Resource Group

Podsumowuje stany zasad dla zasobów w grupie zasobów.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top={$top}&$from={$from}&$to={$to}&$filter={$filter}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
policyStatesSummaryResource
path True

PolicyStatesSummaryResourceType

Zasób wirtualny w obszarze PolicyStates typ zasobu dla akcji podsumowania. W danym zakresie czasu wartość "latest" reprezentuje najnowsze stany zasad i jest jedyną dozwoloną wartością.

resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Identyfikator subskrypcji platformy Microsoft Azure.

api-version
query True

string

Wersja interfejsu API klienta.

$filter
query

string

Wyrażenie filtru OData.

$from
query

string

date-time

Formatowany znacznik czasu ISO 8601 określający godzinę rozpoczęcia interwału zapytania. Jeśli nie zostanie określona, usługa używa ($to - 1-dniowy).

$to
query

string

date-time

Sformatowany znacznik czasu ISO 8601 określający czas zakończenia interwału zapytania. Jeśli nie zostanie określony, usługa używa czasu żądania.

$top
query

integer

int32

Maksymalna liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

SummarizeResults

Podsumuj wyniki.

Other Status Codes

QueryFailure

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Summarize at resource group scope

Sample Request

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

Sample Response

{
  "@odata.context": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
      "results": {
        "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false",
        "nonCompliantResources": 55,
        "nonCompliantPolicies": 20,
        "resourceDetails": [
          {
            "complianceState": "compliant",
            "count": 140
          },
          {
            "complianceState": "noncompliant",
            "count": 55
          }
        ],
        "policyDetails": [
          {
            "complianceState": "noncompliant",
            "count": 2
          }
        ],
        "policyGroupDetails": [
          {
            "complianceState": "noncompliant",
            "count": 1
          }
        ]
      },
      "policyAssignments": [
        {
          "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c",
          "policySetDefinitionId": "",
          "results": {
            "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c'",
            "nonCompliantResources": 55,
            "nonCompliantPolicies": 1,
            "resourceDetails": [
              {
                "complianceState": "compliant",
                "count": 140
              },
              {
                "complianceState": "noncompliant",
                "count": 55
              }
            ],
            "policyDetails": [
              {
                "complianceState": "noncompliant",
                "count": 2
              }
            ],
            "policyGroupDetails": [
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ]
          },
          "policyDefinitions": [
            {
              "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d",
              "policyDefinitionReferenceId": "",
              "policyDefinitionGroupNames": [
                "group1"
              ],
              "effect": "audit",
              "results": {
                "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'",
                "nonCompliantResources": 100,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 100
                  }
                ],
                "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 PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c' and 'group1' IN PolicyDefinitionGroupNames",
                "nonCompliantResources": 100,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 100
                  }
                ],
                "policyDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyGroupDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ]
              }
            }
          ]
        },
        {
          "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a",
          "policySetDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5",
          "results": {
            "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'",
            "nonCompliantResources": 55,
            "nonCompliantPolicies": 1,
            "resourceDetails": [
              {
                "complianceState": "compliant",
                "count": 140
              },
              {
                "complianceState": "noncompliant",
                "count": 55
              }
            ],
            "policyDetails": [
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ],
            "policyGroupDetails": [
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ]
          },
          "policyDefinitions": [
            {
              "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d",
              "policyDefinitionReferenceId": "",
              "policyDefinitionGroupNames": [
                "group1"
              ],
              "effect": "audit",
              "results": {
                "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'",
                "nonCompliantResources": 55,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 55
                  }
                ],
                "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/335cefd2-ab16-430f-b364-974a170eb1d5' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and 'group1' IN PolicyDefinitionGroupNames",
                "nonCompliantResources": 557,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 55
                  }
                ],
                "policyDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyGroupDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

Definicje

Nazwa Opis
ComplianceDetail

Zestawienie stanu zgodności.

Error

Definicja błędu.

PolicyAssignmentSummary

Podsumowanie przypisania zasad.

PolicyDefinitionSummary

Podsumowanie definicji zasad.

PolicyGroupSummary

Podsumowanie grupy definicji zasad.

PolicyStatesSummaryResourceType

Zasób wirtualny w obszarze PolicyStates typ zasobu dla akcji podsumowania. W danym zakresie czasu wartość "latest" reprezentuje najnowsze stany zasad i jest jedyną dozwoloną wartością.

QueryFailure

Odpowiedź na błąd.

SummarizeResults

Podsumuj wyniki akcji.

Summary

Wyniki podsumowania.

SummaryResults

Podsumowanie zgodności na określonym poziomie podsumowania.

ComplianceDetail

Zestawienie stanu zgodności.

Nazwa Typ Opis
complianceState

string

Stan zgodności.

count

integer

Podsumowana wartość licznika dla tego stanu zgodności.

Error

Definicja błędu.

Nazwa Typ Opis
code

string

Kod błędu specyficzny dla usługi, który służy jako stan podrzędny kodu błędu HTTP.

message

string

Opis błędu.

PolicyAssignmentSummary

Podsumowanie przypisania zasad.

Nazwa Typ Opis
policyAssignmentId

string

Identyfikator przypisania zasad.

policyDefinitions

PolicyDefinitionSummary[]

Podsumowanie definicji zasad.

policyGroups

PolicyGroupSummary[]

Podsumowanie grupy definicji zasad.

policySetDefinitionId

string

Identyfikator definicji zestawu zasad, jeśli przypisanie zasad dotyczy zestawu zasad.

results

SummaryResults

Podsumowanie zgodności dla przypisania zasad.

PolicyDefinitionSummary

Podsumowanie definicji zasad.

Nazwa Typ Opis
effect

string

Efekt zasad, tj. akcja definicji zasad.

policyDefinitionGroupNames

string[]

Nazwy grup definicji zasad.

policyDefinitionId

string

Identyfikator definicji zasad.

policyDefinitionReferenceId

string

Identyfikator odwołania definicji zasad.

results

SummaryResults

Podsumowanie zgodności definicji zasad.

PolicyGroupSummary

Podsumowanie grupy definicji zasad.

Nazwa Typ Opis
policyGroupName

string

Nazwa grupy zasad.

results

SummaryResults

Podsumowanie zgodności dla grupy definicji zasad.

PolicyStatesSummaryResourceType

Zasób wirtualny w obszarze PolicyStates typ zasobu dla akcji podsumowania. W danym zakresie czasu wartość "latest" reprezentuje najnowsze stany zasad i jest jedyną dozwoloną wartością.

Nazwa Typ Opis
latest

string

QueryFailure

Odpowiedź na błąd.

Nazwa Typ Opis
error

Error

Definicja błędu.

SummarizeResults

Podsumuj wyniki akcji.

Nazwa Typ Opis
@odata.context

string

Ciąg kontekstu OData; używane przez klientów OData do rozpoznawania informacji o typie na podstawie metadanych.

@odata.count

integer

Liczba jednostek OData; reprezentuje liczbę zwróconych podsumowań; zawsze ustawiono wartość 1.

value

Summary[]

Podsumuj wyniki akcji.

Summary

Wyniki podsumowania.

Nazwa Typ Opis
@odata.context

string

Ciąg kontekstu OData; używane przez klientów OData do rozpoznawania informacji o typie na podstawie metadanych.

@odata.id

string

Identyfikator jednostki OData; zawsze ustawiono wartość null, ponieważ podsumowania nie mają identyfikatora jednostki.

policyAssignments

PolicyAssignmentSummary[]

Podsumowanie przypisań zasad.

results

SummaryResults

Podsumowanie zgodności dla wszystkich przypisań zasad.

SummaryResults

Podsumowanie zgodności na określonym poziomie podsumowania.

Nazwa Typ Opis
nonCompliantPolicies

integer

Liczba niezgodnych zasad.

nonCompliantResources

integer

Liczba niezgodnych zasobów.

policyDetails

ComplianceDetail[]

Podsumowanie artefaktów zasad na tym poziomie. W przypadku poziomu zakresu zapytania reprezentuje podsumowanie przypisania zasad. W przypadku poziomu przypisania zasad reprezentuje podsumowanie definicji zasad.

policyGroupDetails

ComplianceDetail[]

Podsumowanie grupy definicji zasad na tym poziomie.

queryResultsUri

string

Identyfikator URI POST protokołu HTTP dla akcji queryResults w usłudze Microsoft.PolicyInsights w celu pobrania nieprzetworzonych wyników podsumowania zgodności. Ta właściwość nie będzie domyślnie dostępna w przyszłych wersjach interfejsu API, ale może być jawnie odpytywane.

resourceDetails

ComplianceDetail[]

Podsumowanie zasobów na tym poziomie.