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

Deployments - Get All Deployments

Service:

Device Update

API Version:

2020-09-01

获取部署的列表。

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

With optional parameters:

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/management/deployments?$filter={$filter}

URI 参数

名称	在	必需	类型	说明
accountEndpoint	path	True	string	帐户终结点。
instanceId	path	True	string	帐户实例标识符。
$filter	query		string	限制返回的部署集。 可以根据更新 Provider、Name 和 Version 属性进行筛选。

响应

名称	类型	说明
200 OK	PageableListOfDeployments	部署。

安全性

azure_auth_implicit

Azure Active Directory OAuth2 隐式流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

azure_auth_code

Azure Active Directory OAuth2 AccessCode 流

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

名称	说明
user_impersonation	模拟用户帐户

azure_auth_application

Azure Active Directory OAuth2 应用程序流

Type: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

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

azure_auth_password

Azure Active Directory OAuth2 密码流

Type: oauth2
Flow: password
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Deployments_GetAllDeployments

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "deploymentId": "deploymentId1",
      "deploymentType": "Complete",
      "deviceClassId": "31ee8c56559847429fbe86e3e87f99b6",
      "startDateTime": "2020-07-01T12:13:14Z",
      "deviceGroupType": "Devices",
      "deviceGroupDefinition": [
        "device1",
        "device2"
      ],
      "updateId": {
        "provider": "provider1",
        "name": "name1",
        "version": "1.0.0.0"
      },
      "isCanceled": false,
      "isCompleted": false
    },
    {
      "deploymentId": "deploymentId2",
      "deploymentType": "Complete",
      "deviceClassId": "c1aa6c254f5b473bab024eebf01e6f3b",
      "startDateTime": "2020-08-01T12:13:14Z",
      "deviceGroupType": "Devices",
      "deviceGroupDefinition": [
        "device10",
        "device20"
      ],
      "updateId": {
        "provider": "provider2",
        "name": "name2",
        "version": "2.0.0.0"
      },
      "isCanceled": false,
      "isCompleted": false
    }
  ]
}

定义

名称	说明
Deployment	部署元数据。
DeploymentType	支持的部署类型。
DeviceGroupType	支持的部署组类型。
PageableListOfDeployments	部署列表。
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	部署应发送到设备组定义中的设备列表。

PageableListOfDeployments

部署列表。

名称	类型	说明
nextLink	string	指向项的下一页的链接。
value	Deployment[]	可分页项的集合。

UpdateId

更新标识符。

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