Environments - Get

サービス:

Environments

API バージョン:

7.2-preview.1

ID で環境を取得します。

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}?api-version=7.2-preview.1

省略可能なパラメーターを含む:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}?expands={expands}&api-version=7.2-preview.1

URI パラメーター

名前	/	必須	型	説明
environmentId	path	True	integer int32	環境の ID。
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。 このバージョンの API を使用するには、これを '7.2-preview.1' に設定する必要があります。
expands	query		EnvironmentExpands	これらの追加の詳細を返されるオブジェクトに含めます。

応答

名前	型	説明
200 OK	EnvironmentInstance	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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	環境を管理する機能を提供します
vso.build	ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能と、サービス フックを介してビルド イベントに関する通知を受信する機能を付与します。

定義

名前	説明
EnvironmentExpands	これらの追加の詳細を返されるオブジェクトに含めます。
EnvironmentInstance	環境。
EnvironmentResourceReference	EnvironmentResourceReference。
EnvironmentResourceType	リソースの種類。
IdentityRef
ProjectReference
ReferenceLinks

EnvironmentExpands

列挙

これらの追加の詳細を返されるオブジェクトに含めます。

値	説明
none	追加のプロパティはありません
resourceReferences	環境を参照するリソース参照を含めます。

EnvironmentInstance

Object

環境。

名前	型	説明
createdBy	IdentityRef	環境を作成したユーザーの ID 参照。
createdOn	string	環境の作成時間
description	string	環境の説明。
id	integer	環境の ID
lastModifiedBy	IdentityRef	環境を最後に変更したユーザーの ID 参照。
lastModifiedOn	string	環境の最終変更時刻
name	string	環境の名前。
project	ProjectReference	環境のプロジェクト情報。
resources	EnvironmentResourceReference[]	EnvironmentResourceReference。

EnvironmentResourceReference

Object

EnvironmentResourceReference。

名前	型	説明
id	integer	リソースの ID。
name	string	リソースの名前。
tags	string[]	環境リソース参照のタグ。
type	EnvironmentResourceType	リソースの種類。

EnvironmentResourceType

列挙

リソースの種類。

値	説明
generic	不明なリソースの種類
kubernetes	Kubernetes リソースの種類
undefined
virtualMachine	仮想マシン のリソースの種類

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks
descriptor	string
directoryAlias	string
displayName	string
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string

ProjectReference

Object

名前	型	説明
id	string
name	string

ReferenceLinks

Object

名前	型	説明
links	object