Environments - Update

Dienst:

Environments

API-Version:

7.2-preview.1

Aktualisieren Sie die angegebene Umgebung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentId	path	True	integer int32	ID der Umgebung.
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

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.environment_manage	Ermöglicht die Verwaltung der Umgebung

Definitionen

Name	Beschreibung
EnvironmentInstance	Umgebung.
EnvironmentResourceReference	EnvironmentResourceReference.
EnvironmentResourceType	Der Typ der Ressource.
EnvironmentUpdateParameter	Eigenschaften zum Aktualisieren der Umgebung.
IdentityRef
ProjectReference
ReferenceLinks

EnvironmentInstance

Objekt

Umgebung.

Name	Typ	Beschreibung
createdBy	IdentityRef	Identitätsverweis 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

Objekt

EnvironmentResourceReference.

Name	Typ	Beschreibung
id	integer	ID der Ressource.
name	string	Der Name der Ressource.
tags	string[]	Tags der Umgebungsressourcenreferenz.
type	EnvironmentResourceType	Der Typ der Ressource.

EnvironmentResourceType

Enumeration

Der Typ der Ressource.

Wert	Beschreibung
generic	Unbekannter Ressourcentyp
kubernetes	Kubernetes-Ressourcentyp
undefined
virtualMachine	Ressourcentyp des virtuellen Computers

EnvironmentUpdateParameter

Objekt

Eigenschaften zum Aktualisieren der Umgebung.

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

IdentityRef

Objekt

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

Objekt

Name	Typ	Beschreibung
id	string
name	string

ReferenceLinks

Objekt

Name	Typ	Beschreibung
links	object