Definitions - Update

Service:

Release

API Version:

7.1-preview.4

Zaktualizuj definicję wydania.

PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wersja interfejsu API powinna być ustawiona na wartość "7.1-preview.4".

Treść żądania

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków definicji wydania.
artifacts	Artifact[]	Pobiera lub ustawia listę artefaktów.
comment	string	Pobiera lub ustawia komentarz.
createdBy	IdentityRef	Pobiera lub ustawia tożsamość, która została utworzona.
createdOn	string	Pobiera datę utworzenia.
description	string	Pobiera lub ustawia opis.
environments	ReleaseDefinitionEnvironment[]	Pobiera lub ustawia listę środowisk.
id	integer	Pobiera unikatowy identyfikator definicji wydania.
isDeleted	boolean	Czy definicja wydania jest usuwana.
lastRelease	ReleaseReference	Pobiera odwołanie do ostatniej wersji.
modifiedBy	IdentityRef	Pobiera lub ustawia tożsamość, która została zmodyfikowana.
modifiedOn	string	Pobiera datę, w której został zmodyfikowany.
name	string	Pobiera lub ustawia nazwę definicji wydania.
path	string	Pobiera lub ustawia ścieżkę definicji wydania.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu.
properties	PropertiesCollection	Pobiera lub ustawia właściwości.
releaseNameFormat	string	Pobiera lub ustawia format nazwy wydania.
revision	integer	Pobiera numer poprawki.
source	ReleaseDefinitionSource	Pobiera lub ustawia źródło definicji wydania.
tags	string[]	Pobiera lub ustawia listę tagów.
triggers	ReleaseTriggerBase[]	Pobiera lub ustawia listę wyzwalaczy.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do definicji wydania.
variableGroups	integer[]	Pobiera lub ustawia listę grup zmiennych.
variables	<string,  ConfigurationVariableValue>	Pobiera lub ustawia słownik zmiennych.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReleaseDefinition	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_execute	Umożliwia odczytywanie i aktualizowanie artefaktów wydania, w tym folderów, wydań, definicji wydania i środowiska wydania oraz możliwość kolejkowania nowej wersji.

Przykłady

Update the release definition

Sample Request

HTTP

PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4

{
  "source": "restApi",
  "revision": 1,
  "description": null,
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "createdOn": "2018-12-11T05:33:56.573Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "modifiedOn": "2018-12-11T05:33:56.573Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "name": "PROD",
      "rank": 1,
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "tasks": [],
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

Sample Response

Status code:

200

{
  "source": "restApi",
  "revision": 2,
  "description": null,
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "createdOn": "2018-12-11T05:33:56.573Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "modifiedOn": "2018-12-11T05:33:58.433Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "name": "PROD",
      "rank": 1,
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

Definicje

Nazwa	Opis
ApprovalExecutionOrder	Kolejność wykonywania zatwierdzeń.
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	Pobiera lub ustawia typ warunku.
ConfigurationVariableValue
DataSourceBindingBase	Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.
Demand
DeployPhase
DeployPhaseTypes	Wskazuje typ fazy wdrożenia.
EnvironmentExecutionPolicy	Definiuje zasady kolejkowania środowiska w kolejce po stronie Release Management. Wyślemy do modułu uruchamiającego środowisko [tworzącego wstępne wdrożenie i inne kroki] tylko wtedy, gdy wymienione zasady są spełnione.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	Pobiera lub ustawia typ wyzwalacza.
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	Pobiera lub ustawia źródło definicji wydania.
ReleaseReason	Pobiera przyczynę wydania.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	Typ wyzwalacza wydania.
ScheduleDays	Dni tygodnia do wydania.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

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 tożsamość osoby zatwierdzającej zostanie odnowiona przed ukończeniem zatwierdzenia.
executionOrder	ApprovalExecutionOrder	Kolejność wykonywania zatwierdzeń.
releaseCreatorCanBeApprover	boolean	Określ, czy użytkownik żądający wydania, czy wdrożenia powinien zezwalać na zatwierdzanie.
requiredApproverCount	integer	Liczba zatwierdzeń wymaganych do przeniesienia wydania do przodu. Wartość "0" oznacza wszystkie wymagane zatwierdzenia.
timeoutInMinutes	integer	Limit czasu zatwierdzenia. 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.

Artifact

Nazwa	Typ	Opis
alias	string	Pobiera lub ustawia alias.
definitionReference	<string,  ArtifactSourceReference>	Pobiera lub ustawia odwołanie do definicji. np. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5a90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}.
isPrimary	boolean	Wskazuje, czy artefakt jest podstawowy, czy nie.
isRetained	boolean	Wskazuje, czy artefakt jest zachowywany przez wydanie, czy nie.
type	string	Pobiera lub ustawia typ. Może mieć wartość "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild".

ArtifactSourceReference

Nazwa	Typ	Opis
id	string	Identyfikator źródła artefaktu.
name	string	Nazwa źródła artefaktu.

AuthorizationHeader

Nazwa	Typ	Opis
name	string
value	string

Condition

Nazwa	Typ	Opis
conditionType	ConditionType	Pobiera lub ustawia typ warunku.
name	string	Pobiera lub ustawia nazwę warunku. np. "ReleaseStarted".
value	string	Pobiera lub ustawia wartość warunku.

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, czy zmienna może zostać zastąpiona 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 wywołania?
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	AuthorizationHeader[]	Pobiera lub ustawia nagłówki autoryzacji.
initialContextTemplate	string	Definiuje początkową wartość parametrów zapytania
parameters	object	Pobiera lub ustawia parametry źródła danych.
requestContent	string	Pobiera lub ustawia treść żądania HTTP
requestVerb	string	Pobiera lub ustawia zlecenie żą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.

Demand

Nazwa	Typ	Opis
name	string	Pobiera i ustawia nazwę zapotrzebowania.
value	string	Pobiera i ustawia wartość zapotrzebowania.

DeployPhase

Nazwa	Typ	Opis
name	string	Pobiera i ustawia nazwę fazy wdrażania.
phaseType	DeployPhaseTypes	Wskazuje typ fazy wdrożenia.
rank	integer	Pobiera i ustawia rangę fazy wdrażania.
refName	string	Pobiera i ustawia nazwę referencyjną fazy wdrażania.
workflowTasks	WorkflowTask[]	Pobiera i ustawia zadania przepływu pracy dla fazy wdrażania.

DeployPhaseTypes

Wskazuje typ fazy wdrożenia.

Nazwa	Typ	Opis
agentBasedDeployment	string	Typ fazy zawierający zadania wykonywane na agencie.
deploymentGates	string	Typ fazy, który zawiera zadania, które działają jako bramy wdrożenia, aby przejść do przodu.
machineGroupBasedDeployment	string	Typ fazy, który zawiera zadania wykonywane na maszynach grupy wdrażania.
runOnServer	string	Typ fazy zawierający zadania wykonywane przez serwer.
undefined	string	Typ fazy nie jest zdefiniowany. Nie należy używać.

EnvironmentExecutionPolicy

Definiuje zasady kolejkowania środowiska w kolejce po stronie Release Management. Wyślemy do modułu uruchamiającego środowisko [tworzącego wstępne wdrożenie i inne kroki] tylko wtedy, gdy wymienione zasady są spełnione.

Nazwa	Typ	Opis
concurrencyCount	integer	Te zasady decydują, ile środowisk będzie miało miejsce w przypadku modułu uruchamiającego środowisko.
queueDepthCount	integer	Głębokość kolejki w tabeli EnvironmentQueue, ta tabela przechowuje wpisy środowiska do momentu, gdy moduł uruchamiający środowisko jest bezpłatny [zgodnie z zasadami] w celu podjęcia innego środowiska do uruchomienia.

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 lub nie.
pullRequestDeploymentEnabled	boolean	Pobiera i ustawia jako wdrożenie żądania ściągnięcia włączone lub nie.

EnvironmentRetentionPolicy

Nazwa	Typ	Opis
daysToKeep	integer	Pobiera i ustawia liczbę dni przechowywania środowiska.
releasesToKeep	integer	Pobiera i ustawia liczbę wydań do utrzymania.
retainBuild	boolean	Pobiera i ustawia jako kompilację do przechowywania lub nie.

EnvironmentTrigger

Nazwa	Typ	Opis
definitionEnvironmentId	integer	Identyfikator środowiska definicji, na którym ma zastosowanie ten wyzwalacz.
releaseDefinitionId	integer	ReleaseDefinition ID, na którym ma zastosowanie ten wyzwalacz.
triggerContent	string	Pobiera lub ustawia zawartość wyzwalacza.
triggerType	EnvironmentTriggerType	Pobiera lub ustawia typ wyzwalacza.

EnvironmentTriggerType

Pobiera lub ustawia typ wyzwalacza.

Nazwa	Typ	Opis
deploymentGroupRedeploy	string	Typ wyzwalacza środowiska to ponowne wdrożenie grupy wdrożenia.
rollbackRedeploy	string	Typ wyzwalacza środowiska to Wycofywanie.
undefined	string	Niezdefiniowany typ wyzwalacza środowiska.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	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łowania 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 pobrać, wysyłając zapytanie do użytkownika programu Graph przywoływanego w wpisie "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne w wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wysyłając zapytanie do 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 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.

ProcessParameters

Nazwa	Typ	Opis
dataSourceBindings	DataSourceBindingBase[]	Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Nazwa	Typ	Opis
id	string	Pobiera unikatowy identyfikator tego pola.
name	string	Pobiera nazwę projektu.

PropertiesCollection

Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.

Nazwa	Typ	Opis
count	integer	Liczba właściwości w kolekcji.
item	object
keys	string[]	Zestaw kluczy w kolekcji.
values	string[]	Zestaw wartości w kolekcji.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

ReleaseDefinition

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków definicji wydania.
artifacts	Artifact[]	Pobiera lub ustawia listę artefaktów.
comment	string	Pobiera lub ustawia komentarz.
createdBy	IdentityRef	Pobiera lub ustawia tożsamość, która została utworzona.
createdOn	string	Pobiera datę utworzenia.
description	string	Pobiera lub ustawia opis.
environments	ReleaseDefinitionEnvironment[]	Pobiera lub ustawia listę środowisk.
id	integer	Pobiera unikatowy identyfikator definicji wydania.
isDeleted	boolean	Czy definicja wydania jest usuwana.
lastRelease	ReleaseReference	Pobiera odwołanie do ostatniej wersji.
modifiedBy	IdentityRef	Pobiera lub ustawia tożsamość, która została zmodyfikowana.
modifiedOn	string	Pobiera datę, w której został zmodyfikowany.
name	string	Pobiera lub ustawia nazwę definicji wydania.
path	string	Pobiera lub ustawia ścieżkę definicji wydania.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu.
properties	PropertiesCollection	Pobiera lub ustawia właściwości.
releaseNameFormat	string	Pobiera lub ustawia format nazwy wydania.
revision	integer	Pobiera numer poprawki.
source	ReleaseDefinitionSource	Pobiera lub ustawia źródło definicji wydania.
tags	string[]	Pobiera lub ustawia listę tagów.
triggers	ReleaseTriggerBase[]	Pobiera lub ustawia listę wyzwalaczy.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do definicji wydania.
variableGroups	integer[]	Pobiera lub ustawia listę grup zmiennych.
variables	<string,  ConfigurationVariableValue>	Pobiera lub ustawia słownik zmiennych.

ReleaseDefinitionApprovals

Nazwa	Typ	Opis
approvalOptions	ApprovalOptions	Pobiera lub ustawia opcje zatwierdzania.
approvals	ReleaseDefinitionApprovalStep[]	Pobiera lub ustawia zatwierdzenia.

ReleaseDefinitionApprovalStep

Nazwa	Typ	Opis
approver	IdentityRef	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.

ReleaseDefinitionDeployStep

Nazwa	Typ	Opis
id	integer	Identyfikator kroku zatwierdzania lub wdrażania.
tasks	WorkflowTask[]	Lista kroków dla tej definicji.

ReleaseDefinitionEnvironment

Nazwa	Typ	Opis
badgeUrl	string	Pobiera lub ustawia element BadgeUrl. BadgeUrl będzie używany, gdy znaczek zostanie włączony w środowisku definicji wydania.
conditions	Condition[]	Pobiera lub ustawia warunki środowiskowe.
currentRelease	ReleaseShallowReference	Pobiera lub ustawia bieżące odwołanie do wersji.
demands	Demand[]	Pobiera lub ustawia wymagania.
deployPhases	DeployPhase[]	Pobiera lub ustawia fazy wdrażania środowiska.
deployStep	ReleaseDefinitionDeployStep	Pobiera lub ustawia krok wdrażania.
environmentOptions	EnvironmentOptions	Pobiera lub ustawia opcje środowiska.
environmentTriggers	EnvironmentTrigger[]	Pobiera lub ustawia wyzwalacze w środowisku.
executionPolicy	EnvironmentExecutionPolicy	Pobiera lub ustawia zasady wykonywania środowiska.
id	integer	Pobiera i ustawia identyfikator elementu ReleaseDefinitionEnvironment.
name	string	Pobiera i ustawia nazwę releaseDefinitionEnvironment.
owner	IdentityRef	Pobiera i ustawia właściciela releaseDefinitionEnvironment.
postDeployApprovals	ReleaseDefinitionApprovals	Pobiera lub ustawia zatwierdzenia po wdrożeniu.
postDeploymentGates	ReleaseDefinitionGatesStep	Pobiera lub ustawia bramy po wdrożeniu.
preDeployApprovals	ReleaseDefinitionApprovals	Pobiera lub ustawia zatwierdzenia przed wdrożeniem.
preDeploymentGates	ReleaseDefinitionGatesStep	Pobiera lub ustawia bramy przed wdrożeniem.
processParameters	ProcessParameters	Pobiera lub ustawia parametry procesu środowiskowego.
properties	PropertiesCollection	Pobiera lub ustawia właściwości w środowisku.
queueId	integer	Pobiera lub ustawia identyfikator kolejki.
rank	integer	Pobiera i ustawia rangę releaseDefinitionEnvironment.
retentionPolicy	EnvironmentRetentionPolicy	Pobiera lub ustawia zasady przechowywania środowiska.
schedules	ReleaseSchedule[]	Pobiera lub ustawia harmonogramy
variableGroups	integer[]	Pobiera lub ustawia grupy zmiennych.
variables	<string,  ConfigurationVariableValue>	Pobiera i ustawia zmienne.

ReleaseDefinitionGate

Nazwa	Typ	Opis
tasks	WorkflowTask[]	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 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	ReleaseDefinitionGate[]	Pobiera lub ustawia bramy.
gatesOptions	ReleaseDefinitionGatesOptions	Pobiera lub ustawia opcje bramy.
id	integer	Identyfikator elementu ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	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	ProjectReference	Pobiera lub ustawia odwołanie do projektu.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do definicji wydania.

ReleaseDefinitionSource

Pobiera lub ustawia źródło definicji wydania.

Nazwa	Typ	Opis
ibiza	string	Wskazuje wartość ReleaseDefinition utworzoną na podstawie Ibizy.
portalExtensionApi	string	Wskazuje wartość ReleaseDefinition utworzoną na podstawie interfejsu API rozszerzenia Portal.
restApi	string	Wskazuje wartość ReleaseDefinition utworzoną przy użyciu interfejsu API REST.
undefined	string	Wskazuje, że źródło ReleaseDefinition nie zostało zdefiniowane.
userInterface	string	Wskazuje wartość ReleaseDefinition utworzoną przy użyciu interfejsu użytkownika.

ReleaseReason

Pobiera przyczynę wydania.

Nazwa	Typ	Opis
continuousIntegration	string	Wskazuje wydanie wyzwalane przez ciągłą integrację.
manual	string	Wskazuje, że wersja została wyzwolona ręcznie.
none	string	Wskazuje, że przyczyna wyzwolenia wydania nie została ustawiona.
pullRequest	string	Wskazuje wydanie wyzwalane przez ciąg PullRequest.
schedule	string	Wskazuje wydanie wyzwalane zgodnie z harmonogramem.

ReleaseReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki umożliwiające uzyskanie dostępu do wersji.
artifacts	Artifact[]	Pobiera listę artefaktów.
createdBy	IdentityRef	Pobiera tożsamość, która utworzyła wydanie.
createdOn	string	Pobiera datę utworzenia tej wersji.
description	string	Pobiera opis.
id	integer	Identyfikator wydania.
modifiedBy	IdentityRef	Pobiera tożsamość, która zmodyfikowała wydanie.
name	string	Pobiera nazwę wydania.
reason	ReleaseReason	Pobiera przyczynę wydania.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera płytkie odwołanie do definicji wydania.

ReleaseSchedule

Nazwa	Typ	Opis
daysToRelease	ScheduleDays	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 wtedy, gdy skojarzony artefakt został zmieniony lub zmieniono definicję wydania.
startHours	integer	Godzina lokalnej strefy czasowej, która ma być uruchomiona.
startMinutes	integer	Godzina rozpoczęcia lokalnej strefy czasowej.
timeZoneId	string	Identyfikator strefy czasowej harmonogramu wydania, taki jak "UTC".

ReleaseShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	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 wersji.

ReleaseTriggerBase

Nazwa	Typ	Opis
triggerType	ReleaseTriggerType	Typ wyzwalacza wydania.

ReleaseTriggerType

Typ wyzwalacza wydania.

Nazwa	Typ	Opis
artifactSource	string	Wyzwalacz wydania opartego na artefaktach.
containerImage	string	Wyzwalacz wydania opartego na obrazie kontenera.
package	string	Wyzwalacz wydania opartego na pakiecie.
pullRequest	string	Wyzwalacz wydania opartego na żądaniu ściągnięcia.
schedule	string	Wyzwalacz wydania opartego na harmonogramie.
sourceRepo	string	Wyzwalacz wydania opartego na repozytorium źródłowym.
undefined	string	Nie ustawiono typu wyzwalacza 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	TaskInputValidation
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 zakończy się niepowodzeniem

TaskSourceDefinitionBase

Nazwa	Typ	Opis
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

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 kontynuowane w przypadku błędu 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 dane wejściowe zastępowania zadań.
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.