次の方法で共有


Policy States - List Query Results For Resource Group

リソース グループのリソースに対してポリシーの状態を照会します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}

URI パラメーター

名前 / 必須 説明
policyStatesResource
path True

PolicyStatesResource

PolicyStates リソースの種類の下の仮想リソース。 特定の時間範囲では、'latest' は最新のポリシー状態を表し、'default' はすべてのポリシー状態を表します。

resourceGroupName
path True

string

リソース グループ名。

subscriptionId
path True

string

Microsoft Azure サブスクリプション 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

PolicyStatesQueryResults

クエリ結果。

Other Status Codes

QueryFailure

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

Query latest at resource group scope
Query latest at resource group scope with next link

Query latest at resource group scope

要求のサンプル

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01

応答のサンプル

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

要求のサンプル

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$skiptoken=WpmWfBSvPhkAK6QD

応答のサンプル

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    }
  ]
}

定義

名前 説明
ComponentStateDetails

コンポーネントの状態の詳細。

Error

エラー定義。

ExpressionEvaluationDetails

ポリシー言語式の評価の詳細。

IfNotExistsEvaluationDetails

IfNotExists 効果の評価の詳細。

PolicyEvaluationDetails

ポリシー評価の詳細。

PolicyState

ポリシー状態レコード。

PolicyStatesQueryResults

クエリ結果。

PolicyStatesResource

PolicyStates リソースの種類の下の仮想リソース。 特定の時間範囲では、'latest' は最新のポリシー状態を表し、'default' はすべてのポリシー状態を表します。

QueryFailure

エラー応答。

ComponentStateDetails

コンポーネントの状態の詳細。

名前 説明
complianceState

string

コンポーネントのコンプライアンス状態。

id

string

コンポーネント ID。

name

string

コンポーネント名。

timestamp

string (date-time)

コンポーネント コンプライアンス評価タイムスタンプ。

type

string

コンポーネントの種類。

Error

エラー定義。

名前 説明
code

string

HTTP エラー コードのサブステータスとして機能するサービス固有のエラー コード。

message

string

エラーの説明。

ExpressionEvaluationDetails

ポリシー言語式の評価の詳細。

名前 説明
expression

string

評価された式。

expressionKind

string

評価された式の種類。

expressionValue

object

式の値。

operator

string

式の値とターゲット値を比較する演算子。

path

string

式がフィールドまたはエイリアスの場合のプロパティ パス。

result

string

評価結果。

targetValue

object

式の値と比較する対象の値。

IfNotExistsEvaluationDetails

IfNotExists 効果の評価の詳細。

名前 説明
resourceId

string

IfNotExists 効果の最後に評価されたリソースの ID。

totalResources

integer

存在条件が適用されるリソースの合計数。

PolicyEvaluationDetails

ポリシー評価の詳細。

名前 説明
evaluatedExpressions

ExpressionEvaluationDetails[]

評価された式の詳細。

ifNotExistsDetails

IfNotExistsEvaluationDetails

IfNotExists 効果の評価の詳細。

PolicyState

ポリシー状態レコード。

名前 説明
@odata.context

string

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

@odata.id

string

OData エンティティ ID。ポリシー状態レコードにはエンティティ ID がないため、常に null に設定されます。

complianceState

string

リソースのコンプライアンス状態。

components

ComponentStateDetails[]

コンポーネントの状態コンプライアンス レコードは、URL に $expand=components 句が含まれている場合にのみ設定されます。

effectiveParameters

string

ポリシー割り当ての有効なパラメーター。

isCompliant

boolean

評価対象のポリシー割り当てに対してリソースが準拠しているかどうかを示すフラグ。 このプロパティは非推奨です。代わりに ComplianceState を使用してください。

managementGroupIds

string

管理グループ ID のコンマ区切りの一覧。リソースが含まれている管理グループの階層を表します。

policyAssignmentId

string

ポリシー割り当て ID。

policyAssignmentName

string

ポリシーの割り当て名。

policyAssignmentOwner

string

ポリシー割り当て所有者。

policyAssignmentParameters

string

ポリシー割り当てパラメーター。

policyAssignmentScope

string

ポリシー割り当てスコープ。

policyAssignmentVersion

string

評価されたポリシー割り当てのバージョン。

policyDefinitionAction

string

ポリシー定義アクション、つまり効果。

policyDefinitionCategory

string

ポリシー定義カテゴリ。

policyDefinitionGroupNames

string[]

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

policyDefinitionId

string

ポリシー定義 ID。

policyDefinitionName

string

ポリシー定義名。

policyDefinitionReferenceId

string

ポリシーの割り当てがポリシー セットの場合は、ポリシー セット内のポリシー定義の参照 ID。

policyDefinitionVersion

string

評価されたポリシー定義のバージョン。

policyEvaluationDetails

PolicyEvaluationDetails

ポリシー評価の詳細。

policySetDefinitionCategory

string

ポリシー セット定義カテゴリ (ポリシー割り当てがポリシー セット用の場合)。

policySetDefinitionId

string

ポリシー セット定義 ID (ポリシー割り当てがポリシー セット用の場合)。

policySetDefinitionName

string

ポリシー セット定義名 (ポリシー割り当てがポリシー セット用の場合)。

policySetDefinitionOwner

string

ポリシー セット定義の所有者 (ポリシーの割り当てがポリシー セット用の場合)。

policySetDefinitionParameters

string

ポリシー セット定義パラメーター (ポリシー割り当てがポリシー セット用の場合)。

policySetDefinitionVersion

string

評価されたポリシー セット定義のバージョン。

resourceGroup

string

リソース グループ名。

resourceId

string

リソース ID。

resourceLocation

string

リソースの場所。

resourceTags

string

リソース タグの一覧。

resourceType

string

リソースの種類。

subscriptionId

string

サブスクリプション ID。

timestamp

string (date-time)

ポリシー状態レコードのタイムスタンプ。

PolicyStatesQueryResults

クエリ結果。

名前 説明
@odata.context

string

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

@odata.count

integer (int32)

minimum: 0

OData エンティティの数。は、返されるポリシー状態レコードの数を表します。

@odata.nextLink

string

Odata の次のリンク。次の結果セットを取得する URL。

value

PolicyState[]

クエリ結果。

PolicyStatesResource

PolicyStates リソースの種類の下の仮想リソース。 特定の時間範囲では、'latest' は最新のポリシー状態を表し、'default' はすべてのポリシー状態を表します。

説明
default
latest

QueryFailure

エラー応答。

名前 説明
error

Error

エラー定義。