Environments - Add

Service:

Environments

Version d'API:

7.2-preview.1

Créer un environnement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.2-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
description	string	Description de l’environnement.
name	string	Nom de l’environnement.

Réponses

Nom	Type	Description
200 OK	EnvironmentInstance	opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom	Description
vso.build_execute	Accorde la possibilité d’accéder aux artefacts de build, y compris les résultats de build, les définitions et les demandes, ainsi que la possibilité de mettre en file d’attente une build, de mettre à jour les propriétés de build et de recevoir des notifications sur les événements de build via des hooks de service.
vso.environment_manage	Offre la possibilité de gérer l’environnement

Définitions

Nom	Description
EnvironmentCreateParameter	Propriétés pour créer un environnement.
EnvironmentInstance	Environnement.
EnvironmentResourceReference	EnvironmentResourceReference.
EnvironmentResourceType	Type de la ressource.
IdentityRef
ProjectReference
ReferenceLinks

EnvironmentCreateParameter

Object

Propriétés pour créer un environnement.

Nom	Type	Description
description	string	Description de l’environnement.
name	string	Nom de l’environnement.

EnvironmentInstance

Object

Environnement.

Nom	Type	Description
createdBy	IdentityRef	Référence d’identité de l’utilisateur qui a créé l’environnement.
createdOn	string	Heure de création de l’environnement
description	string	Description de l’environnement.
id	integer	ID de l’environnement
lastModifiedBy	IdentityRef	Référence d’identité de l’utilisateur qui a modifié l’environnement pour la dernière fois.
lastModifiedOn	string	Heure de la dernière modification de l’environnement
name	string	Nom de l’environnement.
project	ProjectReference	Informations sur le projet pour l’environnement.
resources	EnvironmentResourceReference[]	EnvironmentResourceReference.

EnvironmentResourceReference

Object

EnvironmentResourceReference.

Nom	Type	Description
id	integer	ID de la ressource.
name	string	Nom de la ressource.
tags	string[]	Balises de la référence de ressource d’environnement.
type	EnvironmentResourceType	Type de la ressource.

EnvironmentResourceType

Enumeration

Type de la ressource.

Valeur	Description
generic	Type de ressource inconnu
kubernetes	Type de ressource Kubernetes
undefined
virtualMachine	Type de ressource de machine virtuelle

IdentityRef

Object

Nom	Type	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

Nom	Type	Description
id	string
name	string

ReferenceLinks

Object

Nom	Type	Description
links	object