Microsoft.Blueprint 藍圖/成品
Bicep 資源定義
藍圖/成品資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprints/artifacts 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview' = {
name: 'string'
kind: 'string'
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/blueprints/artifacts 物件
設定 種類 屬性,以指定對象的類型。
針對 policyAssignment,請使用:
{
kind: 'policyAssignment'
properties: {
dependsOn: [
'string'
]
description: 'string'
displayName: 'string'
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
policyDefinitionId: 'string'
resourceGroup: 'string'
}
}
針對 roleAssignment,請使用:
{
kind: 'roleAssignment'
properties: {
dependsOn: [
'string'
]
description: 'string'
displayName: 'string'
principalIds: any(Azure.Bicep.Types.Concrete.AnyType)
resourceGroup: 'string'
roleDefinitionId: 'string'
}
}
針對 範本,請使用:
{
kind: 'template'
properties: {
dependsOn: [
'string'
]
description: 'string'
displayName: 'string'
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
resourceGroup: 'string'
template: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
屬性值
KeyVaultReference
名字 | 描述 | 價值 |
---|---|---|
id | Key Vault 的 Azure 資源識別碼。 | 字串 (必要) |
Microsoft.Blueprint/blueprints/artifacts
名字 | 描述 | 價值 |
---|---|---|
類 | 將 設定為類型為 'policyAssignment',PolicyAssignmentArtifact。 針對 roleAssignmentArtifact 類型設定為 'roleAssignment',。 針對 type TemplateArtifact設定為 'template'。 | 'policyAssignment' 'roleAssignment' 'template' (必要) |
名字 | 資源名稱 | 字串 (必要) |
父母 | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型的資源符號名稱:藍圖 |
ParameterValue
名字 | 描述 | 價值 |
---|---|---|
參考 | 參數值做為參考型別。 | SecretValueReference |
價值 | 參數值。 允許任何有效的 JSON 值,包括對象、數位、字串、數位和布爾值。 | 任何 |
PolicyAssignmentArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'policyAssignment' (必要) |
性能 | policyAssignment Artifact 的屬性 | PolicyAssignmentArtifactProperties (必要) |
PolicyAssignmentArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
參數 | 原則定義的參數值。 | PolicyAssignmentArtifactPropertiesParameters (必要) |
policyDefinitionId | 原則定義的 Azure 資源識別碼。 | 字串 (必要) |
resourceGroup | 將指派原則的資源群組佔位元名稱。 | 字串 |
PolicyAssignmentArtifactPropertiesParameters
名字 | 描述 | 價值 |
---|
RoleAssignmentArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'roleAssignment' (必要) |
性能 | 角色指派藍圖成品的屬性。 | RoleAssignmentArtifactProperties (必要) |
RoleAssignmentArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
principalIds | Azure Active Directory 中的使用者或群組身分識別陣列。 roleDefinition 會套用至每個身分識別。 | 任何 (必要) |
resourceGroup | RoleAssignment 的範圍將會是這個 resourceGroup。 如果空白,它會限定為訂用帳戶。 | 字串 |
roleDefinitionId | RoleDefinition 的 Azure 資源識別碼。 | 字串 (必要) |
SecretValueReference
名字 | 描述 | 價值 |
---|---|---|
keyVault | 指定指定 Azure Key Vault 的參考。 | KeyVaultReference (必要) |
secretName | 秘密的名稱。 | 字串 (必要) |
secretVersion | 要使用的秘密版本。 如果保留空白,則會使用最新版本的秘密。 | 字串 |
TemplateArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'template' (必要) |
性能 | Resource Manager 樣本藍圖成品的屬性。 | TemplateArtifactProperties (必要) |
TemplateArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
參數 | Resource Manager 樣本藍圖成品參數值。 | TemplateArtifactPropertiesParameters (必要) |
resourceGroup | 如果適用,將會部署 Resource Manager 範本藍圖成品的資源群組佔位元元名稱。 | 字串 |
範本 | Resource Manager 樣本藍圖成品主體。 | 任何 (必要) |
TemplateArtifactPropertiesParameters
名字 | 描述 | 價值 |
---|
ARM 樣本資源定義
藍圖/成品資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprints/artifacts 資源,請將下列 JSON 新增至範本。
{
"name": "string",
"kind": "string"
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/blueprints/artifacts 物件
設定 種類 屬性,以指定對象的類型。
針對 policyAssignment,請使用:
{
"kind": "policyAssignment",
"properties": {
"dependsOn": [ "string" ],
"description": "string",
"displayName": "string",
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"policyDefinitionId": "string",
"resourceGroup": "string"
}
}
針對 roleAssignment,請使用:
{
"kind": "roleAssignment",
"properties": {
"dependsOn": [ "string" ],
"description": "string",
"displayName": "string",
"principalIds": {},
"resourceGroup": "string",
"roleDefinitionId": "string"
}
}
針對 範本,請使用:
{
"kind": "template",
"properties": {
"dependsOn": [ "string" ],
"description": "string",
"displayName": "string",
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"resourceGroup": "string",
"template": {}
}
}
屬性值
KeyVaultReference
名字 | 描述 | 價值 |
---|---|---|
id | Key Vault 的 Azure 資源識別碼。 | 字串 (必要) |
Microsoft.Blueprint/blueprints/artifacts
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2018-11-01-preview' |
類 | 將 設定為類型為 'policyAssignment',PolicyAssignmentArtifact。 針對 roleAssignmentArtifact 類型設定為 'roleAssignment',。 針對 type TemplateArtifact設定為 'template'。 | 'policyAssignment' 'roleAssignment' 'template' (必要) |
名字 | 資源名稱 | 字串 (必要) |
類型 | 資源類型 | 'Microsoft.Blueprint/blueprints/artifacts' |
ParameterValue
名字 | 描述 | 價值 |
---|---|---|
參考 | 參數值做為參考型別。 | SecretValueReference |
價值 | 參數值。 允許任何有效的 JSON 值,包括對象、數位、字串、數位和布爾值。 | 任何 |
PolicyAssignmentArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'policyAssignment' (必要) |
性能 | policyAssignment Artifact 的屬性 | PolicyAssignmentArtifactProperties (必要) |
PolicyAssignmentArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
參數 | 原則定義的參數值。 | PolicyAssignmentArtifactPropertiesParameters (必要) |
policyDefinitionId | 原則定義的 Azure 資源識別碼。 | 字串 (必要) |
resourceGroup | 將指派原則的資源群組佔位元名稱。 | 字串 |
PolicyAssignmentArtifactPropertiesParameters
名字 | 描述 | 價值 |
---|
RoleAssignmentArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'roleAssignment' (必要) |
性能 | 角色指派藍圖成品的屬性。 | RoleAssignmentArtifactProperties (必要) |
RoleAssignmentArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
principalIds | Azure Active Directory 中的使用者或群組身分識別陣列。 roleDefinition 會套用至每個身分識別。 | 任何 (必要) |
resourceGroup | RoleAssignment 的範圍將會是這個 resourceGroup。 如果空白,它會限定為訂用帳戶。 | 字串 |
roleDefinitionId | RoleDefinition 的 Azure 資源識別碼。 | 字串 (必要) |
SecretValueReference
名字 | 描述 | 價值 |
---|---|---|
keyVault | 指定指定 Azure Key Vault 的參考。 | KeyVaultReference (必要) |
secretName | 秘密的名稱。 | 字串 (必要) |
secretVersion | 要使用的秘密版本。 如果保留空白,則會使用最新版本的秘密。 | 字串 |
TemplateArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'template' (必要) |
性能 | Resource Manager 樣本藍圖成品的屬性。 | TemplateArtifactProperties (必要) |
TemplateArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
參數 | Resource Manager 樣本藍圖成品參數值。 | TemplateArtifactPropertiesParameters (必要) |
resourceGroup | 如果適用,將會部署 Resource Manager 範本藍圖成品的資源群組佔位元元名稱。 | 字串 |
範本 | Resource Manager 樣本藍圖成品主體。 | 任何 (必要) |
TemplateArtifactPropertiesParameters
名字 | 描述 | 價值 |
---|
快速入門範本
下列快速入門範本會部署此資源類型。
範本 | 描述 |
---|---|
藍圖 - 建立新的藍圖定義 |
此範本會建立 Azure 藍圖藍圖定義。 藍圖定義包含原則指派成品,可以修改,然後部署到管理群組或訂用帳戶,以取得一致的環境。 |
Terraform (AzAPI 提供者) 資源定義
藍圖/成品資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprints/artifacts 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
name = "string"
kind = "string"
// For remaining properties, see Microsoft.Blueprint/blueprints/artifacts objects
}
Microsoft.Blueprint/blueprints/artifacts 物件
設定 種類 屬性,以指定對象的類型。
針對 policyAssignment,請使用:
{
kind = "policyAssignment"
properties = {
dependsOn = [
"string"
]
description = "string"
displayName = "string"
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
policyDefinitionId = "string"
resourceGroup = "string"
}
}
針對 roleAssignment,請使用:
{
kind = "roleAssignment"
properties = {
dependsOn = [
"string"
]
description = "string"
displayName = "string"
principalIds = ?
resourceGroup = "string"
roleDefinitionId = "string"
}
}
針對 範本,請使用:
{
kind = "template"
properties = {
dependsOn = [
"string"
]
description = "string"
displayName = "string"
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
resourceGroup = "string"
template = ?
}
}
屬性值
KeyVaultReference
名字 | 描述 | 價值 |
---|---|---|
id | Key Vault 的 Azure 資源識別碼。 | 字串 (必要) |
Microsoft.Blueprint/blueprints/artifacts
名字 | 描述 | 價值 |
---|---|---|
類 | 將 設定為類型為 'policyAssignment',PolicyAssignmentArtifact。 針對 roleAssignmentArtifact 類型設定為 'roleAssignment',。 針對 type TemplateArtifact設定為 'template'。 | 'policyAssignment' 'roleAssignment' 'template' (必要) |
名字 | 資源名稱 | 字串 (必要) |
parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼:藍圖 |
類型 | 資源類型 | “Microsoft.Blueprint/blueprints/artifacts@2018-11-01-preview” |
ParameterValue
名字 | 描述 | 價值 |
---|---|---|
參考 | 參數值做為參考型別。 | SecretValueReference |
價值 | 參數值。 允許任何有效的 JSON 值,包括對象、數位、字串、數位和布爾值。 | 任何 |
PolicyAssignmentArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'policyAssignment' (必要) |
性能 | policyAssignment Artifact 的屬性 | PolicyAssignmentArtifactProperties (必要) |
PolicyAssignmentArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
參數 | 原則定義的參數值。 | PolicyAssignmentArtifactPropertiesParameters (必要) |
policyDefinitionId | 原則定義的 Azure 資源識別碼。 | 字串 (必要) |
resourceGroup | 將指派原則的資源群組佔位元名稱。 | 字串 |
PolicyAssignmentArtifactPropertiesParameters
名字 | 描述 | 價值 |
---|
RoleAssignmentArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'roleAssignment' (必要) |
性能 | 角色指派藍圖成品的屬性。 | RoleAssignmentArtifactProperties (必要) |
RoleAssignmentArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
principalIds | Azure Active Directory 中的使用者或群組身分識別陣列。 roleDefinition 會套用至每個身分識別。 | 任何 (必要) |
resourceGroup | RoleAssignment 的範圍將會是這個 resourceGroup。 如果空白,它會限定為訂用帳戶。 | 字串 |
roleDefinitionId | RoleDefinition 的 Azure 資源識別碼。 | 字串 (必要) |
SecretValueReference
名字 | 描述 | 價值 |
---|---|---|
keyVault | 指定指定 Azure Key Vault 的參考。 | KeyVaultReference (必要) |
secretName | 秘密的名稱。 | 字串 (必要) |
secretVersion | 要使用的秘密版本。 如果保留空白,則會使用最新版本的秘密。 | 字串 |
TemplateArtifact
名字 | 描述 | 價值 |
---|---|---|
類 | 指定藍圖成品的種類。 | 'template' (必要) |
性能 | Resource Manager 樣本藍圖成品的屬性。 | TemplateArtifactProperties (必要) |
TemplateArtifactProperties
名字 | 描述 | 價值 |
---|---|---|
dependsOn | 必須在指定成品之前部署的成品。 | string[] |
描述 | 多行說明此資源。 | 字串 約束: 最大長度 = |
displayName | 單行字串說明此資源。 | 字串 約束: 最大長度 = |
參數 | Resource Manager 樣本藍圖成品參數值。 | TemplateArtifactPropertiesParameters (必要) |
resourceGroup | 如果適用,將會部署 Resource Manager 範本藍圖成品的資源群組佔位元元名稱。 | 字串 |
範本 | Resource Manager 樣本藍圖成品主體。 | 任何 (必要) |
TemplateArtifactPropertiesParameters
名字 | 描述 | 價值 |
---|