Policy Events - List Query Results For Resource Group Level Policy Assignment

サービス:: Policy

API バージョン:: 2024-10-01

リソースグループレベルのポリシー割り当てのポリシーイベントを照会します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01

省略可能なパラメーターを含む:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}

URI パラメーター

名前	/	必須	型	説明
authorizationNamespace	path	True	AuthorizationNamespaceType	Microsoft Authorization リソースプロバイダーの名前空間。"Microsoft.Authorization" のみが許可されます。
policyAssignmentName	path	True	string	ポリシーの割り当て名。
policyEventsResource	path	True	PolicyEventsResourceType	PolicyEvents リソースの種類の仮想リソースの名前。"default" のみが許可されます。
resourceGroupName	path	True	string	リソースグループ名。
subscriptionId	path	True	string	Microsoft Azure subscription ID.
api-version	query	True	string	クライアント API のバージョン。
$apply	query		string	OData は集計に式を適用します。
$filter	query		string	OData フィルター式。
$from	query		string (date-time)	クエリする間隔の開始時刻を指定する ISO 8601 形式のタイムスタンプ。指定しない場合、サービスは ($to - 1 日) を使用します。
$orderby	query		string	OData 表記を使用した式の順序付け。省略可能な "desc" (既定値) または "asc" (例: "$orderby=PolicyAssignmentId, ResourceId asc" ) を持つ 1 つ以上のコンマ区切りの列名。
$select	query		string	OData 表記を使用して式を選択します。各レコードの列を、"$select=PolicyAssignmentId, ResourceId" など、要求された列のみに制限します。
$skiptoken	query		string	Skiptoken は、前の応答が nextLink 要素の一部として部分的な結果を返した場合にのみ提供されます。
$to	query		string (date-time)	クエリする間隔の終了時刻を指定する ISO 8601 形式のタイムスタンプ。指定しない場合、サービスは要求時間を使用します。
$top	query		integer (int32) minimum: 0	返されるレコードの最大数。

応答

名前	型	説明
200 OK	PolicyEventsQueryResults	クエリ結果。
Other Status Codes	QueryFailure	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Query at resource group level policy assignment scope

Query at resource group level policy assignment scope with next link

Query at resource group level policy assignment scope

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01

応答のサンプル

状態コード:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:07:16.2804863Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:06:08.4302267Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    }
  ]
}

Query at resource group level policy assignment scope with next link

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/default/queryResults?api-version=2024-10-01&$skiptoken=WpmWfBSvPhkAK6QD

応答のサンプル

状態コード:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:07:16.2804863Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity",
      "timestamp": "2018-02-08T00:06:08.4302267Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/microsoft.operationalinsights/workspaces",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "myPolicyAssignment",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": null,
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup",
      "policyDefinitionName": "myPolicyAssignment",
      "policyDefinitionAction": "deny",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": null,
      "policySetDefinitionName": null,
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47",
      "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94",
      "complianceState": "NonCompliant"
    }
  ]
}

定義

名前	説明
AuthorizationNamespaceType	Microsoft Authorization リソースプロバイダーの名前空間。"Microsoft.Authorization" のみが許可されます。
ComponentEventDetails	コンポーネントイベントの詳細。
Error	エラー定義。
PolicyEvent	ポリシーイベントレコード。
PolicyEventsQueryResults	クエリ結果。
PolicyEventsResourceType	PolicyEvents リソースの種類の仮想リソースの名前。"default" のみが許可されます。
QueryFailure	エラー応答。

AuthorizationNamespaceType

列挙

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

値	説明
Microsoft.Authorization

ComponentEventDetails

Object

コンポーネントイベントの詳細。

名前	型	説明
id	string	コンポーネント ID。
name	string	コンポーネント名。
policyDefinitionAction	string	ポリシー定義アクション、つまり効果。
principalOid	string	ポリシーイベントをトリガーしたリソースコンポーネント操作を開始したユーザーのプリンシパルオブジェクト ID。
tenantId	string	ポリシーイベントレコードのテナント ID。
timestamp	string (date-time)	コンポーネントポリシーイベントレコードのタイムスタンプ。
type	string	コンポーネントの種類。

Error

Object

エラー定義。

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

PolicyEvent

Object

ポリシーイベントレコード。

名前	型	説明
@odata.context	string	OData コンテキスト文字列。は、メタデータに基づいて型情報を解決するために OData クライアントによって使用されます。
@odata.id	string	OData エンティティ ID。ポリシーイベントレコードにはエンティティ ID がないため、常に null に設定されます。
complianceState	string	リソースのコンプライアンス状態。
components	ComponentEventDetails[]	コンポーネントイベントレコードは、URL に $expand=components 句が含まれている場合にのみ設定されます。
effectiveParameters	string	ポリシー割り当ての有効なパラメーター。
isCompliant	boolean	評価対象のポリシー割り当てに対してリソースが準拠しているかどうかを示すフラグ。
managementGroupIds	string	管理グループ ID のコンマ区切りの一覧。リソースが含まれている管理グループの階層を表します。
policyAssignmentId	string	ポリシー割り当て ID。
policyAssignmentName	string	ポリシーの割り当て名。
policyAssignmentOwner	string	ポリシー割り当て所有者。
policyAssignmentParameters	string	ポリシー割り当てパラメーター。
policyAssignmentScope	string	ポリシー割り当てスコープ。
policyDefinitionAction	string	ポリシー定義アクション、つまり効果。
policyDefinitionCategory	string	ポリシー定義カテゴリ。
policyDefinitionId	string	ポリシー定義 ID。
policyDefinitionName	string	ポリシー定義名。
policyDefinitionReferenceId	string	ポリシーの割り当てがポリシーセットの場合は、ポリシーセット内のポリシー定義の参照 ID。
policySetDefinitionCategory	string	ポリシーセット定義カテゴリ (ポリシー割り当てがポリシーセット用の場合)。
policySetDefinitionId	string	ポリシーセット定義 ID (ポリシー割り当てがポリシーセット用の場合)。
policySetDefinitionName	string	ポリシーセット定義名 (ポリシー割り当てがポリシーセット用の場合)。
policySetDefinitionOwner	string	ポリシーセット定義の所有者 (ポリシーの割り当てがポリシーセット用の場合)。
policySetDefinitionParameters	string	ポリシーセット定義パラメーター (ポリシー割り当てがポリシーセット用の場合)。
principalOid	string	ポリシーイベントをトリガーしたリソース操作を開始したユーザーのプリンシパルオブジェクト ID。
resourceGroup	string	リソースグループ名。
resourceId	string	リソース ID。
resourceLocation	string	リソースの場所。
resourceTags	string	リソースタグの一覧。
resourceType	string	リソースの種類。
subscriptionId	string	サブスクリプション ID。
tenantId	string	ポリシーイベントレコードのテナント ID。
timestamp	string (date-time)	ポリシーイベントレコードのタイムスタンプ。

PolicyEventsQueryResults

Object

クエリ結果。

名前	型	説明
@odata.context	string	OData コンテキスト文字列。は、メタデータに基づいて型情報を解決するために OData クライアントによって使用されます。
@odata.count	integer (int32) minimum: 0	OData エンティティの数。は、返されるポリシーイベントレコードの数を表します。
@odata.nextLink	string	Odata の次のリンク。次の結果セットを取得する URL。
value	PolicyEvent[]	クエリ結果。

PolicyEventsResourceType

列挙

PolicyEvents リソースの種類の仮想リソースの名前。"default" のみが許可されます。

値	説明
default

QueryFailure

Object

エラー応答。

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

次の方法で共有

Policy Events - List Query Results For Resource Group Level Policy Assignment

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

Query at resource group level policy assignment scope

要求のサンプル

応答のサンプル

Query at resource group level policy assignment scope with next link

要求のサンプル

応答のサンプル

定義

AuthorizationNamespaceType

ComponentEventDetails

Error

PolicyEvent

PolicyEventsQueryResults

PolicyEventsResourceType

QueryFailure