Environments - Add

Service:

Environments

API Version:

7.2-preview.1

Create an environment.

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

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.

Request Body

Name	Type	Description
description	string	Description of the environment.
name	string	Name of the environment.

Responses

Name	Type	Description
200 OK	EnvironmentInstance	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

Name	Description
vso.build_execute	Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to queue a build, update build properties, and the ability to receive notifications about build events via service hooks.
vso.environment_manage	Provides ability to manage environment

Definitions

Name	Description
EnvironmentCreateParameter	Properties to create Environment.
EnvironmentInstance	Environment.
EnvironmentResourceReference	EnvironmentResourceReference.
EnvironmentResourceType	Type of the resource.
IdentityRef
ProjectReference
ReferenceLinks

EnvironmentCreateParameter

Properties to create Environment.

Name	Type	Description
description	string	Description of the environment.
name	string	Name of the environment.

EnvironmentInstance

Environment.

Name	Type	Description
createdBy	IdentityRef	Identity reference of the user who created the Environment.
createdOn	string	Creation time of the Environment
description	string	Description of the Environment.
id	integer	Id of the Environment
lastModifiedBy	IdentityRef	Identity reference of the user who last modified the Environment.
lastModifiedOn	string	Last modified time of the Environment
name	string	Name of the Environment.
project	ProjectReference	Project information for environment.
resources	EnvironmentResourceReference[]	EnvironmentResourceReference.

EnvironmentResourceReference

EnvironmentResourceReference.

Name	Type	Description
id	integer	Id of the resource.
name	string	Name of the resource.
tags	string[]	Tags of the Environment Resource Reference.
type	EnvironmentResourceType	Type of the resource.

EnvironmentResourceType

Type of the resource.

Name	Type	Description
generic	string	Unknown resource type
kubernetes	string	Kubernetes resource type
undefined	string
virtualMachine	string	Virtual machine resource type

IdentityRef

Name	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

Name	Type	Description
id	string
name	string

ReferenceLinks

Name	Type	Description
links	object