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

Deployments - Create Or Update

创建部署。 “.default”和“.unassigned”是系统定义的值,不能用于产品或设备组名称。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}?api-version=2024-04-01

URI 参数

名称 必需 类型 说明
catalogName
path True

string

目录的名称

正则表达式模式: ^[A-Za-z0-9_-]{1,50}$

deploymentName
path True

string

部署名称。 使用 .default 创建部署,并获取关联设备组的当前部署。

deviceGroupName
path True

string

设备组的名称。

正则表达式模式: ^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\s]{1,48}[A-Za-z0-9]$|^\.default$|^\.unassigned$

productName
path True

string

产品名称。

正则表达式模式: ^[\w][\w\s]{1,48}[\w]$|^\.default$|^\.unassigned$

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
properties.deployedImages

Image[]

部署的映像

properties.deploymentId

string

部署 ID

响应

名称 类型 说明
200 OK

Deployment

资源“部署”更新操作成功

201 Created

Deployment

资源“部署”创建操作成功

标头

Retry-After: integer

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Deployments_CreateOrUpdate

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/myDeviceGroup1/deployments/MyDeployment1?api-version=2024-04-01

{}

示例响应

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1",
  "name": "MyDeployment1",
  "properties": {
    "deployedImages": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1",
        "properties": {
          "image": "MyImage",
          "imageId": "00000000-0000-0000-0000-000000000000",
          "uri": "imageUri",
          "regionalDataBoundary": "None",
          "imageType": "InvalidImageType",
          "provisioningState": "Succeeded"
        }
      }
    ],
    "provisioningState": "Succeeded"
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/deployments/MyDeployment1",
  "name": "MyDeployment1",
  "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/deployments"
}

定义

名称 说明
createdByType

创建资源的标识类型。

Deployment

属于设备组资源的部署资源。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Image

属于目录资源的图像资源。

ImageType

图像类型值。

ProvisioningState

资源的预配状态。

RegionalDataBoundary

区域数据边界值。

systemData

与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

Deployment

属于设备组资源的部署资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.deployedImages

Image[]

部署的映像

properties.deploymentDateUtc

string

部署日期 UTC

properties.deploymentId

string

部署 ID

properties.provisioningState

ProvisioningState

最后一个操作的状态。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

Image

属于目录资源的图像资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.componentId

string

映像组件 ID。

properties.description

string

图像说明。

properties.image

string

图像创建时作为 UTF-8 编码的 base 64 字符串。 此字段包含图像读取时的图像 URI。

properties.imageId

string

映像 ID

properties.imageName

string

映像名称

properties.imageType

ImageType

图像类型。

properties.provisioningState

ProvisioningState

最后一个操作的状态。

properties.regionalDataBoundary

RegionalDataBoundary

图像的区域数据边界

properties.uri

string

定位图像

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ImageType

图像类型值。

名称 类型 说明
Applications

string

应用程序映像类型

BaseSystemUpdateManifest

string

基本系统更新清单映像类型

BootManifest

string

启动清单映像类型

CustomerBoardConfig

string

客户板配置映像类型

CustomerUpdateManifest

string

客户更新清单映像类型

FirmwareUpdateManifest

string

固件更新清单映像类型

FwConfig

string

FW 配置映像类型

InvalidImageType

string

映像无效。

ManifestSet

string

清单集映像类型

NormalWorldDtb

string

正常世界 dtb 图像类型

NormalWorldKernel

string

普通世界内核映像类型

NormalWorldLoader

string

普通世界加载程序图像类型

Nwfs

string

Nwfs 映像类型

OneBl

string

一个 Bl 图像类型

Other

string

其他图像类型

PlutonRuntime

string

冥王星图像类型

Policy

string

策略映像类型

RecoveryManifest

string

恢复清单映像类型

RootFs

string

根 FS 映像类型

SecurityMonitor

string

安全监视器映像类型

Services

string

服务映像类型

TrustedKeystore

string

受信任的密钥存储映像类型

UpdateCertStore

string

更新证书存储映像类型

WifiFirmware

string

Wifi 固件映像类型

ProvisioningState

资源的预配状态。

名称 类型 说明
Accepted

string

已接受资源创建请求

Canceled

string

资源创建已取消。

Deleting

string

正在删除资源

Failed

string

资源创建失败。

Provisioning

string

正在预配资源

Succeeded

string

已创建资源。

Updating

string

正在更新资源

RegionalDataBoundary

区域数据边界值。

名称 类型 说明
EU

string

欧盟数据边界

None

string

无数据边界

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。