Microsoft.Authorization policyAssignments

[アーティクル]
04/03/2023

Bicep リソース定義

policyAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。

このリソースのスコープを scope 設定するには、このリソースのプロパティを使用します。「Bicep で拡張機能リソースのスコープを設定する」を参照してください。

policyAssignments リソースの有効なデプロイスコープは次のとおりです。

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください
サブスクリプション - サブスクリプションのデプロイコマンドに関するページを参照してください
管理グループ - 管理グループの展開コマンドに関するページを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.Authorization/policyAssignments リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Authorization/policyAssignments@2022-06-01' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    description: 'string'
    displayName: 'string'
    enforcementMode: 'string'
    metadata: any()
    nonComplianceMessages: [
      {
        message: 'string'
        policyDefinitionReferenceId: 'string'
      }
    ]
    notScopes: [
      'string'
    ]
    overrides: [
      {
        kind: 'policyEffect'
        selectors: [
          {
            in: [
              'string'
            ]
            kind: 'string'
            notIn: [
              'string'
            ]
          }
        ]
        value: 'string'
      }
    ]
    parameters: {}
    policyDefinitionId: 'string'
    resourceSelectors: [
      {
        name: 'string'
        selectors: [
          {
            in: [
              'string'
            ]
            kind: 'string'
            notIn: [
              'string'
            ]
          }
        ]
      }
    ]
  }
}

プロパティ値

policyAssignments

名前	説明	値
name	リソース名	string (必須) 文字制限: 1 から 128 の表示名 1-64 リソース名 1-24 管理グループのスコープのリソース名有効な文字: 表示名には任意の文字を含めることができます。次のリソース名は使用できません: `<>*%&:\?.+/` または制御文字。末尾をピリオドまたはスペースにすることはできません。
location	ポリシー割り当ての場所。マネージド ID を使用する場合にのみ必要です。	string
scope	デプロイスコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。	ターゲットリソース Bicep の場合は、このプロパティをリソースのシンボリック名に設定して、拡張機能リソースを適用します。
identity	ポリシーの割り当てに関連付けられているマネージド ID。	ID
properties	ポリシー割り当てのプロパティ。	PolicyAssignmentProperties

ID

名前	説明	値
type	ID の種類。これは、システムまたはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。	'None' 'SystemAssigned' 'UserAssigned'
userAssignedIdentities	ポリシーに関連付けられているユーザー ID。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。	object

PolicyAssignmentProperties

名前	説明	値
description	このメッセージは、ポリシー違反が発生した場合の応答の一部になります。	string
displayName	ポリシー割り当ての表示名。	string
enforcementMode	ポリシー割り当て適用モード。使用できる値は Default と DoNotEnforce です。	'Default' 'DoNotEnforce'
metadata	ポリシー割り当てメタデータ。メタデータはオープンエンドオブジェクトであり、通常はキー値ペアのコレクションです。	Bicep の場合は、 any() 関数を使用できます。
nonComplianceMessages	リソースがポリシーに準拠していない理由を示すメッセージ。	NonComplianceMessage[]
notScopes	ポリシーの除外されたスコープ。	string[]
上書き	ポリシープロパティ値のオーバーライド。	Override[]
parameters	割り当てられたポリシールールのパラメーター値。キーはパラメーター名です。	object
policyDefinitionId	割り当てられているポリシー定義またはポリシーセット定義の ID。	string
resourceSelectors	リソースのプロパティでポリシーをフィルター処理するリソースセレクターの一覧。	ResourceSelector[]

NonComplianceMessage

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

オーバーライド

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

セレクター

名前	説明	値
in	フィルター処理する値の一覧。	string[]
kind	セレクターの種類。	'policyDefinitionReferenceId' 'resourceLocation' 'resourceType' 'resourceWithoutLocation'
notIn	フィルター処理する値の一覧。	string[]

ResourceSelector

名前	説明	値
name	リソースセレクターの名前。	string
selectors	セレクター式の一覧。	Selector[]

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
ポリシー定義を展開して管理グループに割り当てる	このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループレベルのテンプレートです。現時点では、このテンプレートは Azure Portal を使用してデプロイできません。
ポリシーの遅延を展開し、複数の Mgmt グループに割り当てる	このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループレベルのテンプレートです。
組み込みのポリシーを既存のリソースグループに割り当てる	このテンプレートは、組み込みのポリシーを既存のリソースグループに割り当てます。
Azure Virtual Network Manager とサンプル VNET を作成する	このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソースグループにデプロイします。複数の接続トポロジとネットワークグループメンバーシップの種類がサポートされています。

ARM テンプレートリソース定義

policyAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。

このリソースのプロパティを scope 使用して、このリソースのスコープを設定します。「ARM テンプレートで拡張機能リソースのスコープを設定する」を参照してください。

policyAssignments リソースの有効なデプロイスコープは次のとおりです。

リソースグループ - リソースグループのデプロイコマンドを参照してください
サブスクリプション - サブスクリプションのデプロイコマンドに関するページを参照してください
管理グループ - 管理グループの展開コマンドに関するページを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.Authorization/policyAssignments リソースを作成するには、テンプレートに次の JSON を追加します。

{
  "type": "Microsoft.Authorization/policyAssignments",
  "apiVersion": "2022-06-01",
  "name": "string",
  "location": "string",
  "scope": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "description": "string",
    "displayName": "string",
    "enforcementMode": "string",
    "metadata": {},
    "nonComplianceMessages": [
      {
        "message": "string",
        "policyDefinitionReferenceId": "string"
      }
    ],
    "notScopes": [ "string" ],
    "overrides": [
      {
        "kind": "policyEffect",
        "selectors": [
          {
            "in": [ "string" ],
            "kind": "string",
            "notIn": [ "string" ]
          }
        ],
        "value": "string"
      }
    ],
    "parameters": {},
    "policyDefinitionId": "string",
    "resourceSelectors": [
      {
        "name": "string",
        "selectors": [
          {
            "in": [ "string" ],
            "kind": "string",
            "notIn": [ "string" ]
          }
        ]
      }
    ]
  }
}

プロパティ値

policyAssignments

名前	説明	値
type	リソースの種類	'Microsoft.Authorization/policyAssignments'
apiVersion	リソース API のバージョン	'2022-06-01'
name	リソース名	string (必須) 文字制限: 1 から 128 表示名 1-64 リソース名 1-24 管理グループのスコープのリソース名有効な文字: 表示名には任意の文字を含めることができます。次のリソース名は使用できません: `<>*%&:\?.+/` または制御文字。末尾をピリオドまたはスペースにすることはできません。
location	ポリシー割り当ての場所。マネージド ID を使用する場合にのみ必要です。	string
scope	デプロイスコープとは異なるスコープで拡張機能リソースを作成する場合に使用します。	ターゲットリソース JSON の場合は、拡張リソースを適用するリソースの完全な名前に値を設定します。
identity	ポリシー割り当てに関連付けられているマネージド ID。	ID
properties	ポリシー割り当てのプロパティ。	PolicyAssignmentProperties

ID

名前	説明	値
type	ID の種類。これは、システムまたはユーザー割り当て ID をリソースに追加する場合に必要な唯一のフィールドです。	'None' 'SystemAssigned' 'UserAssigned'
userAssignedIdentities	ポリシーに関連付けられているユーザー ID。ユーザー ID ディクショナリキー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。	object

PolicyAssignmentProperties

名前	説明	値
description	このメッセージは、ポリシー違反の場合の応答の一部になります。	string
displayName	ポリシー割り当ての表示名。	string
enforcementMode	ポリシー割り当て適用モード。使用できる値は Default と DoNotEnforce です。	'Default' 'DoNotEnforce'
metadata	ポリシー割り当てメタデータ。メタデータはオープンエンドオブジェクトであり、通常はキー値ペアのコレクションです。
nonComplianceMessages	リソースがポリシーに準拠していない理由を示すメッセージ。	NonComplianceMessage[]
notScopes	ポリシーの除外されたスコープ。	string[]
上書き	ポリシープロパティの値のオーバーライド。	Override[]
parameters	割り当てられたポリシー規則のパラメーター値。キーはパラメーター名です。	object
policyDefinitionId	割り当てられているポリシー定義またはポリシーセット定義の ID。	string
resourceSelectors	リソースのプロパティでポリシーをフィルター処理するリソースセレクターの一覧。	ResourceSelector[]

NonComplianceMessage

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

オーバーライド

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

セレクター

名前	説明	値
in	フィルター処理する値の一覧。	string[]
kind	セレクターの種類。	'policyDefinitionReferenceId' 'resourceLocation' 'resourceType' 'resourceWithoutLocation'
notIn	除外する値の一覧。	string[]

ResourceSelector

名前	説明	値
name	リソースセレクターの名前。	string
selectors	セレクター式の一覧。	Selector[]

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
ポリシー定義を展開し、管理グループに割り当てる	このテンプレートは、ポリシー定義を作成し、そのポリシーをターゲット管理グループに割り当てる管理グループレベルのテンプレートです。現時点では、このテンプレートは Azure Portal を使用してデプロイすることはできません。
ポリシー Def を展開し、複数の Mgmt グループに割り当てる	このテンプレートは、ポリシー定義を作成し、そのポリシーを複数の管理グループに割り当てる管理グループレベルのテンプレートです。
組み込みポリシーを既存のリソースグループに割り当てる	このテンプレートは、組み込みのポリシーを既存のリソースグループに割り当てます。
Azure Virtual Network Manager とサンプル VNET を作成する	このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソースグループにデプロイします。複数の接続トポロジとネットワークグループメンバーシップの種類がサポートされています。

Terraform (AzAPI プロバイダー) リソース定義

policyAssignments リソースの種類は 拡張機能リソースであり、別のリソースに適用できることを意味します。

このリソースのスコープを parent_id 設定するには、このリソースのプロパティを使用します。

policyAssignments リソースの有効なデプロイスコープは次のとおりです。

リソースグループ
サブスクリプション
管理グループ

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.Authorization/policyAssignments リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Authorization/policyAssignments@2022-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      enforcementMode = "string"
      nonComplianceMessages = [
        {
          message = "string"
          policyDefinitionReferenceId = "string"
        }
      ]
      notScopes = [
        "string"
      ]
      overrides = [
        {
          kind = "policyEffect"
          selectors = [
            {
              in = [
                "string"
              ]
              kind = "string"
              notIn = [
                "string"
              ]
            }
          ]
          value = "string"
        }
      ]
      parameters = {}
      policyDefinitionId = "string"
      resourceSelectors = [
        {
          name = "string"
          selectors = [
            {
              in = [
                "string"
              ]
              kind = "string"
              notIn = [
                "string"
              ]
            }
          ]
        }
      ]
    }
  })
}

プロパティ値

policyAssignments

名前	説明	値
type	リソースの種類	"Microsoft.Authorization/policyAssignments@2022-06-01"
name	リソース名	string (必須) 文字制限: 1 から 128 の表示名 1-64 リソース名 1-24 管理グループのスコープのリソース名有効な文字: 表示名には任意の文字を含めることができます。次のリソース名は使用できません: `<>*%&:\?.+/` または制御文字。末尾をピリオドまたはスペースにすることはできません。
location	ポリシー割り当ての場所。マネージド ID を使用する場合にのみ必要です。	string
parent_id	この拡張機能リソースを適用するリソースの ID。	string (必須)
identity	ポリシーの割り当てに関連付けられているマネージド ID。	ID
properties	ポリシー割り当てのプロパティ。	PolicyAssignmentProperties

ID

名前	説明	値
type	ID の種類。これは、システムまたはユーザー割り当て ID をリソースに追加するときに必要な唯一のフィールドです。	"SystemAssigned" "UserAssigned"
identity_ids	ポリシーに関連付けられているユーザー ID。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。	ユーザー ID ID の配列。

PolicyAssignmentProperties

名前	説明	値
description	このメッセージは、ポリシー違反が発生した場合の応答の一部になります。	string
displayName	ポリシー割り当ての表示名。	string
enforcementMode	ポリシー割り当て適用モード。使用できる値は Default と DoNotEnforce です。	"Default" "DoNotEnforce"
metadata	ポリシー割り当てメタデータ。メタデータはオープンエンドオブジェクトであり、通常はキー値ペアのコレクションです。
nonComplianceMessages	リソースがポリシーに準拠していない理由を示すメッセージ。	NonComplianceMessage[]
notScopes	ポリシーの除外されたスコープ。	string[]
上書き	ポリシープロパティの値のオーバーライド。	Override[]
parameters	割り当てられたポリシー規則のパラメーター値。キーはパラメーター名です。	object
policyDefinitionId	割り当てられているポリシー定義またはポリシーセット定義の ID。	string
resourceSelectors	リソースのプロパティでポリシーをフィルター処理するリソースセレクターの一覧。	ResourceSelector[]

NonComplianceMessage

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

オーバーライド

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

セレクター

名前	説明	値
in	フィルター処理する値の一覧。	string[]
kind	セレクターの種類。	"policyDefinitionReferenceId" "resourceLocation" "resourceType" "resourceWithoutLocation"
notIn	フィルター処理する値の一覧。	string[]

ResourceSelector

名前	説明	値
name	リソースセレクターの名前。	string
selectors	セレクター式の一覧。	Selector[]

Microsoft.Authorization policyAssignments

Bicep リソース定義

リソース形式

プロパティ値

policyAssignments

ID

PolicyAssignmentProperties

NonComplianceMessage

オーバーライド

セレクター

ResourceSelector

クイックスタートテンプレート

ARM テンプレートリソース定義

リソース形式

プロパティ値

policyAssignments

ID

PolicyAssignmentProperties

NonComplianceMessage

オーバーライド

セレクター

ResourceSelector

クイックスタートテンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

policyAssignments

ID

PolicyAssignmentProperties

NonComplianceMessage

オーバーライド

セレクター

ResourceSelector

フィードバック

フィードバック

その他のリソース

Microsoft.Authorization policyAssignments

Bicep リソース定義

リソース形式

プロパティ値

policyAssignments

ID

PolicyAssignmentProperties

NonComplianceMessage

オーバーライド

セレクター

ResourceSelector

クイック スタート テンプレート

ARM テンプレート リソース定義

リソース形式

プロパティ値

policyAssignments

ID

PolicyAssignmentProperties

NonComplianceMessage

オーバーライド

セレクター

ResourceSelector

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

policyAssignments

ID

PolicyAssignmentProperties

NonComplianceMessage

オーバーライド

セレクター

ResourceSelector

フィードバック

フィードバック

その他のリソース

クイックスタートテンプレート

ARM テンプレートリソース定義

クイックスタートテンプレート