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

Dev Boxes - Get Customization Group

获取自定义组。

GET {endpoint}/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}?api-version=2024-05-01-preview

URI 参数

名称 必需 类型 说明
customizationGroupName
path True

string

自定义组的名称。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$

devBoxName
path True

string

开发框的显示名称。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$

endpoint
path True

string

uri

要在其上运行的特定于 DevCenter 的 URI。

projectName
path True

string

项目名称。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$

userId
path True

string

用户的 AAD 对象 ID。 如果值为“me”,则标识取自身份验证上下文。

正则表达式模式: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

CustomizationGroup

请求已成功。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

OAuth2Auth

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

作用域

名称 说明
https://devcenter.azure.com/.default

示例

Gets a customization group.

示例请求

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com//projects/myProject/users/me/devboxes/MyDevBox/customizationGroups/Provisioning?api-version=2024-05-01-preview

示例响应

{
  "name": "Provisioning",
  "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning",
  "tasks": [
    {
      "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb",
      "name": "catalogName/choco",
      "displayName": "Install VS Code",
      "status": "Succeeded",
      "parameters": {
        "packageName": "vscode",
        "packageVersion": "1.0.0"
      },
      "startTime": "2021-08-05T18:00:00.000Z",
      "endTime": "2021-08-05T18:00:00.000Z",
      "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb"
    },
    {
      "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4",
      "name": "catalogName/write-to-file",
      "status": "Running",
      "startTime": "2021-08-05T18:00:00.000Z",
      "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4"
    }
  ],
  "status": "Running",
  "startTime": "2021-08-05T18:00:00.000Z"
}

定义

名称 说明
Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

CustomizationGroup

表示要应用于 Dev Box 的任务列表。

CustomizationGroupStatus

自定义组的状态。

CustomizationTask

在 Dev Box 上运行的自定义任务。

CustomizationTaskExecutionAccount

要以哪个帐户运行任务。

CustomizationTaskStatus

自定义任务的状态。

Azure.Core.Foundations.Error

错误对象。

名称 类型 说明
code

string

服务器定义的一组错误代码中的一个。

details

Azure.Core.Foundations.Error[]

有关导致此项报告错误的特定错误的详细信息数组。

innererror

Azure.Core.Foundations.InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

target

string

错误的目标。

Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。

名称 类型 说明
error

Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses

名称 类型 说明
code

string

服务器定义的一组错误代码中的一个。

innererror

Azure.Core.Foundations.InnerError

内部错误。

CustomizationGroup

表示要应用于 Dev Box 的任务列表。

名称 类型 说明
endTime

string

自定义组的结束时间。

name

string

自定义组的名称。

startTime

string

自定义组的开始时间。

status

CustomizationGroupStatus

自定义组的状态。

tasks

CustomizationTask[]

要应用的任务。 默认情况下,列出自定义组时,将从响应中排除任务。 若要包含它们,请使用 include=tasks 查询参数。

uri

string

自定义组的唯一 URI。

CustomizationGroupStatus

自定义组的状态。

名称 类型 说明
Failed

string

自定义组中至少有一个任务失败。

NotStarted

string

自定义组尚未启动。

Running

string

自定义组当前正在执行。

Succeeded

string

已成功执行自定义组中的所有任务。

ValidationFailed

string

自定义组中至少有一个任务未通过验证。

CustomizationTask

在 Dev Box 上运行的自定义任务。

名称 类型 说明
displayName

string

显示名称,以帮助区分同一任务的多个实例。

endTime

string

任务的结束时间。

id

string

任务实例的 ID。

logUri

string

用于检索任务日志的唯一 URI。

name

string

任务的名称。

parameters

object

任务的参数。

runAs

CustomizationTaskExecutionAccount

要以哪个帐户运行任务。

startTime

string

任务的开始时间。

status

CustomizationTaskStatus

任务的状态。

timeoutInSeconds

integer

超时,以秒为单位。 替代任务定义上提供的任何超时。

CustomizationTaskExecutionAccount

要以哪个帐户运行任务。

名称 类型 说明
System

string

SYSTEM 帐户。

User

string

已登录用户的帐户。

CustomizationTaskStatus

自定义任务的状态。

名称 类型 说明
Failed

string

任务执行失败。

FailedValidation

string

任务引用无效。

NotStarted

string

任务尚未启动。

Running

string

任务当前正在执行。

Skipped

string

他的任务被跳过。

Succeeded

string

任务已成功执行。

TimedOut

string

任务超时。

WaitingForUserInputUac

string

任务正在等待用户帐户控制 (UAC) 批准提示。 (有关详细信息,请参阅: https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/)

WaitingForUserSession

string

该任务正在等待用户连接到 Dev Box 以执行。