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

Deployments - Get Deployment

获取部署的属性。

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

URI 参数

名称 必需 类型 说明
accountEndpoint
path True

string

帐户终结点。

deploymentId
path True

string

部署标识符。

instanceId
path True

string

帐户实例标识符。

响应

名称 类型 说明
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_GetDeployment

示例请求

GET 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"
  },
  "isCanceled": false,
  "isRetried": false,
  "isCompleted": false
}

定义

名称 说明
Deployment

部署元数据。

DeploymentType

支持的部署类型。

DeviceGroupType

支持的部署组类型。

UpdateId

更新标识符。

Deployment

部署元数据。

名称 类型 说明
deploymentId

string

获取或设置部署标识符。

deploymentType

DeploymentType

获取或设置部署类型。

deviceClassId

string

获取或设置设备类标识符。

deviceGroupDefinition

string[]

获取或设置设备组定义。

deviceGroupType

DeviceGroupType

获取或设置设备组类型。

isCanceled

boolean

指示部署是否已取消的布尔标志。

isCompleted

boolean

指示部署是否已完成的布尔标志。

isRetried

boolean

指示是否已重试部署的布尔标志。

startDateTime

string

获取或设置部署开始日期时间。

updateId

UpdateId

更新标识。

DeploymentType

支持的部署类型。

名称 类型 说明
Complete

string

完整的部署,包括下载、安装和应用操作。

Download

string

不包含任何安装或应用操作的仅下载部署。 当前不支持。

Install

string

仅安装推出,不包括任何下载操作,仅安装和完成。 当前不支持。

DeviceGroupType

支持的部署组类型。

名称 类型 说明
All

string

部署应发送到设备类中的所有设备。

DeviceGroupDefinitions

string

部署应发送到所有设备组定义查询的联合返回的设备列表。

Devices

string

部署应发送到设备组定义中的设备列表。

UpdateId

更新标识符。

名称 类型 说明
name

string

更新名称。

provider

string

更新提供程序。

version

string

更新版本。