Policy States - Summarize For Policy Set Definition

Service:

Policy

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

With optional parameters:

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 パラメーター

名前	/	必須	型	説明
authorizationNamespace	path	True	AuthorizationNamespaceType	Microsoft Authorization リソース プロバイダーの名前空間。"Microsoft.Authorization" のみが許可されます。
policySetDefinitionName	path	True	string	ポリシー セット定義名。
policyStatesSummaryResource	path	True	PolicyStatesSummaryResourceType	summarize アクションの PolicyStates リソースの種類の下の仮想リソース。 特定の時間範囲では、'latest' は最新のポリシー状態を表し、唯一の許可される値です。
subscriptionId	path	True	string	Microsoft Azure サブスクリプション ID。
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	返されるレコードの最大数。

応答

名前	型	説明
200 OK	SummarizeResults	結果を要約します。
Other Status Codes	QueryFailure	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Summarize at policy set definition scope

Sample Request

HTTP

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'

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.policyinsights.models.PolicyStatesSummaryResourceType;
import java.time.OffsetDateTime;

/** Samples for PolicyStates SummarizeForPolicySetDefinition. */
public final class Main {
    /*
     * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json
     */
    /**
     * Sample code: Summarize at policy set definition scope.
     *
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void summarizeAtPolicySetDefinitionScope(
        com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager
            .policyStates()
            .summarizeForPolicySetDefinitionWithResponse(
                PolicyStatesSummaryResourceType.LATEST,
                "fffedd8f-ffff-fffd-fffd-fffed2f84852",
                "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
                1,
                OffsetDateTime.parse("2019-10-05T18:00:00Z"),
                OffsetDateTime.parse("2019-10-06T18:00:00Z"),
                "PolicyDefinitionAction eq 'deny'",
                Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.policyinsights import PolicyInsightsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python policy_states_summarize_subscription_level_policy_set_definition_scope.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyInsightsClient(
        credential=DefaultAzureCredential(),
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
    )

    response = client.policy_states.summarize_for_policy_set_definition(
        policy_states_summary_resource="latest",
        subscription_id="fffedd8f-ffff-fffd-fffd-fffed2f84852",
        policy_set_definition_name="3e3807c1-65c9-49e0-a406-82d8ae3e338c",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpolicyinsights_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/policyinsights/armpolicyinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/05a9cdab363b8ec824094ee73950c04594325172/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json
func ExamplePolicyStatesClient_SummarizeForPolicySetDefinition() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpolicyinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPolicyStatesClient().SummarizeForPolicySetDefinition(ctx, armpolicyinsights.PolicyStatesSummaryResourceTypeLatest, "fffedd8f-ffff-fffd-fffd-fffed2f84852", "3e3807c1-65c9-49e0-a406-82d8ae3e338c", &armpolicyinsights.QueryOptions{Top: to.Ptr[int32](1),
		Filter:    to.Ptr("PolicyDefinitionAction eq 'deny'"),
		OrderBy:   nil,
		Select:    nil,
		From:      to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-05T18:00:00.000Z"); return t }()),
		To:        to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-10-06T18:00:00.000Z"); return t }()),
		Apply:     nil,
		SkipToken: nil,
		Expand:    nil,
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SummarizeResults = armpolicyinsights.SummarizeResults{
	// 	ODataContext: to.Ptr("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"),
	// 	ODataCount: to.Ptr[int32](1),
	// 	Value: []*armpolicyinsights.Summary{
	// 		{
	// 			ODataContext: to.Ptr("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"),
	// 			PolicyAssignments: []*armpolicyinsights.PolicyAssignmentSummary{
	// 			},
	// 			Results: &armpolicyinsights.SummaryResults{
	// 				NonCompliantPolicies: to.Ptr[int32](0),
	// 				NonCompliantResources: to.Ptr[int32](0),
	// 				PolicyDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("compliant"),
	// 						Count: to.Ptr[int32](1),
	// 				}},
	// 				PolicyGroupDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("compliant"),
	// 						Count: to.Ptr[int32](1),
	// 				}},
	// 				QueryResultsURI: to.Ptr("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"),
	// 				ResourceDetails: []*armpolicyinsights.ComplianceDetail{
	// 					{
	// 						ComplianceState: to.Ptr("compliant"),
	// 						Count: to.Ptr[int32](140),
	// 				}},
	// 			},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PolicyInsightsClient } = require("@azure/arm-policyinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Summarizes policy states for the subscription level policy set definition.
 *
 * @summary Summarizes policy states for the subscription level policy set definition.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json
 */
async function summarizeAtPolicySetDefinitionScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const policyStatesSummaryResource = "latest";

  const policySetDefinitionName = "3e3807c1-65c9-49e0-a406-82d8ae3e338c";
  const top = 1;
  const fromParam = new Date("2019-10-05T18:00:00Z");
  const to = new Date("2019-10-06T18:00:00Z");
  const filter = "PolicyDefinitionAction eq 'deny'";
  const options = {
    queryOptions: { top: top, to: to, from: fromParam, filter: filter },
  };
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.policyStates.summarizeForPolicySetDefinition(
    policyStatesSummaryResource,
    subscriptionId,
    policySetDefinitionName,
    options
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "@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	summarize アクションの PolicyStates リソースの種類の下の仮想リソース。 特定の時間範囲では、'latest' は最新のポリシー状態を表し、唯一の許可される値です。
QueryFailure	エラー応答。
SummarizeResults	アクションの結果を要約します。
Summary	概要の結果。
SummaryResults	特定の概要レベルでのコンプライアンスの概要。

AuthorizationNamespaceType

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

名前	型	説明
Microsoft.Authorization	string

ComplianceDetail

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

名前	型	説明
complianceState	string	コンプライアンスの状態。
count	integer	このコンプライアンス状態の集計カウント値。

Error

エラー定義。

名前	型	説明
code	string	HTTP エラー コードのサブステータスとして機能するサービス固有のエラー コード。
message	string	エラーの説明。

PolicyAssignmentSummary

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

名前	型	説明
policyAssignmentId	string	ポリシー割り当て ID。
policyDefinitions	PolicyDefinitionSummary[]	ポリシー定義の概要。
policyGroups	PolicyGroupSummary[]	ポリシー定義グループの概要。
policySetDefinitionId	string	ポリシー セット定義 ID (ポリシーの割り当てがポリシー セットの場合)。
results	SummaryResults	ポリシー割り当てのコンプライアンスの概要。

PolicyDefinitionSummary

ポリシー定義の概要。

名前	型	説明
effect	string	ポリシー効果、つまりポリシー定義アクション。
policyDefinitionGroupNames	string[]	ポリシー定義グループ名。
policyDefinitionId	string	ポリシー定義 ID。
policyDefinitionReferenceId	string	ポリシー定義参照 ID。
results	SummaryResults	ポリシー定義のコンプライアンスの概要。

PolicyGroupSummary

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

名前	型	説明
policyGroupName	string	ポリシー グループ名。
results	SummaryResults	ポリシー定義グループのコンプライアンスの概要。

PolicyStatesSummaryResourceType

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

名前	型	説明
latest	string

QueryFailure

エラー応答。

名前	型	説明
error	Error	エラー定義。

SummarizeResults

アクションの結果を要約します。

名前	型	説明
@odata.context	string	OData コンテキスト文字列。は、メタデータに基づいて型情報を解決するために OData クライアントによって使用されます。
@odata.count	integer	OData エンティティ数。は、返される要約の数を表します。常に 1 に設定されます。
value	Summary[]	アクションの結果を要約します。

Summary

概要の結果。

名前	型	説明
@odata.context	string	OData コンテキスト文字列。は、メタデータに基づいて型情報を解決するために OData クライアントによって使用されます。
@odata.id	string	OData エンティティ ID。集計にはエンティティ ID がないため、常に null に設定されます。
policyAssignments	PolicyAssignmentSummary[]	ポリシー割り当ての概要。
results	SummaryResults	すべてのポリシー割り当てのコンプライアンスの概要。

SummaryResults

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

名前	型	説明
nonCompliantPolicies	integer	非準拠ポリシーの数。
nonCompliantResources	integer	非準拠リソースの数。
policyDetails	ComplianceDetail[]	このレベルのポリシー成果物の概要。 クエリ スコープ レベルの場合は、ポリシー割り当ての概要を表します。 ポリシー割り当てレベルでは、ポリシー定義の概要を表します。
policyGroupDetails	ComplianceDetail[]	このレベルのポリシー定義グループの概要。
queryResultsUri	string	コンプライアンスの概要の生の結果を取得するための Microsoft.PolicyInsights の queryResults アクションの HTTP POST URI。 このプロパティは、将来の API バージョンでは既定では使用できませんが、明示的にクエリを実行できます。
resourceDetails	ComplianceDetail[]	このレベルのリソースの概要。