Environments - Add
Create an environment.
POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments?api-version=7.1-preview.1URI 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.1-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.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 |
The class to represent a collection of REST reference links. |
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 |
This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject. |
|
| descriptor |
string |
The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations. |
| directoryAlias |
string |
Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary |
| displayName |
string |
This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider. |
| id |
string |
|
| imageUrl |
string |
Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary |
| inactive |
boolean |
Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary |
| isAadIdentity |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Deprecated - not in use in most preexisting implementations of ToIdentityRef |
| uniqueName |
string |
Deprecated - use Domain+PrincipalName instead |
| url |
string |
This url is the full route to the source resource of this graph subject. |
ProjectReference
| Name | Type | Description |
|---|---|---|
| id |
string |
|
| name |
string |
ReferenceLinks
The class to represent a collection of REST reference links.
| Name | Type | Description |
|---|---|---|
| links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |