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

Assignments - Create Or Update

创建或更新蓝图分配。

PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}?api-version=2018-11-01-preview

URI 参数

名称 必需 类型 说明
assignmentName
path True

string

蓝图分配的名称。

resourceScope
path True

string

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

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
identity True

ManagedServiceIdentity

此蓝图分配的托管标识。

location True

string

此蓝图分配的位置。

properties.parameters True

<string,  ParameterValue>

蓝图分配参数值。

properties.resourceGroups True

<string,  ResourceGroupValue>

资源组占位符的名称和位置。

properties.blueprintId

string

蓝图定义的已发布版本的 ID。

properties.description

string

maxLength: 500

多行说明此资源。

properties.displayName

string

maxLength: 256

单行字符串解释此资源。

properties.locks

AssignmentLockSettings

定义蓝图分配部署的资源被锁定的方式。

properties.scope

string

蓝图分配的目标订阅范围(格式:“/subscriptions/{subscriptionId}”。 对于管理组级别分配,属性是必需的。

响应

名称 类型 说明
201 Created

Assignment

已创建 - 已保存蓝图分配。

Other Status Codes

CloudError

蓝图错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Assignment with system-assigned managed identity at management group scope
Assignment with system-assigned managed identity at subscription scope
Assignment with user-assigned managed identity at management group scope
Assignment with user-assigned managed identity at subscription scope

Assignment with system-assigned managed identity at management group scope

示例请求

PUT https://management.azure.com/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint?api-version=2018-11-01-preview

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

示例响应

{
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "principalId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with system-assigned managed identity at subscription scope

示例请求

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

示例响应

{
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "principalId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with user-assigned managed identity at management group scope

示例请求

PUT https://management.azure.com/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint?api-version=2018-11-01-preview

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

示例响应

{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

Assignment with user-assigned managed identity at subscription scope

示例请求

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

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  }
}

示例响应

{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
    "parameters": {
      "storageAccountType": {
        "value": "Standard_LRS"
      },
      "costCenter": {
        "value": "Contoso/Online/Shopping/Production"
      },
      "owners": {
        "value": [
          "johnDoe@contoso.com",
          "johnsteam@contoso.com"
        ]
      }
    },
    "resourceGroups": {
      "storageRG": {
        "name": "defaultRG",
        "location": "eastus"
      }
    }
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
  "type": "Microsoft.Blueprint/Assignment",
  "name": "assignSimpleBlueprint"
}

定义

名称 说明
Assignment

表示蓝图分配。

AssignmentLockMode

锁定模式。

AssignmentLockSettings

定义蓝图分配部署的资源被锁定的方式。

AssignmentProvisioningState

蓝图分配的状态。

AssignmentStatus

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

CloudError
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorResponse

错误响应

keyVaultReference

指定 Key Vault 的链接。

ManagedServiceIdentity

托管标识泛型对象。

ManagedServiceIdentityType

托管标识的类型。

ParameterValue

指定参数的值。 可以是“value”或“reference”,但不能同时为两者。

ResourceGroupValue

表示 Azure 资源组。

SecretValueReference

对 Key Vault 机密的引用。

UserAssignedIdentity

用户分配的托管标识。

Assignment

表示蓝图分配。

名称 类型 说明
id

string

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

identity

ManagedServiceIdentity

此蓝图分配的托管标识。

location

string

此蓝图分配的位置。

name

string

此资源的名称。

properties.blueprintId

string

蓝图定义的已发布版本的 ID。

properties.description

string

maxLength: 500

多行说明此资源。

properties.displayName

string

maxLength: 256

单行字符串解释此资源。

properties.locks

AssignmentLockSettings

定义蓝图分配部署的资源被锁定的方式。

properties.parameters

<string,  ParameterValue>

蓝图分配参数值。

properties.provisioningState

AssignmentProvisioningState

蓝图分配的状态。

properties.resourceGroups

<string,  ResourceGroupValue>

资源组占位符的名称和位置。

properties.scope

string

蓝图分配的目标订阅范围(格式:“/subscriptions/{subscriptionId}”。 对于管理组级别分配,属性是必需的。

properties.status

AssignmentStatus

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

type

string

此资源的类型。

AssignmentLockMode

锁定模式。

说明
AllResourcesDoNotDelete
AllResourcesReadOnly
None

AssignmentLockSettings

定义蓝图分配部署的资源被锁定的方式。

名称 类型 说明
excludedActions

string[]

从蓝图锁中排除的管理操作列表。 最多允许 200 个作。 如果锁定模式设置为“AllResourcesReadOnly”,则以下操作会自动追加到“excludedActions”、“Microsoft.Network/virtualNetworks/subnets/join/action”和“Microsoft.Authorization/locks/delete”。 如果锁定模式设置为“AllResourcesDoNotDelete”,则以下操作会自动追加到“excludedActions”:“Microsoft.Authorization/locks/delete”。 将删除重复的操作。

excludedPrincipals

string[]

从蓝图锁中排除的 AAD 主体列表。 最多允许 5 个主体。

mode

AssignmentLockMode

锁定模式。

AssignmentProvisioningState

蓝图分配的状态。

说明
canceled
cancelling
creating
deleting
deploying
failed
locking
succeeded
validating
waiting

AssignmentStatus

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

名称 类型 说明
lastModified

string (date-time)

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

managedResources

string[]

蓝图分配创建的资源列表。

timeCreated

string (date-time)

此蓝图定义的创建时间。

CloudError

名称 类型 说明
error

ErrorResponse

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

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorResponse

错误响应

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorResponse[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

keyVaultReference

指定 Key Vault 的链接。

名称 类型 说明
id

string

Key Vault 的 Azure 资源 ID。

ManagedServiceIdentity

托管标识泛型对象。

名称 类型 说明
principalId

string

与此标识关联的 Azure Active Directory 主体 ID。

tenantId

string

Azure Active Directory 的 ID。

type

ManagedServiceIdentityType

托管标识的类型。

userAssignedIdentities

<string,  UserAssignedIdentity>

与资源关联的用户分配托管标识的列表。 密钥是托管标识的 Azure 资源 ID。

ManagedServiceIdentityType

托管标识的类型。

说明
None
SystemAssigned
UserAssigned

ParameterValue

指定参数的值。 可以是“value”或“reference”,但不能同时为两者。

名称 类型 说明
reference

SecretValueReference

参数值作为引用类型。

value

object

参数值。 允许任何有效的 JSON 值,包括对象、数组、字符串、数字和布尔值。

ResourceGroupValue

表示 Azure 资源组。

名称 类型 说明
location

string

资源组的位置。

name

string

minLength: 1
maxLength: 90

资源组的名称。

SecretValueReference

对 Key Vault 机密的引用。

名称 类型 说明
keyVault

keyVaultReference

指定对给定 Azure Key Vault 的引用。

secretName

string

机密的名称。

secretVersion

string

要使用的机密版本。 如果留空,则使用最新版本的机密。

UserAssignedIdentity

用户分配的托管标识。

名称 类型 说明
clientId

string

与此标识关联的客户端应用 ID。

principalId

string

与此标识关联的 Azure Active Directory 主体 ID。