Policy Assignments - List

リファレンス

サービス:: Policy

API バージョン:: 2023-04-01

サブスクリプションに適用されるすべてのポリシー割り当てを取得します。
この操作では、指定したサブスクリプションに関連付けられている、オプションの指定した$filterと一致するすべてのポリシー割り当ての一覧を取得します。 $filterの有効な値は、'atScope()'、'atExactScope()' または 'policyDefinitionId eq '{value}' です。 $filter指定されていない場合、フィルター処理されていない一覧には、サブスクリプションに関連付けられているすべてのポリシー割り当て (指定されたサブスクリプションを含む直接または管理グループから適用されるポリシー割り当て、およびサブスクリプション内に含まれるオブジェクトに適用されるものを含む) が含まれます。 $filter=atScope() が指定されている場合、返されるリストには、サブスクリプションに適用されるすべてのポリシー割り当てが含まれます。これは、サブスクリプション内に含まれるオブジェクトに適用されるものを除き、フィルター処理されていないリスト内のすべてのポリシー割り当てです。 $filter=atExactScope() が指定されている場合、返されるリストには、サブスクリプションのすべてのポリシー割り当てのみが含まれます。 $filter=policyDefinitionId eq '{value}' が指定されている場合、返されるリストには、ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments?api-version=2023-04-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments?$filter={$filter}&$expand={$expand}&$top={$top}&api-version=2023-04-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。
$expand	query		string	応答に含める追加プロパティのコンマ区切りの一覧。サポートされている値は 'LatestDefinitionVersion, EffectiveDefinitionVersion' です。
$filter	query		string	操作に適用するフィルター。 $filterの有効な値は、'atScope()'、'atExactScope()' または 'policyDefinitionId eq '{value}' です。 $filterが指定されていない場合、フィルター処理は実行されません。 $filter=atScope() が指定されている場合、返されるリストには、スコープに適用されるすべてのポリシー割り当てのみが含まれます。これは、指定されたスコープ内に含まれるサブスコープに適用されるものを除き、フィルター処理されていないリスト内のすべてのポリシー割り当てです。 $filter=atExactScope() が指定されている場合、返されるリストには、指定されたスコープにあるすべてのポリシー割り当てのみが含まれます。 $filter=policyDefinitionId eq '{value}' が指定されている場合、返されるリストには、ID が {value} であるポリシー定義のすべてのポリシー割り当てが含まれます。
$top	query		integer int32	返されるレコードの最大数。 $top フィルターが指定されていない場合、500 レコードが返されます。

応答

名前	型	説明
200 OK	PolicyAssignmentListResult	OK - ポリシー割り当ての配列を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

List policy assignments that apply to a subscription

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments?$filter=atScope()&$expand=LatestDefinitionVersion, EffectiveDefinitionVersion&api-version=2023-04-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "CostManagement",
      "location": "eastus",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      },
      "properties": {
        "displayName": "Storage Cost Management",
        "description": "Minimize the risk of accidental cost overruns",
        "metadata": {
          "category": "Cost Management"
        },
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "parameters": {
          "allowedSkus": {
            "value": "Standard_A1"
          }
        },
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    },
    {
      "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/TagEnforcement",
      "type": "Microsoft.Authorization/policyAssignments",
      "name": "TagEnforcement",
      "properties": {
        "displayName": "Enforces a tag key and value",
        "description": "Ensure a given tag key and value are present on all resources",
        "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue",
        "definitionVersion": "1.*.*",
        "latestDefinitionVersion": "1.0.0",
        "effectiveDefinitionVersion": "1.0.0",
        "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
        "notScopes": []
      }
    }
  ]
}

定義

名前	説明
CloudError	ポリシー操作からのエラー応答。
createdByType	リソースを作成した ID の種類。
enforcementMode	ポリシー割り当て適用モード。使用できる値は Default と DoNotEnforce です。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
Identity	リソースの ID。ポリシー割り当てでは、最大 1 つの ID がサポートされます。これは、システム割り当て ID または単一ユーザー割り当て ID のいずれかです。
NonComplianceMessage	リソースがポリシーに準拠していない理由を説明するメッセージ。これは、"拒否" エラーメッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。
Override	ポリシープロパティ値のオーバーライド。
OverrideKind	オーバーライドの種類。
ParameterValuesValue	パラメーターの値。
PolicyAssignment	ポリシーの割り当て。
PolicyAssignmentListResult	ポリシー割り当ての一覧。
ResourceIdentityType	ID の種類。これは、システム割り当て ID またはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。
ResourceSelector	リソースプロパティでポリシーをフィルター処理するリソースセレクター。
Selector	セレクター式。
SelectorKind	セレクターの種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentities	ポリシーに関連付けられているユーザー ID。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

CloudError

ポリシー操作からのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

enforcementMode

ポリシー割り当て適用モード。使用できる値は Default と DoNotEnforce です。

名前	型	説明
Default	string	ポリシー効果は、リソースの作成または更新中に適用されます。
DoNotEnforce	string	ポリシー効果は、リソースの作成時または更新中には適用されません。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorResponse[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

Identity

リソースの ID。ポリシー割り当てでは、最大 1 つの ID がサポートされます。これは、システム割り当て ID または単一ユーザー割り当て ID のいずれかです。

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。このプロパティは、システム割り当て ID に対してのみ提供されます
tenantId	string	リソース ID のテナント ID。このプロパティは、システム割り当て ID に対してのみ提供されます
type	ResourceIdentityType	ID の種類。これは、システム割り当て ID またはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。
userAssignedIdentities	UserAssignedIdentities	ポリシーに関連付けられているユーザー ID。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

NonComplianceMessage

リソースがポリシーに準拠していない理由を説明するメッセージ。これは、"拒否" エラーメッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。

名前	型	説明
message	string	リソースがポリシーに準拠していない理由を説明するメッセージ。これは、"拒否" エラーメッセージと、リソースの準拠していないコンプライアンスの結果に表示されます。
policyDefinitionReferenceId	string	メッセージの対象となるポリシーセット定義内のポリシー定義参照 ID。これは、ポリシー割り当てによってポリシーセット定義が割り当てられている場合にのみ適用されます。これが指定されていない場合、メッセージは、このポリシー割り当てによって割り当てられたすべてのポリシーに適用されます。

Override

ポリシープロパティ値のオーバーライド。

名前	型	説明
kind	OverrideKind	オーバーライドの種類。
selectors	Selector[]	セレクター式の一覧。
value	string	ポリシープロパティをオーバーライドする値。

OverrideKind

オーバーライドの種類。

名前	型	説明
policyEffect	string	ポリシー効果の種類がオーバーライドされます。

ParameterValuesValue

パラメーターの値。

名前	型	説明
value	object	パラメーターの値。