Releases - Get Release
Získat verzi
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=5.0
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?approvalFilters={approvalFilters}&propertyFilters={propertyFilters}&$expand={$expand}&$topGateRecords={$topGateRecords}&api-version=5.0
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Název organizace Azure DevOps. |
project
|
path | True |
string |
ID projektu nebo název projektu |
release
|
path | True |
integer int32 |
ID vydané verze. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavena na hodnotu 5.0. |
$expand
|
query |
Vlastnost, která by měla být ve vydané verzi rozšířena. |
||
$top
|
query |
integer int32 |
Počet záznamů o vydanou bránu, které chcete získat. Výchozí hodnota je 5. |
|
approval
|
query |
Filtr, který by umožňoval načíst schvalovací kroky selektivně podle toho, jestli je to automatizované, nebo ruční. To by také rozhodlo, jestli máme načíst snímky před a po schválení. Ve výchozím nastavení předpokládá vše. |
||
property
|
query |
string array (string) |
Seznam rozšířených vlastností oddělených čárkami, které se mají načíst. Pokud je tato vlastnost nastavená, bude vrácená verze obsahovat hodnoty pro ID zadané vlastnosti (pokud existují). Pokud není nastaveno, vlastnosti nebudou zahrnuty. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
úspěšná operace |
Zabezpečení
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.release | Umožňuje číst artefakty vydaných verzí, včetně verzí, definic vydaných verzí a prostředí vydaných verzí. |
Příklady
Sample Request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases/{releaseId}?api-version=5.0
Sample Response
{
"id": 18,
"name": "Release-18",
"status": "abandoned",
"createdOn": "2017-06-16T01:36:20.397Z",
"modifiedOn": "2017-06-16T01:36:21.07Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"environments": [
{
"id": 69,
"releaseId": 18,
"name": "Dev",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": false,
"isNotificationOn": false,
"approver": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"id": 0
}
],
"approvalOptions": {
"requiredApproverCount": 0,
"releaseCreatorCanBeApprover": true,
"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
"enforceIdentityRevalidation": false,
"timeoutInMintues": 43200
}
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 1,
"definitionEnvironmentId": 1,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 18,
"name": "Release-18",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "Manual"
},
{
"id": 70,
"releaseId": 18,
"name": "QA",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 2,
"definitionEnvironmentId": 2,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "Dev",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 18,
"name": "Release-18",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of Dev"
},
{
"id": 71,
"releaseId": 18,
"name": "PPE",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 3,
"definitionEnvironmentId": 3,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "QA",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 18,
"name": "Release-18",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of QA"
},
{
"id": 72,
"releaseId": 18,
"name": "PROD",
"status": "notStarted",
"variables": {},
"preDeployApprovals": [],
"postDeployApprovals": [],
"preApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"postApprovalsSnapshot": {
"approvals": [
{
"rank": 1,
"isAutomated": true,
"isNotificationOn": false,
"id": 0
}
]
},
"deploySteps": [],
"rank": 4,
"definitionEnvironmentId": 4,
"environmentOptions": {
"emailNotificationType": "OnlyOnFailure",
"emailRecipients": "release.environment.owner;release.creator",
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"enableAccessToken": false,
"publishDeploymentStatus": false
},
"demands": [],
"conditions": [
{
"result": false,
"name": "PPE",
"conditionType": "environmentState",
"value": "4"
}
],
"workflowTasks": [],
"deployPhasesSnapshot": [
{
"deploymentInput": {
"parallelExecution": {
"parallelExecutionType": "none"
},
"skipArtifactsDownload": false,
"timeoutInMinutes": 0,
"queueId": 2,
"demands": [],
"enableAccessToken": false
},
"rank": 1,
"phaseType": "agentBasedDeployment",
"name": "Run on agent",
"workflowTasks": [
{
"taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
"version": "1.*",
"name": "PowerShell Script",
"enabled": true,
"alwaysRun": false,
"continueOnError": false,
"timeoutInMinutes": 0,
"definitionType": "task",
"inputs": {
"scriptType": "inlineScript",
"scriptName": "",
"arguments": "",
"inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
"workingFolder": "",
"failOnStandardError": "true"
}
}
]
}
],
"owner": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"schedules": [],
"release": {
"id": 18,
"name": "Release-18",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
}
}
},
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
},
"self": {
"href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
}
}
},
"releaseCreatedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart"
},
"triggerReason": "After successful deployment of PPE"
}
],
"variables": {},
"variableGroups": [],
"artifacts": [
{
"sourceId": "d07908bc-118f-47d2-8a13-ff75601a6b1a:1",
"type": "Build",
"alias": "Fabrikam.CI",
"definitionReference": {
"artifactSourceDefinitionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&definitionId=1",
"name": ""
},
"defaultVersionBranch": {
"id": "",
"name": ""
},
"defaultVersionSpecific": {
"id": "",
"name": ""
},
"defaultVersionTags": {
"id": "",
"name": ""
},
"defaultVersionType": {
"id": "latestType",
"name": "Latest"
},
"definition": {
"id": "1",
"name": "Fabrikam.CI"
},
"project": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": "MyFirstProject"
},
"version": {
"id": "2",
"name": "2"
},
"artifactSourceVersionUrl": {
"id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&buildId=2",
"name": ""
},
"branch": {
"id": "refs/heads/master",
"name": "refs/heads/master"
}
},
"isPrimary": true
}
],
"releaseDefinition": {
"id": 1,
"name": "MyShuttle.CD",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
}
}
},
"description": "Creating Sample release",
"reason": "manual",
"releaseNameFormat": "Release-$(rev:r)",
"keepForever": false,
"definitionSnapshotRevision": 1,
"logsContainerUrl": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18/logs",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
}
},
"tags": [],
"projectReference": {
"id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
"name": null
},
"properties": {}
}
Definice
Name | Description |
---|---|
Approval |
|
Approval |
Filtr, který umožňuje načíst kroky schválení selektivně podle toho, jestli jsou automatizované, nebo ruční. To by také rozhodovalo, jestli máme načíst snímky před a po schválení. Ve výchozím nastavení se předpokládá vše |
Approval |
|
Approval |
Získá nebo nastaví stav schválení. |
Approval |
Získá nebo nastaví typ schválení. |
Artifact | |
Artifact |
|
Authorization |
|
Condition |
Získá nebo nastaví typ podmínky. |
Configuration |
|
Data |
Představuje vazbu zdroje dat pro požadavek koncového bodu služby. |
Demand | |
Deployment |
|
Deployment |
|
Deployment |
Získá stav operace nasazení. |
Deployment |
Získá důvod nasazení. |
Deployment |
Získá stav nasazení. |
Deploy |
|
Deploy |
|
Deploy |
|
Environment |
|
Environment |
Získá stav prostředí. |
Gate |
|
Identity |
|
Ignored |
|
Issue | |
Manual |
|
Manual |
Získá nebo nastaví stav ručního zásahu. |
Process |
|
Project |
|
Properties |
Třída představuje kontejner vlastností jako kolekci párů klíč-hodnota. Přijímají se hodnoty všech primitivních typů (libovolný typ s |
Reference |
Třída představující kolekci odkazů REST. |
Release | |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
Získá důvod pro uvolnění. |
Release |
|
Release |
|
Release |
Získá stav. |
Release |
|
Schedule |
Dny v týdnu do vydání |
Single |
Vlastnost, která by se měla ve vydané verzi rozbalit. |
Task |
|
Task |
|
Task |
|
Task |
|
Variable |
|
Variable |
|
Variable |
|
Workflow |
|
Workflow |
ApprovalExecutionOrder
Name | Typ | Description |
---|---|---|
afterGatesAlways |
string |
|
afterSuccessfulGates |
string |
|
beforeGates |
string |
ApprovalFilters
Filtr, který umožňuje načíst kroky schválení selektivně podle toho, jestli jsou automatizované, nebo ruční. To by také rozhodovalo, jestli máme načíst snímky před a po schválení. Ve výchozím nastavení se předpokládá vše
Name | Typ | Description |
---|---|---|
all |
string |
Všechny kroky schválení a snímky schválení |
approvalSnapshots |
string |
Žádné kroky schválení, ale snímky schválení (pro kroky schválení použijte buď s ManualApprovals, nebo AutomatedApprovals) |
automatedApprovals |
string |
Automatizované kroky schválení, ale žádné snímky schválení (použijte s approvalSnapshots pro snímky) |
manualApprovals |
string |
Kroky ručního schválení, ale žádné snímky schválení (pro snímky se používají s funkcemi ApprovalSnapshots) |
none |
string |
Žádné snímky schválení nebo schválení |
ApprovalOptions
Name | Typ | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
|
enforceIdentityRevalidation |
boolean |
|
executionOrder | ||
releaseCreatorCanBeApprover |
boolean |
|
requiredApproverCount |
integer |
|
timeoutInMinutes |
integer |
ApprovalStatus
Získá nebo nastaví stav schválení.
Name | Typ | Description |
---|---|---|
approved |
string |
|
canceled |
string |
|
pending |
string |
|
reassigned |
string |
|
rejected |
string |
|
skipped |
string |
|
undefined |
string |
ApprovalType
Získá nebo nastaví typ schválení.
Name | Typ | Description |
---|---|---|
all |
string |
|
postDeploy |
string |
|
preDeploy |
string |
|
undefined |
string |
Artifact
Name | Typ | Description |
---|---|---|
alias |
string |
Získá nebo nastaví alias. |
definitionReference |
<string,
Artifact |
Získá nebo nastaví odkaz na definici. např. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}} |
isPrimary |
boolean |
Získá nebo nastaví, protože artefakt je primární nebo ne. |
isRetained |
boolean |
|
type |
string |
Získá nebo nastaví typ. Může mít hodnotu Build, Jenkins, GitHub, NuGet, Team Build (externí), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild. |
ArtifactSourceReference
Name | Typ | Description |
---|---|---|
id |
string |
|
name |
string |
AuthorizationHeader
Name | Typ | Description |
---|---|---|
name |
string |
|
value |
string |
ConditionType
Získá nebo nastaví typ podmínky.
Name | Typ | Description |
---|---|---|
artifact |
string |
Typ podmínky je artefakt. |
environmentState |
string |
Typ podmínky je stav prostředí. |
event |
string |
Typ podmínky je událost. |
undefined |
string |
Typ podmínky není definován. |
ConfigurationVariableValue
Name | Typ | Description |
---|---|---|
allowOverride |
boolean |
Získá nebo nastaví, pokud proměnnou lze přepsat v době nasazení nebo ne. |
isSecret |
boolean |
Získá nebo nastaví, protože proměnná je tajný nebo ne. |
value |
string |
Získá nebo nastaví hodnotu konfigurační proměnné. |
DataSourceBindingBase
Představuje vazbu zdroje dat pro požadavek koncového bodu služby.
Name | Typ | Description |
---|---|---|
callbackContextTemplate |
string |
Formát stránkování podporovaný tímto zdrojem dat (ContinuationToken/SkipTop). |
callbackRequiredTemplate |
string |
Jsou potřeba další hovory? |
dataSourceName |
string |
Získá nebo nastaví název zdroje dat. |
endpointId |
string |
Získá nebo nastaví ID koncového bodu. |
endpointUrl |
string |
Získá nebo nastaví adresu URL koncového bodu služby. |
headers |
Získá nebo nastaví autorizační hlavičky. |
|
initialContextTemplate |
string |
Definuje počáteční hodnotu parametrů dotazu. |
parameters |
object |
Získá nebo nastaví parametry pro zdroj dat. |
resultSelector |
string |
Získá nebo nastaví selektor výsledků. |
resultTemplate |
string |
Získá nebo nastaví šablonu výsledku. |
target |
string |
Získá nebo nastaví cíl zdroje dat. |
Demand
Name | Typ | Description |
---|---|---|
name |
string |
|
value |
string |
DeploymentAttempt
Name | Typ | Description |
---|---|---|
attempt |
integer |
|
deploymentId |
integer |
|
hasStarted |
boolean |
Určuje, jestli se nasazení spustilo, nebo ne. |
id |
integer |
|
issues |
Issue[] |
Všechny problémy související s nasazením |
job | ||
lastModifiedBy | ||
lastModifiedOn |
string |
|
operationStatus | ||
postDeploymentGates | ||
preDeploymentGates | ||
queuedOn |
string |
|
reason | ||
releaseDeployPhases | ||
requestedBy | ||
requestedFor | ||
runPlanId |
string |
|
status | ||
tasks |
DeploymentJob
Name | Typ | Description |
---|---|---|
job | ||
tasks |
DeploymentOperationStatus
Získá stav operace nasazení.
Name | Typ | Description |
---|---|---|
all |
string |
Stav operace nasazení je vše. |
approved |
string |
Stav operace nasazení je schválen. |
canceled |
string |
Stav operace nasazení je zrušený. |
cancelling |
string |
Stav operace nasazení se ruší. |
deferred |
string |
Stav operace nasazení je odložený. |
evaluatingGates |
string |
Stav operace nasazení je EvaluatingGates. |
gateFailed |
string |
Stav operace nasazení je GateFailed. |
manualInterventionPending |
string |
Stav operace nasazení je ručníintervention čeká na vyřízení. |
pending |
string |
Stav operace nasazení čeká na vyřízení. |
phaseCanceled |
string |
Stav operace nasazení je fáze zrušena. |
phaseFailed |
string |
Stav operace nasazení je fáze selhání. |
phaseInProgress |
string |
Stav operace nasazení je fáze inprogress. |
phasePartiallySucceeded |
string |
Stav operace nasazení je fáze částečně úspěšná. |
phaseSucceeded |
string |
Stav operace nasazení je fáze úspěch. |
queued |
string |
Stav operace nasazení je zařazen do fronty. |
queuedForAgent |
string |
Stav operace nasazení je zařazený do fronty pro agenta. |
queuedForPipeline |
string |
Stav operace nasazení je zařazený do fronty pro kanál. |
rejected |
string |
Stav operace nasazení je odmítnut. |
scheduled |
string |
Stav operace nasazení je naplánovaný. |
undefined |
string |
Stav operace nasazení není definován. |
DeploymentReason
Získá důvod nasazení.
Name | Typ | Description |
---|---|---|
automated |
string |
Důvod nasazení je automatizovaný. |
manual |
string |
Důvod nasazení je ruční. |
none |
string |
Důvod nasazení není žádný. |
redeployTrigger |
string |
Důvodem nasazení je RedeployTrigger. |
scheduled |
string |
Důvod nasazení je naplánovaný. |
DeploymentStatus
Získá stav nasazení.
Name | Typ | Description |
---|---|---|
all |
string |
Stav nasazení je vše. |
failed |
string |
Stav nasazení selhal. |
inProgress |
string |
Stav nasazení je probíhající. |
notDeployed |
string |
Stav nasazení není nasazený. |
partiallySucceeded |
string |
Stav nasazení je částečně spuštěný. |
succeeded |
string |
Stav nasazení je úspěšný. |
undefined |
string |
Stav nasazení není definován. |
DeployPhase
Name | Typ | Description |
---|---|---|
name |
string |
|
phaseType | ||
rank |
integer |
|
refName |
string |
|
workflowTasks |
DeployPhaseStatus
Name | Typ | Description |
---|---|---|
canceled |
string |
|
cancelling |
string |
|
failed |
string |
|
inProgress |
string |
|
notStarted |
string |
|
partiallySucceeded |
string |
|
skipped |
string |
|
succeeded |
string |
|
undefined |
string |
DeployPhaseTypes
Name | Typ | Description |
---|---|---|
agentBasedDeployment |
string |
|
deploymentGates |
string |
Typ fáze obsahující úlohy, které fungují jako brány pro nasazení. |
machineGroupBasedDeployment |
string |
|
runOnServer |
string |
|
undefined |
string |
EnvironmentOptions
Name | Typ | Description |
---|---|---|
autoLinkWorkItems |
boolean |
|
badgeEnabled |
boolean |
|
emailNotificationType |
string |
|
emailRecipients |
string |
|
enableAccessToken |
boolean |
|
publishDeploymentStatus |
boolean |
|
pullRequestDeploymentEnabled |
boolean |
|
skipArtifactsDownload |
boolean |
|
timeoutInMinutes |
integer |
EnvironmentStatus
Získá stav prostředí.
Name | Typ | Description |
---|---|---|
canceled |
string |
|
inProgress |
string |
|
notStarted |
string |
|
partiallySucceeded |
string |
|
queued |
string |
|
rejected |
string |
|
scheduled |
string |
|
succeeded |
string |
|
undefined |
string |
GateStatus
Name | Typ | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
inProgress |
string |
|
none |
string |
|
pending |
string |
|
succeeded |
string |
IdentityRef
Name | Typ | Description |
---|---|---|
_links |
Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu. |
|
descriptor |
string |
Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací. |
directoryAlias |
string |
|
displayName |
string |
Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli. |
id |
string |
|
imageUrl |
string |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu. |
IgnoredGate
Name | Typ | Description |
---|---|---|
lastModifiedOn |
string |
Získá datum, kdy je brána naposledy ignorována. |
name |
string |
Název brány byl ignorován. |
Issue
Name | Typ | Description |
---|---|---|
data |
object |
|
issueType |
string |
|
message |
string |
ManualIntervention
Name | Typ | Description |
---|---|---|
approver |
Získá nebo nastaví identitu, která by měla schválit. |
|
comments |
string |
Získá nebo nastaví komentáře ke schválení. |
createdOn |
string |
Získá datum, kdy byl vytvořen. |
id |
integer |
Získá jedinečný identifikátor pro ruční zásah. |
instructions |
string |
Získá nebo nastaví pokyny ke schválení. |
modifiedOn |
string |
Získá datum, kdy došlo k úpravě. |
name |
string |
Získá nebo nastaví název. |
release |
Získá releaseReference pro ruční zásah. |
|
releaseDefinition |
Získá releaseDefinitionReference pro ruční zásah. |
|
releaseEnvironment |
Získá releaseEnvironmentReference pro ruční zásah. |
|
status |
Získá nebo nastaví stav ručního zásahu. |
|
taskInstanceId |
string |
Získejte identifikátor instance úlohy. |
url |
string |
Získá adresu URL pro přístup k ručnímu zásahu. |
ManualInterventionStatus
Získá nebo nastaví stav ručního zásahu.
Name | Typ | Description |
---|---|---|
approved |
string |
Ruční zásah je schválen. |
canceled |
string |
Ruční zásah se zruší. |
pending |
string |
Ruční zásah čeká na vyřízení. |
rejected |
string |
Ruční zásah je odmítnut. |
unknown |
string |
Ruční zásah nemá nastavený stav. |
ProcessParameters
Name | Typ | Description |
---|---|---|
dataSourceBindings |
Představuje vazbu zdroje dat pro požadavek koncového bodu služby. |
|
inputs | ||
sourceDefinitions |
ProjectReference
Name | Typ | Description |
---|---|---|
id |
string |
Získá jedinečný identifikátor tohoto pole. |
name |
string |
Získá název projektu. |
PropertiesCollection
Třída představuje kontejner vlastností jako kolekci párů klíč-hodnota. Přijímají se hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Object
výjimkou DBNull
). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitiva se přeladí jako String. Byte[] byl očekáván jako řetězec kódovaný jako base64.
Name | Typ | Description |
---|---|---|
count |
integer |
Počet vlastností v kolekci. |
item |
object |
|
keys |
string[] |
Sada klíčů v kolekci. |
values |
string[] |
Sada hodnot v kolekci. |
ReferenceLinks
Třída představující kolekci odkazů REST.
Name | Typ | Description |
---|---|---|
links |
object |
Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení. |
Release
Name | Typ | Description |
---|---|---|
_links |
Získá odkazy pro přístup k verzi. |
|
artifacts |
Artifact[] |
Získá nebo nastaví seznam artefaktů. |
comment |
string |
Získá nebo nastaví komentář. |
createdBy |
Získá nebo nastaví identitu, která vytvořila. |
|
createdOn |
string |
Získá datum, kdy byl vytvořen. |
definitionSnapshotRevision |
integer |
Získá číslo revize snímku definice. |
description |
string |
Získá nebo nastaví popis verze. |
environments |
Získá seznam prostředí. |
|
id |
integer |
Získá jedinečný identifikátor tohoto pole. |
keepForever |
boolean |
Jestli se má verze vyloučit ze zásad uchovávání informací. |
logsContainerUrl |
string |
Získá adresu URL kontejneru protokolů. |
modifiedBy |
Získá nebo nastaví identitu, která změnila. |
|
modifiedOn |
string |
Získá datum, kdy došlo k úpravě. |
name |
string |
Získá název. |
poolName |
string |
Získá název fondu. |
projectReference |
Získá nebo nastaví odkaz na projekt. |
|
properties |
Třída představuje kontejner vlastností jako kolekci párů klíč-hodnota. Přijímají se hodnoty všech primitivních typů (libovolný typ s |
|
reason |
Získá důvod uvolnění. |
|
releaseDefinition |
Získá releaseDefinitionReference určující odkaz na definici verze, ke které je přidružena tato verze. |
|
releaseNameFormat |
string |
Získá formát názvu verze. |
status |
Získá stav. |
|
tags |
string[] |
Získá nebo nastaví seznam značek. |
triggeringArtifactAlias |
string |
|
variableGroups |
Získá seznam skupin proměnných. |
|
variables |
<string,
Configuration |
Získá nebo nastaví slovník proměnných. |
ReleaseApproval
Name | Typ | Description |
---|---|---|
approvalType |
Získá nebo nastaví typ schválení. |
|
approvedBy |
Získá identitu, která schválila. |
|
approver |
Získá nebo nastaví identitu, která má schválit. |
|
attempt |
integer |
Získá nebo nastaví pokus, který určuje, který pokus o nasazení patří. |
comments |
string |
Získá nebo nastaví komentáře ke schválení. |
createdOn |
string |
Získá datum, kdy byl vytvořen. |
history |
Získá historii, která určuje všechna schválení přidružená k tomuto schválení. |
|
id |
integer |
Získá jedinečný identifikátor tohoto pole. |
isAutomated |
boolean |
Získá nebo nastaví, protože schválení je automatizované nebo ne. |
isNotificationOn |
boolean |
|
modifiedOn |
string |
Získá datum, kdy došlo k úpravě. |
rank |
integer |
Získá nebo nastaví pořadí, které určuje pořadí schválení. Například stejné pořadí označuje paralelní schválení. |
release |
Získá releaseReference, který určuje odkaz na verzi, ke které je přidruženo toto schválení. |
|
releaseDefinition |
Získá releaseDefinitionReference určující odkaz na definici verze, ke které je přidruženo toto schválení. |
|
releaseEnvironment |
Získá releaseEnvironmentReference určující odkaz na prostředí verze, ke kterému je přidruženo toto schválení. |
|
revision |
integer |
Získá číslo revize. |
status |
Získá nebo nastaví stav schválení. |
|
trialNumber |
integer |
|
url |
string |
Získá adresu URL pro přístup ke schválení. |
ReleaseApprovalHistory
Name | Typ | Description |
---|---|---|
approver | ||
changedBy | ||
comments |
string |
|
createdOn |
string |
|
modifiedOn |
string |
|
revision |
integer |
ReleaseCondition
Name | Typ | Description |
---|---|---|
conditionType |
Získá nebo nastaví typ podmínky. |
|
name |
string |
Získá nebo nastaví název podmínky. např. ReleaseStarted. |
result |
boolean |
|
value |
string |
Získá nebo nastaví hodnotu podmínky. |
ReleaseDefinitionApprovals
Name | Typ | Description |
---|---|---|
approvalOptions | ||
approvals |
ReleaseDefinitionApprovalStep
Name | Typ | Description |
---|---|---|
approver | ||
id |
integer |
|
isAutomated |
boolean |
|
isNotificationOn |
boolean |
|
rank |
integer |
ReleaseDefinitionGate
Name | Typ | Description |
---|---|---|
tasks |
ReleaseDefinitionGatesOptions
Name | Typ | Description |
---|---|---|
isEnabled |
boolean |
|
minimumSuccessDuration |
integer |
|
samplingInterval |
integer |
|
stabilizationTime |
integer |
|
timeout |
integer |
ReleaseDefinitionGatesStep
Name | Typ | Description |
---|---|---|
gates | ||
gatesOptions | ||
id |
integer |
ReleaseDefinitionShallowReference
Name | Typ | Description |
---|---|---|
_links |
Získá odkazy na související prostředky, rozhraní API a zobrazení pro definici verze. |
|
id |
integer |
Získá jedinečný identifikátor definice verze. |
name |
string |
Získá nebo nastaví název definice verze. |
path |
string |
Získá nebo nastaví cestu k definici verze. |
projectReference |
Získá nebo nastaví odkaz na projekt. |
|
url |
string |
Získá adresu URL rozhraní REST API pro přístup k definici verze. |
ReleaseDeployPhase
Name | Typ | Description |
---|---|---|
deploymentJobs | ||
errorLog |
string |
|
id |
integer |
|
manualInterventions | ||
name |
string |
|
phaseId |
string |
|
phaseType | ||
rank |
integer |
|
runPlanId |
string |
|
startedOn |
string |
Čas zahájení fáze |
status |
ReleaseEnvironment
Name | Typ | Description |
---|---|---|
conditions |
Získá seznam podmínek. |
|
createdOn |
string |
Získá datum, kdy byl vytvořen. |
definitionEnvironmentId |
integer |
Získá ID prostředí definice. |
demands |
Demand[] |
Získá požadavky. |
deployPhasesSnapshot |
Získá seznam fází nasazení snímek. |
|
deploySteps |
Získá kroky nasazení. |
|
environmentOptions |
Získá možnosti prostředí. |
|
id |
integer |
Získá jedinečný identifikátor tohoto pole. |
modifiedOn |
string |
Získá datum, kdy došlo k úpravě. |
name |
string |
Získá název. |
nextScheduledUtcTime |
string |
Získá další naplánovaný čas UTC. |
owner |
Získá identitu, která je vlastníkem prostředí vydané verze. |
|
postApprovalsSnapshot |
Získá seznam snímků schválení po nasazení. |
|
postDeployApprovals |
Získá seznam schválení po nasazení. |
|
postDeploymentGatesSnapshot | ||
preApprovalsSnapshot |
Získá seznam snímků schválení před nasazením. |
|
preDeployApprovals |
Získá seznam schválení před nasazením. |
|
preDeploymentGatesSnapshot | ||
processParameters |
Získá parametry procesu. |
|
queueId |
integer |
Získá ID fronty. |
rank |
integer |
Získá pořadí. |
release |
Získá odkaz na verzi, která určuje odkaz na verzi, ke které je přidružena tato verze prostředí. |
|
releaseCreatedBy |
Získá identitu, která vytvořila verzi. |
|
releaseDefinition |
Získá releaseDefinitionReference určující odkaz na definici verze, ke které je přidružena tato verze prostředí. |
|
releaseDescription |
string |
Získá popis verze. |
releaseId |
integer |
Získá ID verze. |
scheduledDeploymentTime |
string |
Získá plán nasazení prostředí vydané verze. |
schedules |
Získá seznam plánů. |
|
status |
Získá stav prostředí. |
|
timeToDeploy |
number |
Získá čas k nasazení. |
triggerReason |
string |
Získá důvod triggeru. |
variableGroups |
Získá seznam skupin proměnných. |
|
variables |
<string,
Configuration |
Získá slovník proměnných. |
workflowTasks |
Získá seznam úkolů pracovního postupu. |
ReleaseEnvironmentShallowReference
Name | Typ | Description |
---|---|---|
_links |
Získá odkazy na související prostředky, rozhraní API a zobrazení pro prostředí vydané verze. |
|
id |
integer |
Získá jedinečný identifikátor vydaného prostředí. |
name |
string |
Získá nebo nastaví název prostředí vydané verze. |
url |
string |
Získá adresu URL rozhraní REST API pro přístup k prostředí vydané verze. |
ReleaseGates
Name | Typ | Description |
---|---|---|
deploymentJobs | ||
id |
integer |
|
ignoredGates | ||
lastModifiedOn |
string |
|
runPlanId |
string |
|
stabilizationCompletedOn |
string |
|
startedOn |
string |
|
status | ||
succeedingSince |
string |
ReleaseReason
Získá důvod pro uvolnění.
Name | Typ | Description |
---|---|---|
continuousIntegration |
string |
|
manual |
string |
|
none |
string |
|
pullRequest |
string |
|
schedule |
string |
ReleaseSchedule
Name | Typ | Description |
---|---|---|
daysToRelease |
Dny v týdnu k vydání |
|
jobId |
string |
ID úlohy definice úlohy Team Foundation |
startHours |
integer |
Začátek hodiny místního časového pásma |
startMinutes |
integer |
Minuta do začátku místního časového pásma |
timeZoneId |
string |
ID časového pásma plánu vydání, například UTC |
ReleaseShallowReference
Name | Typ | Description |
---|---|---|
_links |
Získá odkazy na související prostředky, rozhraní API a zobrazení pro verzi. |
|
id |
integer |
Získá jedinečný identifikátor verze. |
name |
string |
Získá nebo nastaví název verze. |
url |
string |
Získá adresu URL rozhraní REST API pro přístup k verzi. |
ReleaseStatus
Získá stav.
Name | Typ | Description |
---|---|---|
abandoned |
string |
|
active |
string |
|
draft |
string |
|
undefined |
string |
ReleaseTask
Name | Typ | Description |
---|---|---|
agentName |
string |
|
finishTime |
string |
|
id |
integer |
|
issues |
Issue[] |
|
lineCount |
integer |
|
logUrl |
string |
|
name |
string |
|
percentComplete |
integer |
|
rank |
integer |
|
resultCode |
string |
|
startTime |
string |
|
status | ||
task | ||
timelineRecordId |
string |
ScheduleDays
Dny v týdnu do vydání
Name | Typ | Description |
---|---|---|
all |
string |
|
friday |
string |
|
monday |
string |
|
none |
string |
|
saturday |
string |
|
sunday |
string |
|
thursday |
string |
|
tuesday |
string |
|
wednesday |
string |
SingleReleaseExpands
Vlastnost, která by se měla ve vydané verzi rozbalit.
Name | Typ | Description |
---|---|---|
none |
string |
|
tasks |
string |
TaskInputDefinitionBase
Name | Typ | Description |
---|---|---|
aliases |
string[] |
|
defaultValue |
string |
|
groupName |
string |
|
helpMarkDown |
string |
|
label |
string |
|
name |
string |
|
options |
object |
|
properties |
object |
|
required |
boolean |
|
type |
string |
|
validation | ||
visibleRule |
string |
TaskInputValidation
Name | Typ | Description |
---|---|---|
expression |
string |
Podmíněný výraz |
message |
string |
Zpráva vysvětlující, jak může uživatel opravit, pokud se ověření nezdaří |
TaskSourceDefinitionBase
Name | Typ | Description |
---|---|---|
authKey |
string |
|
endpoint |
string |
|
keySelector |
string |
|
selector |
string |
|
target |
string |
TaskStatus
Name | Typ | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
failure |
string |
|
inProgress |
string |
|
partiallySucceeded |
string |
|
pending |
string |
|
skipped |
string |
|
succeeded |
string |
|
success |
string |
|
unknown |
string |
VariableGroup
Name | Typ | Description |
---|---|---|
createdBy |
Získá nebo nastaví identitu, která vytvořila. |
|
createdOn |
string |
Získá datum, kdy byl vytvořen. |
description |
string |
Získá nebo nastaví popis. |
id |
integer |
Získá jedinečný identifikátor tohoto pole. |
isShared |
boolean |
Označuje, jestli se skupina proměnných sdílí s jiným projektem nebo ne. |
modifiedBy |
Získá nebo nastaví identitu, která změnila. |
|
modifiedOn |
string |
Získá datum, kdy došlo k úpravě. |
name |
string |
Získá nebo nastaví název. |
providerData |
Získá nebo nastaví data zprostředkovatele. |
|
type |
string |
Získá nebo nastaví typ. |
variables |
<string,
Variable |
VariableGroupProviderData
VariableValue
Name | Typ | Description |
---|---|---|
isSecret |
boolean |
|
value |
string |
WorkflowTask
Name | Typ | Description |
---|---|---|
alwaysRun |
boolean |
|
condition |
string |
|
continueOnError |
boolean |
|
definitionType |
string |
|
enabled |
boolean |
|
environment |
object |
|
inputs |
object |
|
name |
string |
|
overrideInputs |
object |
|
refName |
string |
|
taskId |
string |
|
timeoutInMinutes |
integer |
|
version |
string |
WorkflowTaskReference
Name | Typ | Description |
---|---|---|
id |
string |
|
name |
string |
|
version |
string |