Policy States - Summarize For Policy Set Definition

サブスクリプションレベルのポリシーセットの定義に関するポリシーの状態の概要を示します。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top={$top}&$from={$from}&$to={$to}&$filter={$filter}

URI パラメーター

Name In Required Type Description
authorizationNamespace
path True
  • string

Microsoft Authorization リソースプロバイダーの名前空間。"Microsoft Authorization" のみが許可されます。

policySetDefinitionName
path True
  • string

ポリシーセットの定義名。

policyStatesSummaryResource
path True
  • string

[概要] アクションの [PolicyStates リソースの種類] の下にある仮想リソース。 特定の時間範囲内では、' latest ' は最新のポリシーの状態を表し、許可される唯一の値です。

subscriptionId
path True
  • string

サブスクリプション ID を Microsoft Azure します。

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

返されるレコードの最大数。

応答

Name Type Description
200 OK

結果を集約します。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

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

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

Summarize at policy set definition scope

Sample Request

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top=1&$from=2019-10-05T18:00:00Z&$to=2019-10-06T18:00:00Z&$filter=PolicyDefinitionAction eq 'deny'

Sample Response

{
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/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/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
      "results": {
        "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/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') and IsCompliant eq false",
        "nonCompliantResources": 0,
        "nonCompliantPolicies": 0,
        "resourceDetails": [
          {
            "complianceState": "compliant",
            "count": 140
          }
        ],
        "policyDetails": [
          {
            "complianceState": "compliant",
            "count": 1
          }
        ],
        "policyGroupDetails": [
          {
            "complianceState": "compliant",
            "count": 1
          }
        ]
      },
      "policyAssignments": []
    }
  ]
}

定義

ComplianceDetail

コンプライアンスの状態のロールアップ。

Error

エラーの定義。

PolicyAssignmentSummary

ポリシー割り当ての概要。

PolicyDefinitionSummary

ポリシー定義の概要。

PolicyGroupSummary

ポリシー定義グループの概要。

QueryFailure

エラー応答。

SummarizeResults

アクションの結果の概要を表示します。

Summary

概要結果。

SummaryResults

特定の概要レベルでの対応の概要。

ComplianceDetail

コンプライアンスの状態のロールアップ。

Name Type Description
complianceState
  • string

コンプライアンスの状態。

count
  • integer

このコンプライアンス対応状態の集計値。

Error

エラーの定義。

Name Type Description
code
  • string

HTTP エラーコードの副状態として機能するサービス固有のエラーコード。

message
  • string

エラーの説明。

PolicyAssignmentSummary

ポリシー割り当ての概要。

Name Type Description
policyAssignmentId
  • string

ポリシー割り当て ID。

policyDefinitions

ポリシー定義の概要。

policyGroups

ポリシー定義グループの概要。

policySetDefinitionId
  • string

ポリシーが設定されている場合は、ポリシーセットの定義 ID。

results

ポリシー割り当てのコンプライアンスの概要。

PolicyDefinitionSummary

ポリシー定義の概要。

Name Type Description
effect
  • string

ポリシーの効果 (ポリシー定義アクションなど)。

policyDefinitionGroupNames
  • string[]

ポリシー定義グループ名。

policyDefinitionId
  • string

ポリシー定義 ID。

policyDefinitionReferenceId
  • string

ポリシー定義の参照 ID。

results

ポリシー定義のコンプライアンスの概要。

PolicyGroupSummary

ポリシー定義グループの概要。

Name Type Description
policyGroupName
  • string

ポリシーグループ名。

results

ポリシー定義グループのコンプライアンスの概要。

QueryFailure

エラー応答。

Name Type Description
error

エラーの定義。

SummarizeResults

アクションの結果の概要を表示します。

Name Type Description
@odata.context
  • string

OData コンテキスト文字列;メタデータに基づいて型情報を解決するために、OData クライアントによって使用されます。

@odata.count
  • integer

OData エンティティ数。返される集計の数を表します。常に1に設定します。

value

アクションの結果の概要を表示します。

Summary

概要結果。

Name Type Description
@odata.context
  • string

OData コンテキスト文字列;メタデータに基づいて型情報を解決するために、OData クライアントによって使用されます。

@odata.id
  • string

OData エンティティ ID。概要にはエンティティ ID がないため、常に null に設定されます。

policyAssignments

ポリシー割り当ての概要。

results

すべてのポリシー割り当てのコンプライアンスの概要。

SummaryResults

特定の概要レベルでの対応の概要。

Name Type Description
nonCompliantPolicies
  • integer

非準拠ポリシーの数。

nonCompliantResources
  • integer

準拠していないリソースの数。

policyDetails

このレベルでのポリシーアーティファクトの概要。 クエリスコープレベルでは、ポリシー割り当ての概要を表します。 ポリシー割り当てレベルでは、ポリシー定義の概要を表します。

policyGroupDetails

このレベルでのポリシー定義グループの概要。

queryResultsUri
  • string

コンプライアンスの概要の生の結果を取得するための、queryResults action の HTTP POST URI。 このプロパティは、今後の API バージョンでは既定では使用できませんが、明示的にクエリを実行することができます。

resourceDetails

このレベルでのリソースの概要。