Policy States - Summarize For Resource

  • Referência
Service:
Policy
API Version:
2019-10-01

Resume os estados de política do recurso.

POST https://management.azure.com/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01
With optional parameters: 
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}

Parâmetros do URI

Name Em Necessário Tipo Description
policyStatesSummaryResource
 path True

PolicyStatesSummaryResourceType

O recurso virtual em PolicyStates tipo de recurso para resumir a ação. Num determinado intervalo de tempo, "mais recente" representa os estados da política mais recentes e é o único valor permitido.
resourceId
 path True

string

ID do Recurso.
api-version
 query True

string

Versão da API do Cliente.
$filter
 query

string

Expressão de filtro OData.
$from
 query

string

date-time

IsO 8601 formatado carimbo de data/hora especificando a hora de início do intervalo a consultar. Quando não for especificado, o serviço utiliza ($to - 1 dia).
$to
 query

string

date-time

IsO 8601 formatado carimbo de data/hora especificando a hora de fim do intervalo para consulta. Quando não for especificado, o serviço utiliza o tempo de pedido.
$top
 query

integer

int32

Número máximo de registos a devolver.

Respostas

Name Tipo Description
200 OK

SummarizeResults

Resumir resultados.
Other Status Codes

QueryFailure

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Summarize at resource scope

Sample Request

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

Sample Response

Status code:
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
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

Definições

Name Description
ComplianceDetail

O rollup de estado de conformidade.
Error

Definição de erro.
PolicyAssignmentSummary

Resumo da atribuição de políticas.
PolicyDefinitionSummary

Resumo da definição da política.
PolicyGroupSummary

Resumo do grupo de definições de política.
PolicyStatesSummaryResourceType

O recurso virtual em PolicyStates tipo de recurso para resumir a ação. Num determinado intervalo de tempo, "mais recente" representa os estados da política mais recentes e é o único valor permitido.
QueryFailure

Resposta de erro.
SummarizeResults

Resumir os resultados da ação.
Summary

Resultados de resumo.
SummaryResults

Resumo de conformidade num nível de resumo específico.

ComplianceDetail

O rollup de estado de conformidade.

Name Tipo Description
complianceState

string

O estado de conformidade.
count

integer

Valor de contagem resumido para este estado de compatibilidade.

Error

Definição de erro.

Name Tipo Description
code

string

Código de erro específico do serviço que serve como subestado para o código de erro HTTP.
message

string

Descrição do erro.

PolicyAssignmentSummary

Resumo da atribuição de políticas.

Name Tipo Description
policyAssignmentId

string

ID de atribuição de política.
policyDefinitions

PolicyDefinitionSummary[]

Resumo das definições de política.
policyGroups

PolicyGroupSummary[]

Resumo do grupo de definições de política.
policySetDefinitionId

string

ID de definição do conjunto de políticas, se a atribuição de política for para um conjunto de políticas.
results

SummaryResults

Resumo de conformidade da atribuição de política.

PolicyDefinitionSummary

Resumo da definição da política.

Name Tipo Description
effect

string

Efeito de política, ou seja, ação de definição de política.
policyDefinitionGroupNames

string[]

Nomes de grupos de definição de política.
policyDefinitionId

string

ID de definição de política.
policyDefinitionReferenceId

string

ID de referência de definição de política.
results

SummaryResults

Resumo de conformidade da definição de política.

PolicyGroupSummary

Resumo do grupo de definições de política.

Name Tipo Description
policyGroupName

string

Nome do grupo de políticas.
results

SummaryResults

Resumo de conformidade do grupo de definições de política.

PolicyStatesSummaryResourceType

O recurso virtual em PolicyStates tipo de recurso para resumir a ação. Num determinado intervalo de tempo, "mais recente" representa os estados da política mais recentes e é o único valor permitido.

Name Tipo Description
latest

string

QueryFailure

Resposta de erro.

Name Tipo Description
error

Error

Definição de erro.

SummarizeResults

Resumir os resultados da ação.

Name Tipo Description
@odata.context

string

Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.count

integer

Contagem de entidades OData; representa o número de resumos devolvidos; sempre definido como 1.
value

Summary[]

Resumir os resultados da ação.

Summary

Resultados de resumo.

Name Tipo Description
@odata.context

string

Cadeia de contexto OData; utilizado pelos clientes OData para resolver informações de tipo com base em metadados.
@odata.id

string

ID da entidade OData; sempre definido como nulo, uma vez que os resumos não têm um ID de entidade.
policyAssignments

PolicyAssignmentSummary[]

Resumo das atribuições de políticas.
results

SummaryResults

Resumo de conformidade de todas as atribuições de políticas.

SummaryResults

Resumo de conformidade num nível de resumo específico.

Name Tipo Description
nonCompliantPolicies

integer

Número de políticas incompatíveis.
nonCompliantResources

integer

Número de recursos incompatíveis.
policyDetails

ComplianceDetail[]

O resumo do artefacto da política neste nível. Para o nível de âmbito da consulta, representa o resumo da atribuição de políticas. Para o nível de atribuição de políticas, representa o resumo das definições de política.
policyGroupDetails

ComplianceDetail[]

O resumo do grupo de definições de política a este nível.
queryResultsUri

string

HTTP POST URI for queryResults action on Microsoft.PolicyInsights to retrieve raw results for the compliance summary. Esta propriedade não estará disponível por predefinição em versões futuras da API, mas pode ser consultada explicitamente.
resourceDetails

ComplianceDetail[]

O resumo dos recursos a este nível.