Releases - Get Release Environment
Pobierz środowisko wydania.
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1-preview.7
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?$expand={$expand}&api-version=7.1-preview.7
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
environment
|
path | True |
integer int32 |
Identyfikator środowiska wydania. |
organization
|
path | True |
string |
Nazwa organizacji usługi Azure DevOps. |
project
|
path | True |
string |
Identyfikator projektu lub nazwa projektu |
release
|
path | True |
integer int32 |
Identyfikator wydania. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.7", aby używać tej wersji interfejsu API. |
$expand
|
query |
Właściwość, która powinna zostać rozszerzona w środowisku. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
operacja zakończona powodzeniem |
Zabezpieczenia
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
Nazwa | Opis |
---|---|
vso.release | Umożliwia odczytywanie artefaktów wydania, w tym folderów, wydań, definicji wydania i środowiska wydania. |
Definicje
ApprovalExecutionOrder
Kolejność wykonywania zatwierdzeń.
Nazwa | Typ | Opis |
---|---|---|
afterGatesAlways |
string |
Zatwierdzenia wyświetlane zawsze po wykonaniu bram. |
afterSuccessfulGates |
string |
Zatwierdzenia wyświetlane po pomyślnym wykonaniu bram. |
beforeGates |
string |
Zatwierdzenia wyświetlane przed bramami. |
ApprovalOptions
Nazwa | Typ | Opis |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
Określ, czy zatwierdzenie można pominąć, jeśli ten sam osoba zatwierdzająca zatwierdziła poprzedni etap. |
enforceIdentityRevalidation |
boolean |
Określ, czy przed ukończeniem zatwierdzenia należy ponownie określić tożsamość osoby zatwierdzającej. |
executionOrder |
Kolejność wykonywania zatwierdzeń. |
|
releaseCreatorCanBeApprover |
boolean |
Określ, czy użytkownik żądający wydania lub wdrożenia powinien zezwalać na zatwierdzanie. |
requiredApproverCount |
integer |
Liczba zatwierdzeń wymaganych do przeniesienia wydania do przodu. "0" oznacza wszystkie wymagane zatwierdzenia. |
timeoutInMinutes |
integer |
Limit czasu zatwierdzania. Domyślny limit czasu zatwierdzania wynosi 30 dni. Maksymalny dozwolony limit czasu wynosi 365 dni. Wartość "0" oznacza domyślny limit czasu, tj. 30 dni. |
ApprovalStatus
Pobiera lub ustawia stan zatwierdzenia.
Nazwa | Typ | Opis |
---|---|---|
approved |
string |
Wskazuje zatwierdzenie zatwierdzenia. |
canceled |
string |
Wskazuje, że zatwierdzenie zostało anulowane. |
pending |
string |
Wskazuje, że zatwierdzenie oczekuje. |
reassigned |
string |
Wskazuje, że zatwierdzenie zostało ponownie przydzielone. |
rejected |
string |
Wskazuje, że zatwierdzenie zostało odrzucone. |
skipped |
string |
Wskazuje, że zatwierdzenie zostało pominięte. |
undefined |
string |
Wskazuje, że zatwierdzenie nie ma ustawionego stanu. |
ApprovalType
Pobiera lub ustawia typ zatwierdzenia.
Nazwa | Typ | Opis |
---|---|---|
all |
string |
Wskazuje wszystkie zatwierdzenia. |
postDeploy |
string |
Wskazuje zatwierdzenia wykonywane po wdrożeniu. |
preDeploy |
string |
Wskazuje zatwierdzenia wykonywane przed wdrożeniem. |
undefined |
string |
Wskazuje, że typ zatwierdzenia nie jest ustawiony. |
AuthorizationHeader
Nazwa | Typ | Opis |
---|---|---|
name |
string |
|
value |
string |
ConditionType
Pobiera lub ustawia typ warunku.
Nazwa | Typ | Opis |
---|---|---|
artifact |
string |
Typ warunku to artefakt. |
environmentState |
string |
Typ warunku to stan środowiska. |
event |
string |
Typ warunku to zdarzenie. |
undefined |
string |
Typ warunku jest niezdefiniowany. |
ConfigurationVariableValue
Nazwa | Typ | Opis |
---|---|---|
allowOverride |
boolean |
Pobiera i ustawia, jeśli zmienna może zostać przesłonięć w czasie wdrażania, czy nie. |
isSecret |
boolean |
Pobiera lub ustawia jako zmienną jest wpis tajny lub nie. |
value |
string |
Pobiera i ustawia wartość zmiennej konfiguracji. |
DataSourceBindingBase
Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.
Nazwa | Typ | Opis |
---|---|---|
callbackContextTemplate |
string |
Format stronicowania obsługiwany przez to źródło danych (ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
Potrzebne są kolejne połączenia? |
dataSourceName |
string |
Pobiera lub ustawia nazwę źródła danych. |
endpointId |
string |
Pobiera lub ustawia identyfikator punktu końcowego. |
endpointUrl |
string |
Pobiera lub ustawia adres URL punktu końcowego usługi. |
headers |
Pobiera lub ustawia nagłówki autoryzacji. |
|
initialContextTemplate |
string |
Definiuje początkową wartość parametrów zapytania |
parameters |
object |
Pobiera lub ustawia parametry dla źródła danych. |
requestContent |
string |
Pobiera lub ustawia treść żądania HTTP |
requestVerb |
string |
Pobiera lub ustawia czasownik żądania HTTP |
resultSelector |
string |
Pobiera lub ustawia selektor wyników. |
resultTemplate |
string |
Pobiera lub ustawia szablon wyników. |
target |
string |
Pobiera lub ustawia element docelowy źródła danych. |
DeploymentAttempt
Nazwa | Typ | Opis |
---|---|---|
attempt |
integer |
Próba wdrożenia. |
deploymentId |
integer |
Identyfikator wdrożenia. |
hasStarted |
boolean |
Określa, czy wdrożenie zostało uruchomione, czy nie. |
id |
integer |
Identyfikator wdrożenia. |
issues |
Issue[] |
Wszystkie problemy związane z wdrożeniem. |
lastModifiedBy |
Tożsamość, która ostatnio zmodyfikowała to wdrożenie. |
|
lastModifiedOn |
string |
Czas ostatniej modyfikacji tego wdrożenia. |
operationStatus |
Stan operacji wdrożenia. |
|
postDeploymentGates |
Po wdrożeniu bramy, które wykonano w tym wdrożeniu. |
|
preDeploymentGates |
Bramy przed wdrożeniem, które są wykonywane w tym wdrożeniu. |
|
queuedOn |
string |
Gdy to wdrożenie zostanie włączone w kolejce. |
reason |
Przyczyna wdrożenia. |
|
releaseDeployPhases |
Lista wdrożeń wydań wykonanych w tym wdrożeniu. |
|
requestedBy |
Tożsamość, która zażądała tego wdrożenia. |
|
requestedFor |
Zażądano tożsamości dla tego wdrożenia. |
|
status |
stan wdrożenia. |
DeploymentJob
Nazwa | Typ | Opis |
---|---|---|
job |
Nadrzędne zadanie wszystkich wykonanych zadań. |
|
tasks |
Lista wykonanych zadań w zadaniu. |
DeploymentOperationStatus
Pobiera stan operacji wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
all |
string |
Stan operacji wdrażania to wszystko. |
approved |
string |
Stan operacji wdrażania jest zatwierdzony. |
canceled |
string |
Stan operacji wdrażania jest anulowany. |
cancelling |
string |
Stan operacji wdrażania jest anulowany. |
deferred |
string |
Stan operacji wdrażania jest odroczony. |
evaluatingGates |
string |
Stan operacji wdrożenia to EvaluatingGates. |
gateFailed |
string |
Stan operacji wdrożenia to GateFailed. |
manualInterventionPending |
string |
Stan operacji wdrażania to oczekiwanie na ręczneintervention. |
pending |
string |
Stan operacji wdrażania to oczekiwanie. |
phaseCanceled |
string |
Stan operacji wdrażania to faza anulowana. |
phaseFailed |
string |
Stan operacji wdrożenia to faza niepowodzenia. |
phaseInProgress |
string |
Stan operacji wdrażania to faza w toku. |
phasePartiallySucceeded |
string |
Stan operacji wdrażania to faza częściowo powiodła się. |
phaseSucceeded |
string |
Stan operacji wdrożenia to faza powodzenia. |
queued |
string |
Stan operacji wdrażania jest w kolejce. |
queuedForAgent |
string |
Stan operacji wdrażania jest ustawiany w kolejce dla agenta. |
queuedForPipeline |
string |
Stan operacji wdrażania jest ustawiany w kolejce dla potoku. |
rejected |
string |
Stan operacji wdrażania jest odrzucany. |
scheduled |
string |
Stan operacji wdrażania jest zaplanowany. |
undefined |
string |
Stan operacji wdrażania jest niezdefiniowany. |
DeploymentReason
Pobiera przyczynę wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
automated |
string |
Przyczyna wdrożenia jest zautomatyzowana. |
manual |
string |
Przyczyną wdrożenia jest ręczne. |
none |
string |
Przyczyną wdrożenia jest brak. |
redeployTrigger |
string |
Przyczyną wdrożenia jest ponowne wdrożenieTrigger. |
scheduled |
string |
Przyczyna wdrożenia jest zaplanowana. |
DeploymentStatus
Pobiera stan wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
all |
string |
Stan wdrożenia to wszystko. |
failed |
string |
Stan wdrożenia nie powiódł się. |
inProgress |
string |
Stan wdrożenia jest w toku. |
notDeployed |
string |
Stan wdrożenia nie został wdrożony. |
partiallySucceeded |
string |
Stan wdrożenia jest częściowo zaplanowany. |
succeeded |
string |
Stan wdrożenia to powodzenie. |
undefined |
string |
Stan wdrożenia jest niezdefiniowany. |
DeployPhase
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Pobiera i ustawia nazwę fazy wdrażania. |
phaseType |
Wskazuje typ fazy wdrażania. |
|
rank |
integer |
Pobiera i ustawia rangę fazy wdrażania. |
refName |
string |
Pobiera i ustawia nazwę odwołania fazy wdrażania. |
workflowTasks |
Pobiera i ustawia zadania przepływu pracy dla fazy wdrażania. |
DeployPhaseStatus
Stan fazy.
Nazwa | Typ | Opis |
---|---|---|
canceled |
string |
Anulowano wykonywanie fazy. |
cancelling |
string |
Faza jest w stanie anulowania. |
failed |
string |
Wykonanie fazy nie powiodło się. |
inProgress |
string |
Wykonywanie fazy w toku. |
notStarted |
string |
Nie rozpoczęto wykonywania fazy. |
partiallySucceeded |
string |
Wykonanie fazy zakończyło się częściowo pomyślnie. |
skipped |
string |
Pominięto wykonywanie fazy. |
succeeded |
string |
Wykonanie fazy powiodło się. |
undefined |
string |
Nie ustawiono stanu fazy. |
DeployPhaseTypes
Wskazuje typ fazy wdrażania.
Nazwa | Typ | Opis |
---|---|---|
agentBasedDeployment |
string |
Typ fazy, który zawiera zadania wykonywane na agencie. |
deploymentGates |
string |
Typ fazy, który zawiera zadania, które pełnią rolę bram dla wdrożenia, aby przejść do przodu. |
machineGroupBasedDeployment |
string |
Typ fazy, który zawiera zadania wykonywane na maszynach grupy wdrożeń. |
runOnServer |
string |
Typ fazy zawierający zadania wykonywane przez serwer. |
undefined |
string |
Nie zdefiniowano typu fazy. Nie należy używać. |
EnvironmentOptions
Nazwa | Typ | Opis |
---|---|---|
autoLinkWorkItems |
boolean |
Pobiera i ustawia jako element roboczy linku automatycznego lub nie. |
badgeEnabled |
boolean |
Pobiera i ustawia jako wskaźnik włączony lub nie. |
publishDeploymentStatus |
boolean |
Pobiera i ustawia jako stan wdrożenia publikowania, a nie. |
pullRequestDeploymentEnabled |
boolean |
Pobiera i ustawia jako wdrożenie żądania ściągnięcia włączone lub nie. |
EnvironmentStatus
Pobiera stan środowiska.
Nazwa | Typ | Opis |
---|---|---|
canceled |
string |
Środowisko jest w stanie anulowania. |
inProgress |
string |
Środowisko jest w toku. |
notStarted |
string |
Środowisko nie jest w stanie uruchomienia. |
partiallySucceeded |
string |
Środowisko jest w stanie częściowym powodzenia. |
queued |
string |
Środowisko jest w stanie w kolejce. |
rejected |
string |
Środowisko jest w stanie odrzuconym. |
scheduled |
string |
Środowisko jest w stanie zaplanowanym. |
succeeded |
string |
Środowisko jest w stanie powodzenia. |
undefined |
string |
Stan środowiska nie jest ustawiony. |
GateStatus
Stan bram wydania.
Nazwa | Typ | Opis |
---|---|---|
canceled |
string |
Wykonanie bramy zostało anulowane. |
failed |
string |
Wykonanie bramy nie powiodło się. |
inProgress |
string |
Brama jest obecnie w toku. |
none |
string |
Brama nie ma ustawionego stanu. |
pending |
string |
Brama jest w stanie oczekiwania. |
succeeded |
string |
Brama została pomyślnie ukończona. |
IdentityRef
Nazwa | Typ | Opis |
---|---|---|
_links |
To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu. |
|
descriptor |
string |
Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji. |
directoryAlias |
string |
Przestarzałe — można je pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links" |
displayName |
string |
Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego. |
id |
string |
|
imageUrl |
string |
Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links" |
inactive |
boolean |
Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links" |
isAadIdentity |
boolean |
Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef |
uniqueName |
string |
Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName |
url |
string |
Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu. |
IgnoredGate
Nazwa | Typ | Opis |
---|---|---|
lastModifiedOn |
string |
Pobiera datę ostatniego ignorowania bramy. |
name |
string |
Nazwa bramy ignorowana. |
Issue
Nazwa | Typ | Opis |
---|---|---|
data |
object |
Dane dotyczące problemu. |
issueType |
string |
Typ problemu, na przykład błąd, ostrzeżenie lub informacje. |
message |
string |
Komunikat o problemie. |
ManualIntervention
Nazwa | Typ | Opis |
---|---|---|
approver |
Pobiera lub ustawia tożsamość, która powinna zostać zatwierdzana. |
|
comments |
string |
Pobiera lub ustawia komentarze do zatwierdzenia. |
createdOn |
string |
Pobiera datę utworzenia. |
id |
integer |
Pobiera unikatowy identyfikator interwencji ręcznej. |
instructions |
string |
Pobiera lub ustawia instrukcje dotyczące zatwierdzenia. |
modifiedOn |
string |
Pobiera datę modyfikacji. |
name |
string |
Pobiera lub ustawia nazwę. |
release |
Pobiera odwołanie releaseReference na potrzeby interwencji ręcznej. |
|
releaseDefinition |
Pobiera instrukcję releaseDefinitionReference na potrzeby interwencji ręcznej. |
|
releaseEnvironment |
Pobiera zwolnienieEnvironmentReference dla interwencji ręcznej. |
|
status |
Pobiera lub ustawia stan interwencji ręcznej. |
|
taskInstanceId |
string |
Pobierz identyfikator wystąpienia zadania. |
url |
string |
Pobiera adres URL w celu uzyskania dostępu do interwencji ręcznej. |
ManualInterventionStatus
Pobiera lub ustawia stan interwencji ręcznej.
Nazwa | Typ | Opis |
---|---|---|
approved |
string |
Interwencja ręczna jest zatwierdzana. |
canceled |
string |
Interwencja ręczna zostanie anulowana. |
pending |
string |
Ręczna interwencja jest w toku. |
rejected |
string |
Interwencja ręczna jest odrzucana. |
unknown |
string |
Interwencja ręczna nie ma ustawionego stanu. |
ProcessParameters
Nazwa | Typ | Opis |
---|---|---|
dataSourceBindings |
Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Pobiera unikatowy identyfikator tego pola. |
name |
string |
Pobiera nazwę projektu. |
ReferenceLinks
Klasa reprezentująca kolekcję linków referencyjnych REST.
Nazwa | Typ | Opis |
---|---|---|
links |
object |
Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu. |
ReleaseApproval
Nazwa | Typ | Opis |
---|---|---|
approvalType |
Pobiera lub ustawia typ zatwierdzenia. |
|
approvedBy |
Pobiera tożsamość, która zatwierdziła. |
|
approver |
Pobiera lub ustawia tożsamość, która powinna zostać zatwierdzana. |
|
attempt |
integer |
Pobiera lub ustawia próbę, która określa, do której próby wdrożenia należy. |
comments |
string |
Pobiera lub ustawia komentarze do zatwierdzenia. |
createdOn |
string |
Pobiera datę utworzenia. |
history |
Pobiera historię określającą wszystkie zatwierdzenia skojarzone z tym zatwierdzeniem. |
|
id |
integer |
Pobiera unikatowy identyfikator tego pola. |
isAutomated |
boolean |
Pobiera lub ustawia jako zatwierdzenie jest zautomatyzowane lub nie. |
modifiedOn |
string |
Pobiera datę modyfikacji. |
rank |
integer |
Pobiera lub ustawia rangę, która określa kolejność zatwierdzenia. Np. ta sama ranga oznacza zatwierdzenie równoległe. |
release |
Pobiera releaseReference, który określa odwołanie do wydania, z którym jest skojarzone to zatwierdzenie. |
|
releaseDefinition |
Pobiera parametr releaseDefinitionReference, który określa odwołanie do definicji wydania, z którą jest skojarzone to zatwierdzenie. |
|
releaseEnvironment |
Pobiera releaseEnvironmentReference, który określa odwołanie do środowiska wydania, z którym jest skojarzone to zatwierdzenie. |
|
revision |
integer |
Pobiera numer poprawki. |
status |
Pobiera lub ustawia stan zatwierdzenia. |
|
url |
string |
Pobiera adres URL w celu uzyskania dostępu do zatwierdzenia. |
ReleaseApprovalHistory
Nazwa | Typ | Opis |
---|---|---|
approver |
Tożsamość osoby zatwierdzającej. |
|
changedBy |
Tożsamość obiektu, który zmienił zatwierdzenie. |
|
comments |
string |
Komentarze historii zatwierdzania. |
createdOn |
string |
Godzina utworzenia tego zatwierdzenia. |
modifiedOn |
string |
Godzina modyfikacji tego zatwierdzenia. |
revision |
integer |
Poprawka historii zatwierdzania. |
ReleaseCondition
Nazwa | Typ | Opis |
---|---|---|
conditionType |
Pobiera lub ustawia typ warunku. |
|
name |
string |
Pobiera lub ustawia nazwę warunku. np. "ReleaseStarted". |
result |
boolean |
Wynik warunku wydania. |
value |
string |
Pobiera lub ustawia wartość warunku. |
ReleaseDefinitionApprovals
Nazwa | Typ | Opis |
---|---|---|
approvalOptions |
Pobiera lub ustawia opcje zatwierdzania. |
|
approvals |
Pobiera lub ustawia zatwierdzenia. |
ReleaseDefinitionApprovalStep
Nazwa | Typ | Opis |
---|---|---|
approver |
Pobiera i ustawia osoba zatwierdzająca. |
|
id |
integer |
Identyfikator kroku zatwierdzania lub wdrażania. |
isAutomated |
boolean |
Wskazuje, czy zatwierdzenie jest zautomatyzowane. |
isNotificationOn |
boolean |
Wskazuje, czy zestaw powiadomień o zatwierdzeniu. |
rank |
integer |
Pobiera lub ustawia rangę kroku zatwierdzania. |
ReleaseDefinitionGate
Nazwa | Typ | Opis |
---|---|---|
tasks |
Pobiera lub ustawia przepływ pracy bram. |
ReleaseDefinitionGatesOptions
Nazwa | Typ | Opis |
---|---|---|
isEnabled |
boolean |
Pobiera lub ustawia jako bramy włączone lub nie. |
minimumSuccessDuration |
integer |
Pobiera lub ustawia minimalny czas trwania dla stałych wyników po pomyślnej ocenie bram. |
samplingInterval |
integer |
Pobiera lub ustawia czas między ponowną oceną bram. |
stabilizationTime |
integer |
Pobiera lub ustawia opóźnienie przed oceną. |
timeout |
integer |
Pobiera lub ustawia limit czasu, po którym bramy kończą się niepowodzeniem. |
ReleaseDefinitionGatesStep
Nazwa | Typ | Opis |
---|---|---|
gates |
Pobiera lub ustawia bramy. |
|
gatesOptions |
Pobiera lub ustawia opcje bramy. |
|
id |
integer |
Identyfikator elementu ReleaseDefinitionGateStep. |
ReleaseDefinitionShallowReference
Nazwa | Typ | Opis |
---|---|---|
_links |
Pobiera linki do powiązanych zasobów, interfejsów API i widoków definicji wydania. |
|
id |
integer |
Pobiera unikatowy identyfikator definicji wydania. |
name |
string |
Pobiera lub ustawia nazwę definicji wydania. |
path |
string |
Pobiera lub ustawia ścieżkę definicji wydania. |
projectReference |
Pobiera lub ustawia odwołanie do projektu. |
|
url |
string |
Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do definicji wydania. |
ReleaseDeployPhase
Nazwa | Typ | Opis |
---|---|---|
deploymentJobs |
Zadania wdrażania fazy. |
|
errorLog |
string |
Dzienniki błędów wykonywania fazy. |
manualInterventions |
Lista informacji o wykonywaniu zadań interwencji ręcznej w fazie. |
|
name |
string |
Nazwa fazy. |
phaseId |
string |
Identyfikator fazy. |
phaseType |
Typ fazy. |
|
rank |
integer |
Ranga fazy. |
runPlanId |
string |
Uruchom identyfikator planu fazy. |
startedOn |
string |
Godzina rozpoczęcia fazy. |
status |
Stan fazy. |
ReleaseEnvironment
Nazwa | Typ | Opis |
---|---|---|
conditions |
Pobiera listę warunków. |
|
createdOn |
string |
Pobiera datę utworzenia. |
definitionEnvironmentId |
integer |
Pobiera identyfikator środowiska definicji. |
deployPhasesSnapshot |
Pobiera listę migawek faz wdrażania. |
|
deploySteps |
Pobiera kroki wdrażania. |
|
environmentOptions |
Pobiera opcje środowiska. |
|
id |
integer |
Pobiera unikatowy identyfikator tego pola. |
modifiedOn |
string |
Pobiera datę modyfikacji. |
name |
string |
Pobiera nazwę. |
nextScheduledUtcTime |
string |
Pobiera następny zaplanowany czas UTC. |
owner |
Pobiera tożsamość, która jest właścicielem środowiska wydania. |
|
postApprovalsSnapshot |
Pobiera listę migawek zatwierdzeń po wdrożeniu. |
|
postDeployApprovals |
Pobiera listę zatwierdzeń po wdrożeniu. |
|
postDeploymentGatesSnapshot |
Publikowanie danych migawek bram wdrożenia. |
|
preApprovalsSnapshot |
Pobiera listę migawek zatwierdzeń wstępnie wdrożonych. |
|
preDeployApprovals |
Pobiera listę zatwierdzeń wstępnie wdrożonych. |
|
preDeploymentGatesSnapshot |
Dane migawek bram przed wdrożeniem. |
|
processParameters |
Pobiera parametry procesu. |
|
rank |
integer |
Pobiera rangę. |
release |
Pobiera odwołanie do wydania, które określa odwołanie do wydania, z którym jest skojarzone to środowisko wydania. |
|
releaseCreatedBy |
Pobiera tożsamość, która utworzyła wydanie. |
|
releaseDefinition |
Pobiera parametr releaseDefinitionReference, który określa odwołanie do definicji wydania, z którą jest skojarzone to środowisko wydania. |
|
releaseId |
integer |
Pobiera identyfikator wydania. |
scheduledDeploymentTime |
string |
Pobiera zaplanowany czas wdrożenia środowiska wydania. |
schedules |
Pobiera listę harmonogramów. |
|
status |
Pobiera stan środowiska. |
|
timeToDeploy |
number |
Pobiera czas na wdrożenie. |
triggerReason |
string |
Pobiera przyczynę wyzwalacza. |
variableGroups |
Pobiera listę grup zmiennych. |
|
variables |
<string,
Configuration |
Pobiera słownik zmiennych. |
ReleaseEnvironmentExpands
Właściwość, która powinna zostać rozszerzona w środowisku.
Nazwa | Typ | Opis |
---|---|---|
none |
string |
Zwraca właściwości najwyższego poziomu obiektu. |
tasks |
string |
Rozwiń środowisko za pomocą zadań. |
ReleaseEnvironmentShallowReference
Nazwa | Typ | Opis |
---|---|---|
_links |
Pobiera linki do powiązanych zasobów, interfejsów API i widoków środowiska wydania. |
|
id |
integer |
Pobiera unikatowy identyfikator środowiska wydania. |
name |
string |
Pobiera lub ustawia nazwę środowiska wydania. |
url |
string |
Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do środowiska wydania. |
ReleaseGates
Nazwa | Typ | Opis |
---|---|---|
deploymentJobs |
Zawiera szczegóły zadania bramy dla każdej oceny. |
|
id |
integer |
Identyfikator bram wydania. |
ignoredGates |
Lista ignorowanych bram. |
|
lastModifiedOn |
string |
Czas ostatniej modyfikacji bram. |
runPlanId |
string |
Identyfikator planu uruchamiania bram. |
stabilizationCompletedOn |
string |
Stabilizacja bramy zakończyła datę i godzinę. |
startedOn |
string |
Godzina rozpoczęcia oceny bram. |
status |
Stan bram wydania. |
|
succeedingSince |
string |
Data i godzina pomyślnego wykonania wszystkich bram. |
ReleaseSchedule
Nazwa | Typ | Opis |
---|---|---|
daysToRelease |
Dni tygodnia do wydania. |
|
jobId |
string |
Identyfikator zadania definicji zadania programu Team Foundation. |
scheduleOnlyWithChanges |
boolean |
Flaga określająca, czy ten harmonogram powinien zostać zwolniony tylko w przypadku zmiany skojarzonego artefaktu lub zmiany definicji wydania. |
startHours |
integer |
Godzina lokalnej strefy czasowej do uruchomienia. |
startMinutes |
integer |
Godzina rozpoczęcia w lokalnej strefie czasowej. |
timeZoneId |
string |
Identyfikator strefy czasowej harmonogramu wydania, taki jak "UTC". |
ReleaseShallowReference
Nazwa | Typ | Opis |
---|---|---|
_links |
Pobiera linki do powiązanych zasobów, interfejsów API i widoków dla wydania. |
|
id |
integer |
Pobiera unikatowy identyfikator wydania. |
name |
string |
Pobiera lub ustawia nazwę wydania. |
url |
string |
Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do wydania. |
ReleaseTask
Nazwa | Typ | Opis |
---|---|---|
agentName |
string |
Nazwa agenta, na którym wykonano zadanie. |
finishTime |
string |
Godzina zakończenia zadania wydania. |
id |
integer |
Identyfikator zadania wydania. |
issues |
Issue[] |
Lista problemów wystąpiła podczas wykonywania zadania. |
lineCount |
integer |
Liczba wierszy zadania zwolnienia dziennika. |
logUrl |
string |
Adres URL dziennika zadania. |
name |
string |
Nazwa zadania. |
percentComplete |
integer |
Zakończenie wykonywania zadania. |
rank |
integer |
Ranga zadania wydania. |
resultCode |
string |
Kod wyniku zadania. |
startTime |
string |
Identyfikator zadania wydania. |
status |
Stan zadania wydania. |
|
task |
Dokumentacja zadania przepływu pracy. |
|
timelineRecordId |
string |
Identyfikator rekordu osi czasu zadania wydania. |
ScheduleDays
Dni tygodnia do wydania.
Nazwa | Typ | Opis |
---|---|---|
all |
string |
Zaplanowane na wszystkie dni w tygodniu. |
friday |
string |
Zaplanowane w piątek. |
monday |
string |
Zaplanowane w poniedziałek. |
none |
string |
Nie ustawiono zaplanowanego dnia. |
saturday |
string |
Zaplanowane w sobotę. |
sunday |
string |
Zaplanowane w niedzielę. |
thursday |
string |
Zaplanowane w czwartek. |
tuesday |
string |
Zaplanowane we wtorek. |
wednesday |
string |
Zaplanowane w środę. |
TaskInputDefinitionBase
Nazwa | Typ | Opis |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
Nazwa | Typ | Opis |
---|---|---|
expression |
string |
Wyrażenie warunkowe |
message |
string |
Komunikat wyjaśniający, jak użytkownik może poprawić, jeśli walidacja nie powiedzie się |
TaskSourceDefinitionBase
Nazwa | Typ | Opis |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Stan zadania wydania.
Nazwa | Typ | Opis |
---|---|---|
canceled |
string |
Wykonanie zadania zostało anulowane. |
failed |
string |
Wykonanie zadania nie powiodło się. |
failure |
string |
Wykonanie zadania nie powiodło się. |
inProgress |
string |
Zadanie jest obecnie w toku. |
partiallySucceeded |
string |
Wykonanie zadania zakończyło się częściowo pomyślnie. |
pending |
string |
Zadanie jest w stanie oczekiwania. |
skipped |
string |
Wykonanie zadania zostało pominięte. |
succeeded |
string |
Zadanie zostało ukończone pomyślnie. |
success |
string |
Zadanie zostało ukończone pomyślnie. |
unknown |
string |
Zadanie nie ma ustawionego stanu. |
VariableGroup
Nazwa | Typ | Opis |
---|---|---|
createdBy |
Pobiera lub ustawia tożsamość, która utworzyła. |
|
createdOn |
string |
Pobiera datę utworzenia. |
description |
string |
Pobiera lub ustawia opis. |
id |
integer |
Pobiera unikatowy identyfikator tego pola. |
isShared |
boolean |
Określa, czy grupa zmiennych jest udostępniana innym projektom, czy nie. |
modifiedBy |
Pobiera lub ustawia tożsamość, która została zmodyfikowana. |
|
modifiedOn |
string |
Pobiera datę modyfikacji. |
name |
string |
Pobiera lub ustawia nazwę. |
providerData |
Pobiera lub ustawia dane dostawcy. |
|
type |
string |
Pobiera lub ustawia typ. |
variableGroupProjectReferences |
wszystkie odwołania do projektu, w których grupa zmiennych jest udostępniana innym projektom. |
|
variables |
<string,
Variable |
Pobiera i ustawia słownik zmiennych. |
VariableGroupProjectReference
Odwołanie do grupy zmiennych jest płytkim odwołaniem do grupy zmiennych.
Nazwa | Typ | Opis |
---|---|---|
description |
string |
Pobiera lub ustawia opis grupy zmiennych. |
name |
string |
Pobiera lub ustawia nazwę grupy zmiennych. |
projectReference |
Pobiera lub ustawia odwołanie do projektu grupy zmiennych. |
VariableGroupProviderData
VariableValue
Nazwa | Typ | Opis |
---|---|---|
isReadOnly |
boolean |
Pobiera lub ustawia, jeśli zmienna jest tylko do odczytu, czy nie. |
isSecret |
boolean |
Pobiera lub ustawia jako zmienną jest wpis tajny lub nie. |
value |
string |
Pobiera lub ustawia wartość. |
WorkflowTask
Nazwa | Typ | Opis |
---|---|---|
alwaysRun |
boolean |
Pobiera lub ustawia jako zadanie zawsze uruchamiane lub nie. |
condition |
string |
Pobiera lub ustawia warunek zadania. |
continueOnError |
boolean |
Pobiera lub ustawia jako zadanie kontynuuj pracę po błędzie lub nie. |
definitionType |
string |
Pobiera lub ustawia typ definicji zadania. Przykład: "Agent", DeploymentGroup", "Server" lub "ServerGate". |
enabled |
boolean |
Pobiera lub ustawia jako zadanie włączone lub nie. |
environment |
object |
Pobiera lub ustawia zmienne środowiskowe zadania. |
inputs |
object |
Pobiera lub ustawia dane wejściowe zadania. |
name |
string |
Pobiera lub ustawia nazwę zadania. |
overrideInputs |
object |
Pobiera lub ustawia przesłonięcia danych wejściowych zadania. |
refName |
string |
Pobiera lub ustawia nazwę odwołania zadania. |
retryCountOnTaskFailure |
integer |
Pobiera lub ustawia zadanie retryCount. |
taskId |
string |
Pobiera lub ustawia identyfikator zadania. |
timeoutInMinutes |
integer |
Pobiera lub ustawia limit czasu zadania. |
version |
string |
Pobiera lub ustawia wersję zadania. |
WorkflowTaskReference
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zadania. |
name |
string |
Nazwa zadania. |
version |
string |
Wersja zadania. |