次の方法で共有

Policy Assignments - Get

  • リファレンス
サービス:
Policy
API バージョン:
2023-04-01

ポリシーの割り当てを取得します。
この操作では、名前と作成されたスコープを指定して、1 つのポリシー割り当てを取得します。

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?api-version=2023-04-01
省略可能なパラメーターを含む: 
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}?$expand={$expand}&api-version=2023-04-01

URI パラメーター

名前 / 必須 型 説明
policyAssignmentName
 path True

string

取得するポリシー割り当ての名前。

正規表現パターン: ^[^<>*%&:\?.+/]*[^<>*%&:\?.+/ ]+$
scope
 path True

string

ポリシー割り当てのスコープ。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroup}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。 またはリソース (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
api-version
 query True

string

この操作に使用する API バージョン。
$expand
 query

string

応答に含める追加プロパティのコンマ区切りの一覧。 サポートされている値は 'LatestDefinitionVersion, EffectiveDefinitionVersion' です。

応答

名前 型 説明
200 OK

PolicyAssignment

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 ユーザー アカウントを偽装する

例

Retrieve a policy assignment
Retrieve a policy assignment with a system assigned identity
Retrieve a policy assignment with a user assigned identity
Retrieve a policy assignment with overrides
Retrieve a policy assignment with resource selectors

Retrieve a policy assignment

要求のサンプル

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

応答のサンプル

状態コード:
200 
{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a system assigned identity

要求のサンプル

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

応答のサンプル

状態コード:
200 
{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
    "tenantId": "4bee2b8a-1bee-47c2-90e9-404241551135"
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with a user assigned identity

要求のサンプル

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming?api-version=2023-04-01

応答のサンプル

状態コード:
200 
{
  "properties": {
    "displayName": "Enforce resource naming rules",
    "description": "Force resource names to begin with given DeptA and end with -LC",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "parameters": {
      "prefix": {
        "value": "DeptA"
      },
      "suffix": {
        "value": "-LC"
      }
    },
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/testResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-identity": {
        "principalId": "e6d23f8d-af97-4fbc-bda6-00604e4e3d0a",
        "clientId": "4bee2b8a-1bee-47c2-90e9-404241551135"
      }
    }
  },
  "location": "westus",
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "EnforceNaming"
}

Retrieve a policy assignment with overrides

要求のサンプル

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

応答のサンプル

状態コード:
200 
{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "overrides": [
      {
        "kind": "policyEffect",
        "value": "Audit",
        "selectors": [
          {
            "kind": "policyDefinitionReferenceId",
            "in": [
              "Limit_Skus",
              "Limit_Locations"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

Retrieve a policy assignment with resource selectors

要求のサンプル

GET https://management.azure.com/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement?api-version=2023-04-01

応答のサンプル

状態コード:
200 
{
  "properties": {
    "displayName": "Limit the resource location and resource SKU",
    "description": "Limit the resource location and resource SKU",
    "metadata": {
      "assignedBy": "Special Someone"
    },
    "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement",
    "definitionVersion": "1.*.*",
    "notScopes": [],
    "enforcementMode": "Default",
    "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2",
    "resourceSelectors": [
      {
        "name": "SDPRegions",
        "selectors": [
          {
            "kind": "resourceLocation",
            "in": [
              "eastus2euap",
              "centraluseuap"
            ]
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement",
  "type": "Microsoft.Authorization/policyAssignments",
  "name": "CostManagement"
}

定義

名前 説明
CloudError

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

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

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

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

エラー応答
Identity

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

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

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

オーバーライドの種類。
ParameterValuesValue

パラメーターの値。
PolicyAssignment

ポリシーの割り当て。
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

パラメーターの値。

PolicyAssignment

ポリシーの割り当て。

名前 型 規定値 説明
id

string

ポリシー割り当ての ID。
identity

Identity

ポリシーの割り当てに関連付けられているマネージド ID。
location

string

ポリシー割り当ての場所。 マネージド ID を使用する場合にのみ必要です。
name

string

ポリシー割り当ての名前。
properties.definitionVersion

string

使用するポリシー定義のバージョン。
properties.description

string

このメッセージは、ポリシー違反が発生した場合の応答の一部になります。
properties.displayName

string

ポリシー割り当ての表示名。
properties.effectiveDefinitionVersion

string

使用中のポリシー定義の有効なバージョン。 これは、$expand クエリ パラメーターを使用して要求された場合にのみ存在します。
properties.enforcementMode

enforcementMode

Default

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

string

使用可能なポリシー定義の最新バージョン。 これは、$expand クエリ パラメーターを使用して要求された場合にのみ存在します。
properties.metadata

object

ポリシー割り当てのメタデータ。 メタデータはオープン エンド オブジェクトであり、通常はキーと値のペアのコレクションです。
properties.nonComplianceMessages

NonComplianceMessage[]

リソースがポリシーに準拠していない理由を説明するメッセージ。
properties.notScopes

string[]

ポリシーの除外されたスコープ。
properties.overrides

Override[]

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

<string,  ParameterValuesValue>

割り当てられたポリシー ルールのパラメーター値。 キーはパラメーター名です。
properties.policyDefinitionId

string

割り当てられているポリシー定義またはポリシー セット定義の ID。
properties.resourceSelectors

ResourceSelector[]

リソース のプロパティでポリシーをフィルター処理するリソース セレクターの一覧。
properties.scope

string

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

systemData

このリソースに関連するシステム メタデータ。
type

string

ポリシー割り当ての種類。

ResourceIdentityType

ID の種類。 これは、システム割り当て ID またはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。

名前 型 説明
None

string

リソースに関連付けられている ID が存在しないか、既存の ID を削除する必要があることを示します。
SystemAssigned

string

システム割り当て ID がリソースに関連付けられていることを示します。
UserAssigned

string

システム割り当て ID がリソースに関連付けられていることを示します。

ResourceSelector

リソース プロパティでポリシーをフィルター処理するリソース セレクター。

名前 型 説明
name

string

リソース セレクターの名前。
selectors

Selector[]

セレクター式の一覧。

Selector

セレクター式。

名前 型 説明
in

string[]

フィルター処理する値の一覧。
kind

SelectorKind

セレクターの種類。
notIn

string[]

フィルター処理する値の一覧。

SelectorKind

セレクターの種類。

名前 型 説明
policyDefinitionReferenceId

string

ポリシー定義参照 ID でポリシーをフィルター処理するセレクターの種類。
resourceLocation

string

リソースの場所によってポリシーをフィルター処理するセレクターの種類。
resourceType

string

リソースの種類でポリシーをフィルター処理するセレクターの種類。
resourceWithoutLocation

string

場所のないリソースによってポリシーをフィルター処理するセレクターの種類。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

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

string

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

UserAssignedIdentities

ポリシーに関連付けられているユーザー ID。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前 型 説明