Policy States - Summarize For Resource Group Level Policy Assignment

Az erőforráscsoport szintű házirend-hozzárendelés házirendállapotának összegzése.

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-paraméterek

Name In Required Type Description
authorizationNamespace
path True
  • string

A Microsoft engedélyezési erőforrás-szolgáltatójának névtere; csak a "Microsoft.Authorization" engedélyezett.

policyAssignmentName
path True
  • string

Házirend-hozzárendelés neve.

policyStatesSummaryResource
path True
  • string

A virtuális erőforrás a PolicyStates erőforrás-típus a művelet összegzésére. Egy adott időtartományban a "legújabb" a legújabb házirend-állapot(ok)ot jelöli, és az egyetlen engedélyezett érték.

resourceGroupName
path True
  • string

Az erőforráscsoport neve.

subscriptionId
path True
  • string

Microsoft Azure-előfizetés azonosítója.

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ő időköz kezdési idejét. Ha nincs megadva, a szolgáltatás ($to - 1 napos).

$to
query
  • string
date-time

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

$top
query
  • integer
int32

A visszaadandó rekordok maximális száma.

Válaszok

Name Type Description
200 OK

Az eredmények összegzése.

Other Status Codes

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

Biztonság

azure_auth

Azure Active Directory OAuth2 folyamat

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

Scopes

Name Description
user_impersonation megszemélyesíteni a felhasználói fiókját

Példák

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
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

Definíciók

ComplianceDetail

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

Error

Hibadefiníció.

PolicyAssignmentSummary

Házirend-hozzárendelés összegzése.

PolicyDefinitionSummary

Házirend-definíció összegzése.

PolicyGroupSummary

Házirend-definíciós csoport összegzése.

QueryFailure

Hibaválasz.

SummarizeResults

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

Summary

Összefoglaló eredmények.

SummaryResults

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

ComplianceDetail

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

Name Type Description
complianceState
  • string

A megfelelőségi állapot.

count
  • integer

Összegzett számláló érték ehhez a megfelelőségi állapothoz.

Error

Hibadefiníció.

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

Házirend-hozzárendelés összegzése.

Name Type Description
policyAssignmentId
  • string

Házirend-hozzárendelés azonosítója.

policyDefinitions

Házirend-definíciók összegzése.

policyGroups

Házirend-definíciós csoport összegzése.

policySetDefinitionId
  • string

Házirend-készlet definícióazonosítója, ha a házirend-hozzárendelés egy házirendkészlethez van.

results

Megfelelőségi összefoglaló a házirend-hozzárendeléshez.

PolicyDefinitionSummary

Házirend-definíció összegzése.

Name Type Description
effect
  • string

Szakpolitikai hatás, azaz a házirend-definíciós művelet.

policyDefinitionGroupNames
  • string[]

Házirend-definíciós csoportnevek.

policyDefinitionId
  • string

Házirend-definíció azonosítója.

policyDefinitionReferenceId
  • string

Házirend-definíció hivatkozásazonosítója.

results

A házirend-definíció megfelelőségi összegzése.

PolicyGroupSummary

Házirend-definíciós csoport összegzése.

Name Type Description
policyGroupName
  • string

Házirendcsoport neve.

results

A házirend-definíciós csoport megfelelőségi összegzése.

QueryFailure

Hibaválasz.

Name Type Description
error

Hibadefiníció.

SummarizeResults

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

Name Type Description
@odata.context
  • string

OData-környezet karakterlánca; az OData-ügyfelek használják a metaadatokon alapuló típusadatok feloldására.

@odata.count
  • integer

OData entitásszáma; a visszaküldött összefoglalók számát jelöli; mindig 1-re van állítva.

value

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

Summary

Összefoglaló eredmények.

Name Type Description
@odata.context
  • string

OData-környezet karakterlánca; az OData-ügyfelek használják a metaadatokon alapuló típusadatok feloldására.

@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

Házirend-hozzárendelések összegzése.

results

Megfelelőségi összegzés az összes házirend-hozzárendeléshez.

SummaryResults

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

Name Type Description
nonCompliantPolicies
  • integer

A nem megfelelő házirendek száma.

nonCompliantResources
  • integer

A nem megfelelő erőforrások száma.

policyDetails

A házirend-összetevő összegzése ezen a szinten. A lekérdezéshatókör szintjén a házirend-hozzárendelés összegzését jelöli. Az irányelv-hozzárendelési szint esetében a házirend-definíciók összegzését jelöli.

policyGroupDetails

A házirend-definíciós csoport ezen a szinten összegzése.

queryResultsUri
  • string

HTTP-S URI a queryResults műveleta A Microsoft.PolicyInsights a megfelelőségi összegzé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

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