Environments - Add

Service:

Environments

API Version:

7.2-preview.1

Eine Umgebung erstellen

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.2-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
description	string	Die Beschreibung der Umgebung.
name	string	Der Name der Umgebung.

Antworten

Name	Typ	Beschreibung
200 OK	EnvironmentInstance	Erfolgreicher Vorgang

Sicherheit

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	Beschreibung
vso.build_execute	Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, einen Build in eine Warteschlange zu stellen, Buildeigenschaften zu aktualisieren und Benachrichtigungen über Buildereignisse über Diensthaken zu empfangen.
vso.environment_manage	Ermöglicht die Verwaltung der Umgebung

Definitionen

Name	Beschreibung
EnvironmentCreateParameter	Eigenschaften zum Erstellen einer Umgebung.
EnvironmentInstance	Umgebung.
EnvironmentResourceReference	EnvironmentResourceReference.
EnvironmentResourceType	Der Typ der Ressource.
IdentityRef
ProjectReference
ReferenceLinks

EnvironmentCreateParameter

Eigenschaften zum Erstellen einer Umgebung.

Name	Typ	Beschreibung
description	string	Die Beschreibung der Umgebung.
name	string	Der Name der Umgebung.

EnvironmentInstance

Umgebung.

Name	Typ	Beschreibung
createdBy	IdentityRef	Identitätsreferenz des Benutzers, der die Umgebung erstellt hat.
createdOn	string	Erstellungszeit der Umgebung
description	string	Beschreibung der Umgebung.
id	integer	Id der Umgebung
lastModifiedBy	IdentityRef	Identitätsverweis des Benutzers, der die Umgebung zuletzt geändert hat.
lastModifiedOn	string	Zeitpunkt der letzten Änderung der Umgebung
name	string	Name der Umgebung.
project	ProjectReference	Projektinformationen für die Umgebung.
resources	EnvironmentResourceReference[]	EnvironmentResourceReference.

EnvironmentResourceReference

EnvironmentResourceReference.

Name	Typ	Beschreibung
id	integer	Id der Ressource.
name	string	Der Name der Ressource.
tags	string[]	Tags der Referenz zu Umgebungsressourcen.
type	EnvironmentResourceType	Der Typ der Ressource.

EnvironmentResourceType

Der Typ der Ressource.

Name	Typ	Beschreibung
generic	string	Unbekannter Ressourcentyp
kubernetes	string	Kubernetes-Ressourcentyp
undefined	string
virtualMachine	string	Ressourcentyp virtueller Computer

IdentityRef

Name	Typ	Beschreibung
_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	Typ	Beschreibung
id	string
name	string

ReferenceLinks

Name	Typ	Beschreibung
links	object