Environments - Add
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 |
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 |
---|---|
Environment |
Properties to create Environment. |
Environment |
Environment. |
Environment |
EnvironmentResourceReference. |
Environment |
Type of the resource. |
Identity |
|
Project |
|
Reference |
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 |
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 |
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 |
Project information for environment. |
|
resources |
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 |
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 | ||
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 |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for