Environments - Get

Servicio:

Distributed Task

Versión de la API:

7.1

Obtenga un entorno por su identificador.

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}?api-version=7.1

Con parámetros opcionales:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}?expands={expands}&api-version=7.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentId	path	True	integer (int32)	Identificador del entorno.
organization	path	True	string	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.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

Definiciones

Nombre	Description
EnvironmentExpands	Incluya estos detalles adicionales en los objetos devueltos.
EnvironmentInstance	Medio ambiente.
EnvironmentResourceReference	EnvironmentResourceReference.
EnvironmentResourceType	Tipo del recurso.
IdentityRef
ProjectReference
ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.

EnvironmentExpands

Enumeración

Incluya estos detalles adicionales en los objetos devueltos.

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

EnvironmentInstance

Object

Medio ambiente.

Nombre	Tipo	Description
createdBy	IdentityRef	Referencia de identidad del usuario que creó el entorno.
createdOn	string (date-time)	Hora de creación del entorno
description	string	Descripción del entorno.
id	integer (int32)	Identificador del entorno
lastModifiedBy	IdentityRef	Referencia de identidad del usuario que modificó por última vez el entorno.
lastModifiedOn	string (date-time)	Hora de ú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 (int32)	Identificador del recurso.
name	string	Nombre del recurso.
tags	string[]	Etiquetas de la referencia de recursos de entorno.
type	EnvironmentResourceType	Tipo del recurso.

EnvironmentResourceType

Enumeración

Tipo del 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	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string	En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links".
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string	En desuso: disponible en la entrada "avatar" del diccionario "_links" identityRef
inactive	boolean	En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario "_links" de GraphUser.
isAadIdentity	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName	string	En desuso: use Domain+PrincipalName en su lugar.
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

ProjectReference

Object

Nombre	Tipo	Description
id	string (uuid)
name	string

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia rest.

Nombre	Tipo	Description
links	object	Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.