你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Published Blueprints - Create

使用最新项目发布新版本的蓝图定义。 已发布的蓝图定义是不可变的。

PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}?api-version=2018-11-01-preview

URI 参数

Name In Required Type Description
blueprintName
path True
  • string

蓝图定义的名称。

resourceScope
path True
  • string

资源的范围。 有效范围包括:管理组 (格式:“/providers/Microsoft.Management/managementGroups/{managementGroup}”) 、订阅 (格式:“/subscriptions/{subscriptionId}”) 。

versionId
path True
  • string

已发布的蓝图定义版本。

api-version
query True
  • string

客户端 API 版本。

请求正文

Name Type Description
description
  • string

多行说明此资源。

displayName
  • string

单行字符串解释此资源。

properties.blueprintName
  • string

已发布的蓝图定义的名称。

properties.changeNotes
  • string

特定于版本的更改说明。

properties.parameters

此蓝图定义所需的参数。

properties.resourceGroups

此蓝图定义定义的资源组占位符。

properties.targetScope

可以分配此蓝图定义的范围。

响应

Name Type Description
201 Created

已创建 -- 已发布蓝图定义。

Other Status Codes

蓝图错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

PublishedManagementGroupBlueprint_Publish
PublishedSubscriptionBlueprint_Publish

PublishedManagementGroupBlueprint_Publish

Sample Request

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/v2?api-version=2018-11-01-preview

Sample Response

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "blueprintName": "simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type.",
          "description": null
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription.",
          "description": null
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment.",
          "description": null
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  },
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints/versions",
  "name": "v2"
}

PublishedSubscriptionBlueprint_Publish

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/v2?api-version=2018-11-01-preview

Sample Response

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "blueprintName": "simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type.",
          "description": null
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription.",
          "description": null
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment.",
          "description": null
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints/versions",
  "name": "v2"
}

定义

BlueprintStatus

蓝图的状态。 此字段是只读的。

BlueprintTargetScope

可以分配此蓝图定义的范围。

CloudError
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorResponse

错误响应

ParameterDefinition

表示具有约束和元数据的参数。

PublishedBlueprint

表示已发布的蓝图。

ResourceGroupDefinition

表示蓝图定义中的 Azure 资源组。

TemplateParameterType

资源管理器模板参数允许的数据类型。

BlueprintStatus

蓝图的状态。 此字段是只读的。

Name Type Description
lastModified
  • string

此蓝图定义的上次修改时间。

timeCreated
  • string

此蓝图定义的创建时间。

BlueprintTargetScope

可以分配此蓝图定义的范围。

Name Type Description
managementGroup
  • string

蓝图在蓝图分配期间面向管理组。 这是保留供将来使用。

subscription
  • string

蓝图在蓝图分配期间面向订阅。

CloudError

Name Type Description
error

错误响应
所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorResponse

错误响应

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ParameterDefinition

表示具有约束和元数据的参数。

Name Type Description
allowedValues
  • AllowedValues[]

此参数允许的值数组。

defaultValue

此参数的默认值。

metadata.description
  • string

此参数/resourceGroup 的说明。

metadata.displayName
  • string

此参数/resourceGroup 的 DisplayName。

metadata.strongType
  • string

用于 UI 的 StrongType 在蓝图分配期间呈现丰富的体验。 支持的强类型是 resourceType、principalId 和 location。

type

资源管理器模板参数允许的数据类型。

PublishedBlueprint

表示已发布的蓝图。

Name Type Description
description
  • string

多行说明此资源。

displayName
  • string

单行字符串解释此资源。

id
  • string

用于在 Azure 上查找任何资源的字符串 ID。

name
  • string

此资源的名称。

properties.blueprintName
  • string

已发布的蓝图定义的名称。

properties.changeNotes
  • string

特定于版本的更改说明。

properties.parameters

此蓝图定义所需的参数。

properties.resourceGroups

此蓝图定义定义的资源组占位符。

properties.status

蓝图的状态。 此字段是只读的。

properties.targetScope

可以分配此蓝图定义的范围。

type
  • string

此资源的类型。

ResourceGroupDefinition

表示蓝图定义中的 Azure 资源组。

Name Type Description
dependsOn
  • string[]

需要在此资源组之前部署的Artifacts。

location
  • string

此 resourceGroup 的位置。 如果在蓝图分配期间指定资源组位置,请留空。

metadata.description
  • string

此参数/resourceGroup 的说明。

metadata.displayName
  • string

此参数/resourceGroup 的 DisplayName。

metadata.strongType
  • string

用于 UI 的 StrongType 在蓝图分配期间呈现丰富的体验。 支持的强类型是 resourceType、principalId 和 location。

name
  • string

此 resourceGroup 的名称。 如果在蓝图分配期间指定资源组名称,请留空。

tags
  • object

要分配给此资源组的标记。

TemplateParameterType

资源管理器模板参数允许的数据类型。

Name Type Description
array
  • string
bool
  • string
int
  • string
object
  • string
secureObject
  • string
secureString
  • string
string
  • string