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

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

policySetDefinitionName
path True
  • string

ポリシー セット定義名。

policyStatesSummaryResource
path True

集計アクションの 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

OAuth2 FlowをAzure Active Directoryする

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": []
    }
  ]
}

定義

AuthorizationNamespaceType

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

ComplianceDetail

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

Error

エラー定義。

PolicyAssignmentSummary

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

PolicyDefinitionSummary

ポリシー定義の概要。

PolicyGroupSummary

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

PolicyStatesSummaryResourceType

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

QueryFailure

エラー応答。

SummarizeResults

アクションの結果を集計します。

Summary

概要の結果。

SummaryResults

特定の概要レベルでのコンプライアンスの概要。

AuthorizationNamespaceType

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

Name Type Description
Microsoft.Authorization
  • string

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

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

PolicyStatesSummaryResourceType

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

Name Type Description
latest
  • string

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

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

resourceDetails

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