Environments - Get

Servicio:

Environments

Versión de la API:

7.2-preview.1

Obtenga un entorno por su identificador.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentId	path	True	integer int32	Identificador del entorno.
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.2-preview.1" para usar esta versión de la API.
expands	query		EnvironmentExpands	Incluya estos detalles adicionales en los objetos devueltos.

Respuestas

Nombre	Tipo	Description
200 OK	EnvironmentInstance	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre	Description
vso.environment_manage	Proporciona la capacidad de administrar el entorno.
vso.build	Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de compilación, las definiciones y las solicitudes, y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio.

Definiciones

Nombre	Description
EnvironmentExpands	Incluya estos detalles adicionales en los objetos devueltos.
EnvironmentInstance	Entorno.
EnvironmentResourceReference	EnvironmentResourceReference.
EnvironmentResourceType	Tipo de recurso.
IdentityRef
ProjectReference
ReferenceLinks

EnvironmentExpands

Enumeration

Incluya estos detalles adicionales en los objetos devueltos.

Valor	Description
none	No hay propiedades adicionales
resourceReferences	Incluya referencias de recursos que hacen referencia al entorno.

EnvironmentInstance

Object

Entorno.

Nombre	Tipo	Description
createdBy	IdentityRef	Referencia de identidad del usuario que creó el entorno.
createdOn	string	Hora de creación del entorno
description	string	Descripción del entorno.
id	integer	Identificador del entorno
lastModifiedBy	IdentityRef	Referencia de identidad del usuario que modificó por última vez el entorno.
lastModifiedOn	string	Hora de la última modificación del entorno
name	string	Nombre del entorno.
project	ProjectReference	Información del proyecto para el entorno.
resources	EnvironmentResourceReference[]	EnvironmentResourceReference.

EnvironmentResourceReference

Object

EnvironmentResourceReference.

Nombre	Tipo	Description
id	integer	Identificador del recurso.
name	string	Nombre del recurso.
tags	string[]	Etiquetas de la referencia de recursos de entorno.
type	EnvironmentResourceType	Tipo de recurso.

EnvironmentResourceType

Enumeration

Tipo de recurso.

Valor	Description
generic	Tipo de recurso desconocido
kubernetes	Tipo de recurso de Kubernetes
undefined
virtualMachine	Tipo de recurso de máquina virtual

IdentityRef

Object

Nombre	Tipo	Description
_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

Nombre	Tipo	Description
id	string
name	string

ReferenceLinks

Object

Nombre	Tipo	Description
links	object