Policy States - Summarize For Management Group

Служба:: Policy

Версия API:: 2024-10-01

Суммирует состояния политики для ресурсов в группе управления.

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2024-10-01

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
managementGroupName	path	True	string	Имя группы управления.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".
policyStatesSummaryResource	path	True	PolicyStatesSummaryResourceType	Виртуальный ресурс в типе ресурса PolicyStates для суммирования действий. В заданном диапазоне времени "последняя" представляет последние состояния политики и является единственным допустимым значением.
api-version	query	True	string	Версия клиентского API.
$filter	query		string	Выражение фильтра OData.
$from	query		string (date-time)	Отформатированная метка времени ISO 8601, указывающая время начала интервала для запроса. Если это не указано, служба использует ($to – 1 день).
$to	query		string (date-time)	Отформатированная метка времени ISO 8601, указывающая время окончания интервала для запроса. Если это не указано, служба использует время запроса.
$top	query		integer (int32) minimum: 0	Максимальное количество возвращаемых записей.

Ответы

Имя	Тип	Описание
200 OK	SummarizeResults	Суммирование результатов.
Other Status Codes	QueryFailure	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Summarize at management group scope

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "@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=2024-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": []
    }
  ]
}

Определения

Имя	Описание
ComplianceDetail	Свертка состояния соответствия.
Error	Определение ошибки.
ManagementGroupsNamespaceType	Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".
PolicyAssignmentSummary	Сводка по назначению политик.
PolicyDefinitionSummary	Сводка по определению политики.
PolicyGroupSummary	Сводка по группе определений политики.
PolicyStatesSummaryResourceType	Виртуальный ресурс в типе ресурса PolicyStates для суммирования действий. В заданном диапазоне времени "последняя" представляет последние состояния политики и является единственным допустимым значением.
QueryFailure	Ответ на ошибку.
SummarizeResults	Суммирование результатов действия.
Summary	Сводные результаты.
SummaryResults	Сводка по соответствию определенному уровню сводки.

ComplianceDetail

Объект

Свертка состояния соответствия.

Имя	Тип	Описание
complianceState	string	Состояние соответствия.
count	integer (int32)	Суммируемое значение счетчика для этого состояния соответствия.

Error

Объект

Определение ошибки.

Имя	Тип	Описание
code	string	Код ошибки конкретной службы, который служит подстатусом для кода ошибки HTTP.
message	string	Описание ошибки.

ManagementGroupsNamespaceType

Перечисление

Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".

Значение	Описание
Microsoft.Management

PolicyAssignmentSummary

Объект

Сводка по назначению политик.

Имя	Тип	Описание
policyAssignmentId	string	Идентификатор назначения политики.
policyDefinitions	PolicyDefinitionSummary[]	Сводка определений политик.
policyGroups	PolicyGroupSummary[]	Сводка по группе определений политики.
policySetDefinitionId	string	Идентификатор определения набора политик, если назначение политики предназначено для набора политик.
results	SummaryResults	Сводка по соответствию назначению политики.

PolicyDefinitionSummary

Объект

Сводка по определению политики.

Имя	Тип	Описание
effect	string	Эффект политики, т. е. действие определения политики.
policyDefinitionGroupNames	string[]	Имена групп определений политик.
policyDefinitionId	string	Идентификатор определения политики.
policyDefinitionReferenceId	string	Идентификатор ссылки на определение политики.
results	SummaryResults	Сводка по соответствию определению политики.

PolicyGroupSummary

Объект

Сводка по группе определений политики.

Имя	Тип	Описание
policyGroupName	string	Имя группы политик.
results	SummaryResults	Сводка по соответствию для группы определений политики.

PolicyStatesSummaryResourceType

Перечисление

Виртуальный ресурс в типе ресурса PolicyStates для суммирования действий. В заданном диапазоне времени "последняя" представляет последние состояния политики и является единственным допустимым значением.

Значение	Описание
latest

QueryFailure

Объект

Ответ на ошибку.

Имя	Тип	Описание
error	Error	Определение ошибки.

SummarizeResults

Объект

Суммирование результатов действия.

Имя	Тип	Описание
@odata.context	string	Строка контекста OData; используется клиентами OData для разрешения сведений о типе на основе метаданных.
@odata.count	integer (int32) minimum: 1 maximum: 1	Число сущностей OData; представляет количество возвращенных сводок; всегда задано значение 1.
value	Summary[]	Суммирование результатов действия.

Summary

Объект

Сводные результаты.

Имя	Тип	Описание
@odata.context	string	Строка контекста OData; используется клиентами OData для разрешения сведений о типе на основе метаданных.
@odata.id	string	Идентификатор сущности OData; всегда задано значение NULL, так как сводки не имеют идентификатора сущности.
policyAssignments	PolicyAssignmentSummary[]	Сводка назначений политик.
results	SummaryResults	Сводка по соответствию всем назначениям политик.

SummaryResults

Объект

Сводка по соответствию определенному уровню сводки.

Имя	Тип	Описание
nonCompliantPolicies	integer (int32) minimum: 0	Число несоответствуемых политик.
nonCompliantResources	integer (int32) minimum: 0	Число несоответствуемых ресурсов.
policyDetails	ComplianceDetail[]	Сводка по артефактам политики на этом уровне. Для уровня области запроса он представляет сводку по назначению политик. Для уровня назначения политики он представляет сводку определений политик.
policyGroupDetails	ComplianceDetail[]	Сводка по группе определений политики на этом уровне.
queryResultsUri	string	URI HTTP POST для действия queryResults в Microsoft.PolicyInsights для получения необработанных результатов для сводки соответствия требованиям. Это свойство не будет доступно по умолчанию в будущих версиях API, но может быть явно запрошено.
resourceDetails	ComplianceDetail[]	Сводка по ресурсам на этом уровне.