Microsoft.Blueprint blueprintAssignments

Bicep 資源定義

blueprintAssignments 資源類型是 擴充資源,這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在 Bicep 中設定擴充功能資源的範圍

藍圖指派資源類型可以使用目標作業進行部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.Blueprint/blueprintAssignments 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    blueprintId: 'string'
    description: 'string'
    displayName: 'string'
    locks: {
      excludedPrincipals: [
        'string'
      ]
      mode: 'string'
    }
    parameters: {}
    resourceGroups: {}
    scope: 'string'
  }
}

屬性值

blueprintAssignments

名稱 描述
NAME 資源名稱 字串 (必要)

字元限制:90

有效字元:
英數字元、底線和連字號。
location 此藍圖指派的位置。 字串 (必要)
scope 在與部署範圍不同的範圍建立擴充資源時,請使用 。 目標資源

針對 Bicep,請將此屬性設定為資源的符號名稱,以套用 延伸模組資源
身分識別 此藍圖指派的受控識別。 需要 ManagedServiceIdentity ()
properties 藍圖指派物件的屬性。 AssignmentProperties (必要)

ManagedServiceIdentity

名稱 描述
principalId 與此身分識別相關聯的 Azure Active Directory 主體識別碼。 字串
tenantId Azure Active Directory 的識別碼。 字串
type 受控識別的類型。 'None'
'SystemAssigned'
'UserAssigned' (必要)
userAssignedIdentities 與資源相關聯的使用者指派受控識別清單。 金鑰是受控識別的 Azure 資源識別碼。 object

AssignmentProperties

名稱 描述
blueprintId 藍圖定義的已發佈版本識別碼。 字串
description 多行說明此資源。 字串
displayName 單行字串說明此資源。 字串
locks 定義藍圖指派所部署的資源鎖定方式。 AssignmentLockSettings
參數 藍圖指派參數值。 物件 (必要)
resourceGroups 資源群組預留位置的名稱和位置。 物件 (必要)
scope 藍圖指派的目標訂用帳戶範圍 (格式:'/subscriptions/{subscriptionId}') 。 對於管理群組層級指派,需要 屬性。 字串

AssignmentLockSettings

名稱 描述
excludedPrincipals 從藍圖鎖定中排除的 AAD 主體清單。 最多允許 5 個主體。 string[]
mode 鎖定模式。 'AllResourcesDoNotDelete'
'AllResourcesReadOnly'
'None'

ARM 範本資源定義

blueprintAssignments 資源類型是 擴充資源,這表示您可以將它套用至另一個資源。

scope使用此資源上的 屬性來設定此資源的範圍。 請參閱 在 ARM 範本中設定擴充功能資源的範圍

藍圖指派資源類型可以使用目標作業進行部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.Blueprint/blueprintAssignments 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Blueprint/blueprintAssignments",
  "apiVersion": "2018-11-01-preview",
  "name": "string",
  "location": "string",
  "scope": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "blueprintId": "string",
    "description": "string",
    "displayName": "string",
    "locks": {
      "excludedPrincipals": [ "string" ],
      "mode": "string"
    },
    "parameters": {},
    "resourceGroups": {},
    "scope": "string"
  }
}

屬性值

blueprintAssignments

名稱 描述
類型 資源類型 'Microsoft.Blueprint/blueprintAssignments'
apiVersion 資源 API 版本 '2018-11-01-preview'
NAME 資源名稱 字串 (必要)

字元限制:90

有效字元:
英數字元、底線和連字號。
location 此藍圖指派的位置。 字串 (必要)
scope 在與部署範圍不同的範圍建立擴充資源時,請使用 。 目標資源

針對 JSON,請將值設定為要套用 擴充資源 的資源完整名稱。
身分識別 此藍圖指派的受控識別。 需要 ManagedServiceIdentity ()
properties 藍圖指派物件的屬性。 AssignmentProperties (必要)

ManagedServiceIdentity

名稱 描述
principalId 與此身分識別相關聯的 Azure Active Directory 主體識別碼。 字串
tenantId Azure Active Directory 的識別碼。 字串
type 受控識別的類型。 'None'
'SystemAssigned'
'UserAssigned' (必要)
userAssignedIdentities 與資源相關聯的使用者指派受控識別清單。 金鑰是受控識別的 Azure 資源識別碼。 object

AssignmentProperties

名稱 描述
blueprintId 藍圖定義的已發佈版本識別碼。 字串
description 多行說明此資源。 字串
displayName 單行字串說明此資源。 字串
locks 定義藍圖指派所部署的資源鎖定方式。 AssignmentLockSettings
參數 藍圖指派參數值。 物件 (必要)
resourceGroups 資源群組預留位置的名稱和位置。 物件 (必要)
scope 藍圖指派的目標訂用帳戶範圍 (格式:'/subscriptions/{subscriptionId}') 。 對於管理群組層級指派,需要 屬性。 字串

AssignmentLockSettings

名稱 描述
excludedPrincipals 從藍圖鎖定中排除的 AAD 主體清單。 最多允許 5 個主體。 string[]
mode 鎖定模式。 'AllResourcesDoNotDelete'
'AllResourcesReadOnly'
'None'

Terraform (AzAPI 提供者) 資源定義

blueprintAssignments 資源類型是 擴充資源,這表示您可以將它套用至另一個資源。

parent_id使用此資源上的 屬性來設定此資源的範圍。

藍圖指派資源類型可以使用目標作業進行部署:

  • 資源群組
  • 訂用帳戶
  • 管理群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.Blueprint/blueprintAssignments 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      blueprintId = "string"
      description = "string"
      displayName = "string"
      locks = {
        excludedPrincipals = [
          "string"
        ]
        mode = "string"
      }
      parameters = {}
      resourceGroups = {}
      scope = "string"
    }
  })
}

屬性值

blueprintAssignments

名稱 描述
類型 資源類型 「Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview」
NAME 資源名稱 字串 (必要)

字元限制:90

有效字元:
英數字元、底線和連字號。
location 此藍圖指派的位置。 字串 (必要)
parent_id 要套用此延伸模組資源的資源識別碼。 字串 (必要)
身分識別 此藍圖指派的受控識別。 需要 ManagedServiceIdentity ()
properties 藍圖指派物件的屬性。 AssignmentProperties (必要)

ManagedServiceIdentity

名稱 描述
類型 受控識別的類型。 「SystemAssigned」
) 所需的 「UserAssigned」 (
identity_ids 與資源相關聯的使用者指派受控識別清單。 金鑰是受控識別的 Azure 資源識別碼。 使用者身分識別識別碼的陣列。

AssignmentProperties

名稱 描述
blueprintId 藍圖定義的已發佈版本識別碼。 字串
description 多行說明此資源。 字串
displayName 單行字串說明此資源。 字串
locks 定義藍圖指派所部署的資源鎖定方式。 AssignmentLockSettings
參數 藍圖指派參數值。 物件 (必要)
resourceGroups 資源群組預留位置的名稱和位置。 物件 (必要)
scope 藍圖指派的目標訂用帳戶範圍 (格式:'/subscriptions/{subscriptionId}') 。 對於管理群組層級指派,需要 屬性。 字串

AssignmentLockSettings

名稱 描述
excludedPrincipals 從藍圖鎖定中排除的 AAD 主體清單。 最多允許 5 個主體。 string[]
mode 鎖定模式。 「AllResourcesDoNotDelete」
「AllResourcesReadOnly」
"None"