Deployments - Create Or Update Deployment

服务:

Device Update

API 版本:

2020-09-01

创建或更新部署。

PUT https://{accountEndpoint}/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}

URI 参数

名称	在	必需	类型	说明
accountEndpoint	path	True	string	帐户终结点。
deploymentId	path	True	string	部署标识符。
instanceId	path	True	string	帐户实例标识符。

请求正文

名称	必需	类型	说明
deploymentId	True	string	获取或设置部署标识符。
deploymentType	True	DeploymentType	获取或设置部署类型。
deviceGroupDefinition	True	string[]	获取或设置设备组定义。
deviceGroupType	True	DeviceGroupType	获取或设置设备组类型。
startDateTime	True	string (date-time)	获取或设置部署开始日期时间。
updateId	True	UpdateId	更新标识。
deviceClassId		string	获取或设置设备类标识符。
isCanceled		boolean	指示部署是否已取消的布尔标志。
isCompleted		boolean	指示部署是否已完成的布尔标志。
isRetried		boolean	指示是否已重试部署的布尔标志。

响应

名称	类型	说明
200 OK	Deployment	部署属性。
404 Not Found		找不到。

安全性

azure_auth_implicit

Azure Active Directory OAuth2 隐式流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

azure_auth_code

Azure Active Directory OAuth2 AccessCode 流

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

作用域

名称	说明
user_impersonation	模拟用户帐户

azure_auth_application

Azure Active Directory OAuth2 应用程序流

类型: oauth2
流向: application
令牌 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

作用域

名称	说明
.default	客户端凭据范围

azure_auth_password

Azure Active Directory OAuth2 密码流

类型: oauth2
流向: password
令牌 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Deployments_CreateOrUpdateDeployment

示例请求

HTTP

PUT https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/management/deployments/deploymentId

{
  "deploymentId": "deploymentId",
  "deploymentType": "Complete",
  "deviceClassId": "31ee8c56559847429fbe86e3e87f99b6",
  "startDateTime": "2020-04-22T12:12:12.0000000+00:00",
  "deviceGroupType": "Devices",
  "deviceGroupDefinition": [
    "device1",
    "device2"
  ],
  "updateId": {
    "provider": "provider",
    "name": "name",
    "version": "1.2.3.4"
  }
}

示例响应

状态代码:

200

{
  "deploymentId": "deploymentId",
  "deploymentType": "Complete",
  "deviceClassId": "31ee8c56559847429fbe86e3e87f99b6",
  "startDateTime": "2020-04-22T12:12:12.0000000+00:00",
  "deviceGroupType": "Devices",
  "deviceGroupDefinition": [
    "device1",
    "device2"
  ],
  "updateId": {
    "provider": "provider",
    "name": "name",
    "version": "1.2.3.4"
  }
}

状态代码:

404

定义

名称	说明
Deployment	部署元数据。
DeploymentType	支持的部署类型。
DeviceGroupType	支持的部署组类型。
UpdateId	更新标识符。

Deployment

Object

部署元数据。

名称	类型	说明
deploymentId	string	获取或设置部署标识符。
deploymentType	DeploymentType	获取或设置部署类型。
deviceClassId	string	获取或设置设备类标识符。
deviceGroupDefinition	string[]	获取或设置设备组定义。
deviceGroupType	DeviceGroupType	获取或设置设备组类型。
isCanceled	boolean	指示部署是否已取消的布尔标志。
isCompleted	boolean	指示部署是否已完成的布尔标志。
isRetried	boolean	指示是否已重试部署的布尔标志。
startDateTime	string (date-time)	获取或设置部署开始日期时间。
updateId	UpdateId	更新标识。

DeploymentType

枚举

支持的部署类型。

值	说明
Complete	完整的部署，包括下载、安装和应用作。
Download	仅下载部署，不包括任何安装或应用作。 目前尚不支持。
Install	仅安装推出，不包括任何下载作，仅安装和完成。 目前尚不支持。

DeviceGroupType

枚举

支持的部署组类型。

值	说明
All	部署应发送到设备类中的所有设备。
Devices	部署应发送到设备组定义中的设备列表。
DeviceGroupDefinitions	部署应发送到所有设备组定义查询的联合返回的设备列表。

UpdateId

Object

更新标识符。

名称	类型	说明
name	string	更新名称。
provider	string	更新提供程序。
version	string	更新版本。