Policy States - Summarize For Management Group

Podsumowuje stan zasad dla zasobów w grupie zarządzania.

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

Parametry identyfikatora URI

Name In Required Type Description
managementGroupName
path True
  • string

Nazwa grupy zarządzania.

managementGroupsNamespace
path True
  • string

Przestrzeń nazw dla Microsoft Management RP; dozwolone jest tylko "Microsoft. Management".

policyStatesSummaryResource
path True
  • string

Zasób wirtualny w obszarze Typ zasobu PolicyStates dla akcji podsumowywania. W danym przedziale czasu "Najnowsza" reprezentuje najnowsze Stany zasad i jest jedyną dozwoloną wartością.

api-version
query True
  • string

Wersja interfejsu API klienta.

$filter
query
  • string

Wyrażenie filtru OData.

$from
query
  • string
date-time

Sformatowana sygnatura czasowa ISO 8601 określa godzinę rozpoczęcia interwału do zapytania. Gdy nie zostanie określony, usługa używa programu ($to-1-dniowy).

$to
query
  • string
date-time

Sformatowana sygnatura czasowa ISO 8601 określająca czas zakończenia interwału do zapytania. Gdy ta wartość nie zostanie określona, usługa używa czasu żądania.

$top
query
  • integer
int32

Maksymalna liczba rekordów do zwrócenia.

Odpowiedzi

Name Type Description
200 OK

Podsumowywanie wyników.

Other Status Codes

Odpowiedź na błąd z opisem przyczyny niepowodzenia operacji.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

Summarize at management group scope

Sample Request

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top=0&$from=2019-10-05T18:00:00Z&$to=2019-10-06T18:00:00Z&$filter=PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit'

Sample Response

{
  "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
      "results": {
        "queryResultsUri": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-05 18:00:00Z&$to=2019-10-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and IsCompliant eq false",
        "nonCompliantResources": 15410,
        "nonCompliantPolicies": 68,
        "resourceDetails": [
          {
            "complianceState": "compliant",
            "count": 1400
          },
          {
            "complianceState": "noncompliant",
            "count": 15410
          }
        ],
        "policyDetails": [
          {
            "complianceState": "noncompliant",
            "count": 68
          }
        ],
        "policyGroupDetails": [
          {
            "complianceState": "noncompliant",
            "count": 14
          }
        ]
      },
      "policyAssignments": []
    }
  ]
}

Definicje

ComplianceDetail

Pakiet zbiorczy stanu zgodności.

Error

Definicja błędu.

PolicyAssignmentSummary

Podsumowanie przypisywania zasad.

PolicyDefinitionSummary

Podsumowanie definicji zasad.

PolicyGroupSummary

Podsumowanie grupy definicji zasad.

QueryFailure

Odpowiedź na błąd.

SummarizeResults

Podsumowywanie wyników akcji.

Summary

Podsumowanie wyników.

SummaryResults

Podsumowanie zgodności na określonym poziomie podsumowania.

ComplianceDetail

Pakiet zbiorczy stanu zgodności.

Name Type Description
complianceState
  • string

Stan zgodności.

count
  • integer

Sumaryczna wartość liczby dla tego stanu zgodności.

Error

Definicja błędu.

Name Type Description
code
  • string

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

message
  • string

Opis błędu.

PolicyAssignmentSummary

Podsumowanie przypisywania zasad.

Name Type Description
policyAssignmentId
  • string

Identyfikator przypisania zasad.

policyDefinitions

Podsumowanie definicji zasad.

policyGroups

Podsumowanie grupy definicji zasad.

policySetDefinitionId
  • string

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

results

Podsumowanie zgodności dla przypisania zasad.

PolicyDefinitionSummary

Podsumowanie definicji zasad.

Name Type Description
effect
  • string

Efekt zasad, czyli akcja definicji zasad.

policyDefinitionGroupNames
  • string[]

Nazwy grup definicji zasad.

policyDefinitionId
  • string

Identyfikator definicji zasad.

policyDefinitionReferenceId
  • string

Identyfikator odwołania do definicji zasad.

results

Podsumowanie zgodności dla definicji zasad.

PolicyGroupSummary

Podsumowanie grupy definicji zasad.

Name Type Description
policyGroupName
  • string

Nazwa grupy zasad.

results

Podsumowanie zgodności grupy definicji zasad.

QueryFailure

Odpowiedź na błąd.

Name Type Description
error

Definicja błędu.

SummarizeResults

Podsumowywanie wyników akcji.

Name Type Description
@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; przedstawia liczbę zwracanych podsumowań; zawsze ustawione na 1.

value

Podsumowywanie wyników akcji.

Summary

Podsumowanie wyników.

Name Type Description
@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

Podsumowanie przypisań zasad.

results

Podsumowanie zgodności dla wszystkich przypisań zasad.

SummaryResults

Podsumowanie zgodności na określonym poziomie podsumowania.

Name Type Description
nonCompliantPolicies
  • integer

Liczba niezgodnych zasad.

nonCompliantResources
  • integer

Liczba niezgodnych zasobów.

policyDetails

Podsumowanie artefaktów zasad na tym poziomie. Dla poziomu zakresu zapytania reprezentuje podsumowanie przydziału zasad. Dla poziomu przypisywania zasad reprezentuje podsumowanie definicji zasad.

policyGroupDetails

Podsumowanie grupy definicji zasad na tym poziomie.

queryResultsUri
  • string

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

resourceDetails

Podsumowanie zasobów na tym poziomie.