Environments - Update
更新指定的环境。
PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}?api-version=7.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
environment
|
path | True |
integer (int32) |
环境的 ID。 |
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
project
|
path | True |
string |
项目 ID 或项目名称 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
环境说明。 |
| name |
string |
环境的名称。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功作 |
安全性
oauth2
类型:
oauth2
流向:
accessCode
授权 URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
作用域
| 名称 | 说明 |
|---|---|
| vso.environment_manage | 提供管理环境的功能 |
定义
| 名称 | 说明 |
|---|---|
|
Environment |
环境。 |
|
Environment |
EnvironmentResourceReference。 |
|
Environment |
资源的类型。 |
|
Environment |
用于更新环境的属性。 |
|
Identity |
|
|
Project |
|
|
Reference |
表示 REST 引用链接集合的类。 |
EnvironmentInstance
环境。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdBy |
创建环境的用户的标识引用。 |
|
| createdOn |
string (date-time) |
环境创建时间 |
| description |
string |
环境的说明。 |
| id |
integer (int32) |
环境的 ID |
| lastModifiedBy |
上次修改环境的用户的标识引用。 |
|
| lastModifiedOn |
string (date-time) |
环境的上次修改时间 |
| name |
string |
环境的名称。 |
| project |
环境的项目信息。 |
|
| resources |
EnvironmentResourceReference。 |
EnvironmentResourceReference
EnvironmentResourceReference。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
integer (int32) |
资源的 ID。 |
| name |
string |
资源的名称。 |
| tags |
string[] |
环境资源引用的标记。 |
| type |
资源的类型。 |
EnvironmentResourceType
资源的类型。
| 值 | 说明 |
|---|---|
| generic |
未知资源类型 |
| kubernetes |
Kubernetes 资源类型 |
| undefined | |
| virtualMachine |
虚拟机资源类型 |
EnvironmentUpdateParameter
用于更新环境的属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| description |
string |
环境说明。 |
| name |
string |
环境的名称。 |
IdentityRef
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。 |
|
| descriptor |
string |
描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。 |
| directoryAlias |
string |
已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索 |
| displayName |
string |
这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。 |
| id |
string |
|
| imageUrl |
string |
已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用 |
| inactive |
boolean |
已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索 |
| isAadIdentity |
boolean |
已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType） |
| isContainer |
boolean |
已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType） |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用 |
| uniqueName |
string |
已弃用 - 请改用 Domain+PrincipalName |
| url |
string |
此 URL 是指向此图形主题的源资源的完整路由。 |
ProjectReference
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string (uuid) |
|
| name |
string |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。 |