Megosztás a következőn keresztül:

Policy States - Summarize For Resource

  • Referencia
Szolgáltatás:
Policy
API-verzió:
2019-10-01

Az erőforrás házirendállapotait összegzi.

POST https://management.azure.com/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01
Opcionális paraméterekkel: 
POST https://management.azure.com/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top={$top}&$from={$from}&$to={$to}&$filter={$filter}

URI-paraméterek

Name In Kötelező Típus Description
policyStatesSummaryResource
 path True

PolicyStatesSummaryResourceType

A PolicyStates erőforrástípus alatti virtuális erőforrás összegzési művelethez. Egy adott időtartományban a "legújabb" a legújabb szabályzatállapot(ok) és az egyetlen engedélyezett érték.
resourceId
 path True

string

Erőforrás-azonosító.
api-version
 query True

string

Ügyfél API-verziója.
$filter
 query

string

OData szűrőkifejezés.
$from
 query

string (date-time)

ISO 8601 formátumú időbélyeg, amely megadja a lekérdezési időköz kezdő időpontját. Ha nincs megadva, a szolgáltatás ($to – 1 napos) szolgáltatást használ.
$to
 query

string (date-time)

ISO 8601 formátumú időbélyeg, amely megadja a lekérdezési időköz befejezési idejét. Ha nincs megadva, a szolgáltatás kérési időt használ.
$top
 query

integer (int32)

minimum: 0

A visszaadandó rekordok maximális száma.

Válaszok

Name Típus Description
200 OK

SummarizeResults

Eredmények összegzése.
Other Status Codes

QueryFailure

Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

Summarize at resource scope

Mintakérelem

POST https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top=2

Mintaválasz

Állapotkód:
200 
{
  "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
      "results": {
        "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false",
        "nonCompliantResources": 1,
        "nonCompliantPolicies": 14,
        "resourceDetails": [
          {
            "complianceState": "compliant",
            "count": 140
          },
          {
            "complianceState": "noncompliant",
            "count": 1
          }
        ],
        "policyDetails": [
          {
            "complianceState": "noncompliant",
            "count": 2
          }
        ],
        "policyGroupDetails": [
          {
            "complianceState": "noncompliant",
            "count": 1
          }
        ]
      },
      "policyAssignments": [
        {
          "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874",
          "policySetDefinitionId": "",
          "results": {
            "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874'",
            "nonCompliantResources": 1,
            "nonCompliantPolicies": 1,
            "resourceDetails": [
              {
                "complianceState": "compliant",
                "count": 140
              },
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ],
            "policyDetails": [
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ],
            "policyGroupDetails": [
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ]
          },
          "policyDefinitions": [
            {
              "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066",
              "policyDefinitionReferenceId": "",
              "effect": "audit",
              "results": {
                "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066'",
                "nonCompliantResources": 1,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyGroupDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ]
              }
            }
          ],
          "policyGroups": [
            {
              "policyGroupName": "",
              "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/8174043a1e2849179635b874'",
                "nonCompliantResources": 7,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyGroupDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ]
              }
            }
          ]
        },
        {
          "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a",
          "policySetDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5",
          "results": {
            "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'",
            "nonCompliantResources": 1,
            "nonCompliantPolicies": 1,
            "resourceDetails": [
              {
                "complianceState": "compliant",
                "count": 140
              },
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ],
            "policyDetails": [
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ],
            "policyGroupDetails": [
              {
                "complianceState": "noncompliant",
                "count": 1
              }
            ]
          },
          "policyDefinitions": [
            {
              "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d",
              "policyDefinitionReferenceId": "",
              "effect": "audit",
              "results": {
                "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'",
                "nonCompliantResources": 1,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "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/1ef5d536aec743a0aa801c1a' and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5' and 'group1' IN PolicyDefinitionGroupNames",
                "nonCompliantResources": 100,
                "resourceDetails": [
                  {
                    "complianceState": "compliant",
                    "count": 140
                  },
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ],
                "policyGroupDetails": [
                  {
                    "complianceState": "noncompliant",
                    "count": 1
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

Definíciók

Name Description
ComplianceDetail

A megfelelőségi állapot összesítése.
Error

Hibadefiníció.
PolicyAssignmentSummary

Szabályzat-hozzárendelés összegzése.
PolicyDefinitionSummary

Szabályzatdefiníció összefoglalása.
PolicyGroupSummary

Szabályzatdefiníciós csoport összefoglalása.
PolicyStatesSummaryResourceType

A PolicyStates erőforrástípus alatti virtuális erőforrás összegzési művelethez. Egy adott időtartományban a "legújabb" a legújabb szabályzatállapot(ok) és az egyetlen engedélyezett érték.
QueryFailure

Hibaválasz.
SummarizeResults

A művelet eredményeinek összegzése.
Summary

Összefoglaló eredmények.
SummaryResults

Megfelelőségi összefoglalás egy adott összefoglaló szinten.

ComplianceDetail

Objektum

A megfelelőségi állapot összesítése.

Name Típus Description
complianceState

string

A megfelelőségi állapot.
count

integer (int32)

A megfelelőségi állapot összegzett darabszáma.

Error

Objektum

Hibadefiníció.

Name Típus Description
code

string

Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.
message

string

A hiba leírása.

PolicyAssignmentSummary

Objektum

Szabályzat-hozzárendelés összegzése.

Name Típus Description
policyAssignmentId

string

Szabályzat-hozzárendelés azonosítója.
policyDefinitions

PolicyDefinitionSummary[]

Szabályzatdefiníciók összegzése.
policyGroups

PolicyGroupSummary[]

Szabályzatdefiníciós csoport összefoglalása.
policySetDefinitionId

string

Szabályzatkészlet definícióazonosítója, ha a szabályzat-hozzárendelés egy szabályzatkészlethez tartozik.
results

SummaryResults

A szabályzat-hozzárendelés megfelelőségi összefoglalása.

PolicyDefinitionSummary

Objektum

Szabályzatdefiníció összefoglalása.

Name Típus Description
effect

string

Szabályzateffektus, azaz szabályzatdefiníciós művelet.
policyDefinitionGroupNames

string[]

Szabályzatdefiníciós csoportnevek.
policyDefinitionId

string

Szabályzatdefiníció azonosítója.
policyDefinitionReferenceId

string

Szabályzatdefiníció referencia-azonosítója.
results

SummaryResults

A szabályzatdefiníció megfelelőségi összefoglalása.

PolicyGroupSummary

Objektum

Szabályzatdefiníciós csoport összefoglalása.

Name Típus Description
policyGroupName

string

Házirendcsoport neve.
results

SummaryResults

A szabályzatdefiníciós csoport megfelelőségi összefoglalása.

PolicyStatesSummaryResourceType

Enumerálás

A PolicyStates erőforrástípus alatti virtuális erőforrás összegzési művelethez. Egy adott időtartományban a "legújabb" a legújabb szabályzatállapot(ok) és az egyetlen engedélyezett érték.

Érték Description
latest

QueryFailure

Objektum

Hibaválasz.

Name Típus Description
error

Error

Hibadefiníció.

SummarizeResults

Objektum

A művelet eredményeinek összegzése.

Name Típus Description
@odata.context

string

OData környezeti sztring; az OData-ügyfelek a metaadatokon alapuló típusinformációk feloldására használják.
@odata.count

integer (int32)

minimum: 1
maximum: 1

OData-entitások száma; a visszaadott összegzések számát jelöli; mindig 1 értékre van állítva.
value

Summary[]

A művelet eredményeinek összegzése.

Summary

Objektum

Összefoglaló eredmények.

Name Típus Description
@odata.context

string

OData környezeti sztring; az OData-ügyfelek a metaadatokon alapuló típusinformációk feloldására használják.
@odata.id

string

OData-entitás azonosítója; mindig null értékre van állítva, mivel az összegzések nem rendelkeznek entitásazonosítóval.
policyAssignments

PolicyAssignmentSummary[]

Szabályzat-hozzárendelések összegzése.
results

SummaryResults

Megfelelőségi összefoglalás az összes szabályzat-hozzárendeléshez.

SummaryResults

Objektum

Megfelelőségi összefoglalás egy adott összefoglaló szinten.

Name Típus Description
nonCompliantPolicies

integer (int32)

minimum: 0

A nem megfelelő szabályzatok száma.
nonCompliantResources

integer (int32)

minimum: 0

Nem megfelelő erőforrások száma.
policyDetails

ComplianceDetail[]

A szabályzatösszetevő összegzése ezen a szinten. A lekérdezési hatókör szintje a szabályzat-hozzárendelés összegzését jelenti. A szabályzat-hozzárendelési szint esetében a szabályzatdefiníciók összegzését jelöli.
policyGroupDetails

ComplianceDetail[]

A szabályzatdefiníciós csoport összefoglalása ezen a szinten.
queryResultsUri

string

HTTP POST URI a Microsoft.PolicyInsights lekérdezési műveletéhez a megfelelőségi összefoglalás nyers eredményeinek lekéréséhez. Ez a tulajdonság alapértelmezés szerint nem lesz elérhető a jövőbeli API-verziókban, de explicit módon lekérdezhető.
resourceDetails

ComplianceDetail[]

Az erőforrások összegzése ezen a szinten.