Microsoft.Blueprint 藍圖Assignments
Bicep 資源定義
blueprintAssignments 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprintAssignments 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview' = {
scope: resourceSymbolicName or scope
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
blueprintId: 'string'
description: 'string'
displayName: 'string'
locks: {
excludedActions: [
'string'
]
excludedPrincipals: [
'string'
]
mode: 'string'
}
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
resourceGroups: {
{customized property}: {
location: 'string'
name: 'string'
}
}
scope: 'string'
}
}
屬性值
AssignmentLockSettings
名字 | 描述 | 價值 |
---|---|---|
excludedActions | 從藍圖鎖定排除的管理作業清單。 最多允許200個動作。 如果鎖定模式設定為 'AllResourcesReadOnly',則下列動作會自動附加至 'excludedActions':'*/read'、'Microsoft.Network/virtualNetworks/subnets/join/action' 和 'Microsoft.Authorization/locks/delete'。 如果鎖定模式設定為 'AllResourcesDoNotDelete',則下列動作會自動附加至 'excludedActions': 'Microsoft.Authorization/locks/delete'。 將會移除重複的動作。 | string[] |
excludedPrincipals | 從藍圖鎖定排除的 AAD 主體清單。 最多允許5個主體。 | string[] |
模式 | 鎖定模式。 | 'AllResourcesDoNotDelete' 'AllResourcesReadOnly' 'None' |
AssignmentProperties
名字 | 描述 | 價值 |
---|---|---|
blueprintId | 藍圖定義的已發佈版本的標識碼。 | 字串 |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
鎖 | 定義藍圖指派所部署的資源鎖定方式。 | AssignmentLockSettings |
參數 | 藍圖指派參數值。 | AssignmentPropertiesParameters (必要) |
resourceGroups | 資源群組佔位元的名稱和位置。 | AssignmentPropertiesResourceGroups (必要) |
範圍 | 藍圖指派的目標訂用帳戶範圍(格式:』/subscriptions/{subscriptionId}')。 針對管理群組層級指派,需要 屬性。 | 字串 |
AssignmentPropertiesParameters
名字 | 描述 | 價值 |
---|
AssignmentPropertiesResourceGroups
名字 | 描述 | 價值 |
---|
KeyVaultReference
名字 | 描述 | 價值 |
---|---|---|
id | Key Vault 的 Azure 資源識別碼。 | 字串 (必要) |
ManagedServiceIdentity
名字 | 描述 | 價值 |
---|---|---|
principalId | 與此身分識別相關聯的 Azure Active Directory 主體標識符。 | 字串 |
tenantId | Azure Active Directory 的標識碼。 | 字串 |
類型 | 受控識別的類型。 | 'None' 'SystemAssigned' 'UserAssigned' (必要) |
userAssignedIdentities | 與資源相關聯的使用者指派受控識別清單。 密鑰是受控識別的 Azure 資源識別碼。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
名字 | 描述 | 價值 |
---|
Microsoft.Blueprint/blueprintAssignments
名字 | 描述 | 價值 |
---|---|---|
身份 | 此藍圖指派的受控識別。 | ManagedServiceIdentity (必要) |
位置 | 此藍圖指派的位置。 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | 藍圖指派對象的屬性。 | AssignmentProperties (必要) |
範圍 | 在與部署範圍不同的範圍內建立資源時,請使用 。 | 將此屬性設定為資源的符號名稱,以套用 擴充資源。 |
ParameterValue
名字 | 描述 | 價值 |
---|---|---|
參考 | 參數值做為參考型別。 | SecretValueReference |
價值 | 參數值。 允許任何有效的 JSON 值,包括對象、數位、字串、數位和布爾值。 | 任何 |
ResourceGroupValue
名字 | 描述 | 價值 |
---|---|---|
位置 | 資源群組的位置。 | 字串 |
名字 | 資源群組的名稱。 | 字串 約束: 最小長度 = 1 最大長度 = 1 |
SecretValueReference
名字 | 描述 | 價值 |
---|---|---|
keyVault | 指定指定 Azure Key Vault 的參考。 | KeyVaultReference (必要) |
secretName | 秘密的名稱。 | 字串 (必要) |
secretVersion | 要使用的秘密版本。 如果保留空白,則會使用最新版本的秘密。 | 字串 |
UserAssignedIdentity
名字 | 描述 | 價值 |
---|---|---|
clientId | 與此身分識別相關聯的用戶端應用程式標識碼。 | 字串 |
principalId | 與此身分識別相關聯的 Azure Active Directory 主體標識符。 | 字串 |
ARM 樣本資源定義
blueprintAssignments 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprintAssignments 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.Blueprint/blueprintAssignments",
"apiVersion": "2018-11-01-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"blueprintId": "string",
"description": "string",
"displayName": "string",
"locks": {
"excludedActions": [ "string" ],
"excludedPrincipals": [ "string" ],
"mode": "string"
},
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"resourceGroups": {
"{customized property}": {
"location": "string",
"name": "string"
}
},
"scope": "string"
}
}
屬性值
AssignmentLockSettings
名字 | 描述 | 價值 |
---|---|---|
excludedActions | 從藍圖鎖定排除的管理作業清單。 最多允許200個動作。 如果鎖定模式設定為 'AllResourcesReadOnly',則下列動作會自動附加至 'excludedActions':'*/read'、'Microsoft.Network/virtualNetworks/subnets/join/action' 和 'Microsoft.Authorization/locks/delete'。 如果鎖定模式設定為 'AllResourcesDoNotDelete',則下列動作會自動附加至 'excludedActions': 'Microsoft.Authorization/locks/delete'。 將會移除重複的動作。 | string[] |
excludedPrincipals | 從藍圖鎖定排除的 AAD 主體清單。 最多允許5個主體。 | string[] |
模式 | 鎖定模式。 | 'AllResourcesDoNotDelete' 'AllResourcesReadOnly' 'None' |
AssignmentProperties
名字 | 描述 | 價值 |
---|---|---|
blueprintId | 藍圖定義的已發佈版本的標識碼。 | 字串 |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
鎖 | 定義藍圖指派所部署的資源鎖定方式。 | AssignmentLockSettings |
參數 | 藍圖指派參數值。 | AssignmentPropertiesParameters (必要) |
resourceGroups | 資源群組佔位元的名稱和位置。 | AssignmentPropertiesResourceGroups (必要) |
範圍 | 藍圖指派的目標訂用帳戶範圍(格式:』/subscriptions/{subscriptionId}')。 針對管理群組層級指派,需要 屬性。 | 字串 |
AssignmentPropertiesParameters
名字 | 描述 | 價值 |
---|
AssignmentPropertiesResourceGroups
名字 | 描述 | 價值 |
---|
KeyVaultReference
名字 | 描述 | 價值 |
---|---|---|
id | Key Vault 的 Azure 資源識別碼。 | 字串 (必要) |
ManagedServiceIdentity
名字 | 描述 | 價值 |
---|---|---|
principalId | 與此身分識別相關聯的 Azure Active Directory 主體標識符。 | 字串 |
tenantId | Azure Active Directory 的標識碼。 | 字串 |
類型 | 受控識別的類型。 | 'None' 'SystemAssigned' 'UserAssigned' (必要) |
userAssignedIdentities | 與資源相關聯的使用者指派受控識別清單。 密鑰是受控識別的 Azure 資源識別碼。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
名字 | 描述 | 價值 |
---|
Microsoft.Blueprint/blueprintAssignments
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2018-11-01-preview' |
身份 | 此藍圖指派的受控識別。 | ManagedServiceIdentity (必要) |
位置 | 此藍圖指派的位置。 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
性能 | 藍圖指派對象的屬性。 | AssignmentProperties (必要) |
類型 | 資源類型 | 'Microsoft.Blueprint/blueprintAssignments' |
ParameterValue
名字 | 描述 | 價值 |
---|---|---|
參考 | 參數值做為參考型別。 | SecretValueReference |
價值 | 參數值。 允許任何有效的 JSON 值,包括對象、數位、字串、數位和布爾值。 | 任何 |
ResourceGroupValue
名字 | 描述 | 價值 |
---|---|---|
位置 | 資源群組的位置。 | 字串 |
名字 | 資源群組的名稱。 | 字串 約束: 最小長度 = 1 最大長度 = 1 |
SecretValueReference
名字 | 描述 | 價值 |
---|---|---|
keyVault | 指定指定 Azure Key Vault 的參考。 | KeyVaultReference (必要) |
secretName | 秘密的名稱。 | 字串 (必要) |
secretVersion | 要使用的秘密版本。 如果保留空白,則會使用最新版本的秘密。 | 字串 |
UserAssignedIdentity
名字 | 描述 | 價值 |
---|---|---|
clientId | 與此身分識別相關聯的用戶端應用程式標識碼。 | 字串 |
principalId | 與此身分識別相關聯的 Azure Active Directory 主體標識符。 | 字串 |
Terraform (AzAPI 提供者) 資源定義
blueprintAssignments 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprintAssignments 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview"
name = "string"
parent_id = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
body = jsonencode({
properties = {
blueprintId = "string"
description = "string"
displayName = "string"
locks = {
excludedActions = [
"string"
]
excludedPrincipals = [
"string"
]
mode = "string"
}
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
resourceGroups = {
{customized property} = {
location = "string"
name = "string"
}
}
scope = "string"
}
})
}
屬性值
AssignmentLockSettings
名字 | 描述 | 價值 |
---|---|---|
excludedActions | 從藍圖鎖定排除的管理作業清單。 最多允許200個動作。 如果鎖定模式設定為 'AllResourcesReadOnly',則下列動作會自動附加至 'excludedActions':'*/read'、'Microsoft.Network/virtualNetworks/subnets/join/action' 和 'Microsoft.Authorization/locks/delete'。 如果鎖定模式設定為 'AllResourcesDoNotDelete',則下列動作會自動附加至 'excludedActions': 'Microsoft.Authorization/locks/delete'。 將會移除重複的動作。 | string[] |
excludedPrincipals | 從藍圖鎖定排除的 AAD 主體清單。 最多允許5個主體。 | string[] |
模式 | 鎖定模式。 | 'AllResourcesDoNotDelete' 'AllResourcesReadOnly' 'None' |
AssignmentProperties
名字 | 描述 | 價值 |
---|---|---|
blueprintId | 藍圖定義的已發佈版本的標識碼。 | 字串 |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
鎖 | 定義藍圖指派所部署的資源鎖定方式。 | AssignmentLockSettings |
參數 | 藍圖指派參數值。 | AssignmentPropertiesParameters (必要) |
resourceGroups | 資源群組佔位元的名稱和位置。 | AssignmentPropertiesResourceGroups (必要) |
範圍 | 藍圖指派的目標訂用帳戶範圍(格式:』/subscriptions/{subscriptionId}')。 針對管理群組層級指派,需要 屬性。 | 字串 |
AssignmentPropertiesParameters
名字 | 描述 | 價值 |
---|
AssignmentPropertiesResourceGroups
名字 | 描述 | 價值 |
---|
KeyVaultReference
名字 | 描述 | 價值 |
---|---|---|
id | Key Vault 的 Azure 資源識別碼。 | 字串 (必要) |
ManagedServiceIdentity
名字 | 描述 | 價值 |
---|---|---|
principalId | 與此身分識別相關聯的 Azure Active Directory 主體標識符。 | 字串 |
tenantId | Azure Active Directory 的標識碼。 | 字串 |
類型 | 受控識別的類型。 | 'None' 'SystemAssigned' 'UserAssigned' (必要) |
userAssignedIdentities | 與資源相關聯的使用者指派受控識別清單。 密鑰是受控識別的 Azure 資源識別碼。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
名字 | 描述 | 價值 |
---|
Microsoft.Blueprint/blueprintAssignments
名字 | 描述 | 價值 |
---|---|---|
身份 | 此藍圖指派的受控識別。 | ManagedServiceIdentity (必要) |
位置 | 此藍圖指派的位置。 | 字串 (必要) |
名字 | 資源名稱 | 字串 (必要) |
parent_id | 要套用此延伸模組資源之資源的標識碼。 | 字串 (必要) |
性能 | 藍圖指派對象的屬性。 | AssignmentProperties (必要) |
類型 | 資源類型 | “Microsoft.Blueprint/blueprintAssignments@2018-11-01-preview” |
ParameterValue
名字 | 描述 | 價值 |
---|---|---|
參考 | 參數值做為參考型別。 | SecretValueReference |
價值 | 參數值。 允許任何有效的 JSON 值,包括對象、數位、字串、數位和布爾值。 | 任何 |
ResourceGroupValue
名字 | 描述 | 價值 |
---|---|---|
位置 | 資源群組的位置。 | 字串 |
名字 | 資源群組的名稱。 | 字串 約束: 最小長度 = 1 最大長度 = 1 |
SecretValueReference
名字 | 描述 | 價值 |
---|---|---|
keyVault | 指定指定 Azure Key Vault 的參考。 | KeyVaultReference (必要) |
secretName | 秘密的名稱。 | 字串 (必要) |
secretVersion | 要使用的秘密版本。 如果保留空白,則會使用最新版本的秘密。 | 字串 |
UserAssignedIdentity
名字 | 描述 | 價值 |
---|---|---|
clientId | 與此身分識別相關聯的用戶端應用程式標識碼。 | 字串 |
principalId | 與此身分識別相關聯的 Azure Active Directory 主體標識符。 | 字串 |