Releases - Get Release

Reference

Služba:: Release

Verze rozhraní API:: 7.1

Získání verze

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=7.1

S volitelnými parametry:

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?approvalFilters={approvalFilters}&propertyFilters={propertyFilters}&$expand={$expand}&$topGateRecords={$topGateRecords}&api-version=7.1

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
releaseId	path	True	integer (int32)	ID vydané verze.
api-version	query	True	string	Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.
$expand	query		SingleReleaseExpands	Vlastnost, která by měla být rozšířena ve vydané verzi.
$topGateRecords	query		integer (int32)	Počet záznamů bran vydaných verzí, které se mají získat. Výchozí hodnota je 5.
approvalFilters	query		ApprovalFilters	Filtr, který by umožnil selektivní načtení schvalovacích kroků na základě toho, jestli je automatizovaný, nebo ruční. To by také rozhodlo, jestli bychom měli načíst snímky před schválením a po schválení. Ve výchozím nastavení předpokládá vše.
propertyFilters	query		string (array (string))	Seznam rozšířených vlastností oddělených čárkami, který se má načíst. Pokud je nastaveno, vrácená verze bude obsahovat hodnoty pro zadané ID vlastnosti (pokud existují). Pokud není nastavená, vlastnosti nebudou zahrnuty.

Odpovědi

Name	Typ	Description
200 OK	Release	úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.release	Uděluje možnost číst artefakty vydané verze, včetně složek, vydaných verzí, definic vydaných verzí a prostředí vydaných verzí.

Příklady

Ukázkový požadavek

HTTP

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases/{releaseId}?api-version=7.1

Ukázková odpověď

Stavový kód:: 200

{
  "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://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-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://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-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
ApprovalExecutionOrder	Schválení pořadí provádění.
ApprovalFilters	Filtr, který by umožnil selektivní načtení schvalovacích kroků na základě toho, jestli je automatizovaný, nebo ruční. To by také rozhodlo, jestli bychom měli načíst snímky před schválením a po schválení. Ve výchozím nastavení předpokládá vše.
ApprovalOptions
ApprovalStatus	Získá nebo nastaví stav schválení.
ApprovalType	Získá nebo nastaví typ schválení.
Artifact
ArtifactSourceReference
AuthorizationHeader
ConditionType	Získá nebo nastaví typ podmínky.
ConfigurationVariableValue
DataSourceBindingBase	Představuje vazbu zdroje dat pro požadavek koncového bodu služby.
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Získá stav operace nasazení.
DeploymentReason	Získá důvod nasazení.
DeploymentStatus	Získá stav nasazení.
DeployPhase
DeployPhaseStatus	Stav fáze
DeployPhaseTypes	Označuje typ fáze nasazení.
EnvironmentOptions
EnvironmentStatus	Získá stav prostředí.
GateStatus	Stav bran uvolnění.
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Získá nebo nastaví stav ručního zásahu.
ProcessParameters
ProjectReference
PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Hodnoty všech primitivních typů (libovolný typ s `TypeCode != TypeCode.Object`) s výjimkou `DBNull` jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] byl očekáván jako řetězec kódovaný jako base64.
ReferenceLinks	Třída představující kolekci odkazů REST.
Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason	Získá důvod pro vydání.
ReleaseSchedule
ReleaseShallowReference
ReleaseStatus	Získá stav.
ReleaseTask
ScheduleDays	Dny v týdnu k vydání.
SingleReleaseExpands	Vlastnost, která by měla být rozšířena ve vydané verzi.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	Stav úlohy vydání
VariableGroup
VariableGroupProjectReference	Odkaz na skupinu proměnných je mělký odkaz na skupinu proměnných.
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Výčet

Schválení pořadí provádění.

Hodnota	Description
afterGatesAlways	Schválení se zobrazí vždy po spuštění bran.
afterSuccessfulGates	Schválení zobrazená po úspěšném provedení bran
beforeGates	Schválení zobrazená před branami

ApprovalFilters

Výčet

Filtr, který by umožnil selektivní načtení schvalovacích kroků na základě toho, jestli je automatizovaný, nebo ruční. To by také rozhodlo, jestli bychom měli načíst snímky před schválením a po schválení. Ve výchozím nastavení předpokládá vše.

Hodnota	Description
all	Všechny kroky schválení a snímky schválení
approvalSnapshots	Žádné kroky schválení, ale snímky schválení (pro schvalovací kroky použijte buď ManualApprovals, nebo AutomatedApprovals).
automatedApprovals	Automatizované kroky schválení, ale žádné snímky schválení (použijte u snímků schváleníSnapshots).
manualApprovals	Kroky ručního schválení, ale žádné snímky schválení (použijte u snímků schváleníSnapshots).
none	Žádné schválení ani snímky schválení.

ApprovalOptions

Objekt

Name	Typ	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Určete, jestli je možné schválení přeskočit, pokud stejný schvalovatel schválil předchozí fázi.
enforceIdentityRevalidation	boolean	Určete, jestli se před dokončením schválení znovu zobrazí identita schvalovatele.
executionOrder	ApprovalExecutionOrder	Schválení pořadí provádění.
releaseCreatorCanBeApprover	boolean	Určete, jestli má uživatel žádající o vydání nebo nasazení povolit schvalovatele.
requiredApproverCount	integer (int32)	Počet schválení potřebných k přesunutí verze vpřed. "0" se rozumí všechna potřebná schválení.
timeoutInMinutes	integer (int32)	Časový limit schválení Výchozí časový limit schválení je 30 dnů. Maximální povolený časový limit je 365 dnů. "0" se rozumí výchozí časový limit, tj. 30 dnů.

ApprovalStatus

Výčet

Získá nebo nastaví stav schválení.

Hodnota	Description
approved	Označuje schválení.
canceled	Označuje, že schválení je zrušeno.
pending	Označuje, že schválení čeká na vyřízení.
reassigned	Označuje, že se schválení znovu přiřazuje.
rejected	Označuje, že schválení je odmítnuto.
skipped	Označuje, že se schválení přeskočí.
undefined	Označuje, že schválení nemá nastavenou stav.

ApprovalType

Výčet

Získá nebo nastaví typ schválení.

Hodnota	Description
all	Označuje všechna schválení.
postDeploy	Označuje schválení, která se spustila po nasazení.
preDeploy	Označuje schválení, která se spustila před nasazením.
undefined	Označuje, že typ schválení není nastaven.

Artifact

Objekt

Name	Typ	Description
alias	string	Získá nebo nastaví alias.
definitionReference	<string, ArtifactSourceReference>	Získá nebo nastaví odkaz na definici. Například {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}}
isPrimary	boolean	Určuje, jestli je artefakt primární nebo ne.
isRetained	boolean	Určuje, jestli se artefakt uchovává ve vydané verzi nebo ne.
type	string	Získá nebo nastaví typ. Může mít hodnotu build, Jenkins, GitHub, Nuget, Team Build (externí) nebo ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

ArtifactSourceReference

Objekt

Name	Typ	Description
id	string	ID zdroje artefaktů.
name	string	Název zdroje artefaktů

AuthorizationHeader

Objekt

Name	Typ	Description
name	string
value	string

ConditionType

Výčet

Získá nebo nastaví typ podmínky.

Hodnota	Description
artifact	Typ podmínky je artefakt.
environmentState	Typ podmínky je stav prostředí.
event	Typ podmínky je událost.
undefined	Typ podmínky není definován.

ConfigurationVariableValue

Objekt

Name	Typ	Description
allowOverride	boolean	Získá a nastaví, pokud proměnnou lze přepsat v době nasazení nebo ne.
isSecret	boolean	Získá nebo nastaví jako proměnnou tajný klíč, nebo ne.
value	string	Získá a nastaví hodnotu konfigurační proměnné.

DataSourceBindingBase

Objekt

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 nebo SkipTop).
callbackRequiredTemplate	string	Další potřebná volání?
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	AuthorizationHeader[]	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.
requestContent	string	Získá nebo nastaví text požadavku HTTP.
requestVerb	string	Získá nebo nastaví příkaz požadavku HTTP.
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.

DeploymentAttempt

Objekt

Name	Typ	Description
attempt	integer (int32)	Pokus o nasazení
deploymentId	integer (int32)	ID nasazení.
hasStarted	boolean	Určuje, jestli se nasazení spustilo nebo ne.
id	integer (int32)	ID nasazení.
issues	Issue[]	Všechny problémy související s nasazením
lastModifiedBy	IdentityRef	Identita, která toto nasazení naposledy upravila
lastModifiedOn	string (date-time)	Čas poslední změny tohoto nasazení
operationStatus	DeploymentOperationStatus	Stav operace nasazení
postDeploymentGates	ReleaseGates	Brány po nasazení, které se spustily v tomto nasazení.
preDeploymentGates	ReleaseGates	Brány před nasazením, které se spustily v tomto nasazení.
queuedOn	string (date-time)	Když se toto nasazení zařadí do fronty.
reason	DeploymentReason	Důvod nasazení
releaseDeployPhases	ReleaseDeployPhase[]	Seznam nasazených verzí spuštěných v tomto nasazení
requestedBy	IdentityRef	Identita, která požádala o toto nasazení
requestedFor	IdentityRef	Byla požadována identita pro toto nasazení.
status	DeploymentStatus	stav nasazení.

DeploymentJob

Objekt

Name	Typ	Description
job	ReleaseTask	Nadřazený úkol všech spuštěných úkolů
tasks	ReleaseTask[]	Seznam spuštěných úkolů s úlohou

DeploymentOperationStatus

Výčet

Získá stav operace nasazení.

Hodnota	Description
all	Stav operace nasazení je vše.
approved	Stav operace nasazení je schválen.
canceled	Stav operace nasazení se zruší.
cancelling	Stav operace nasazení se ruší.
deferred	Stav operace nasazení je odložen.
evaluatingGates	Stav operace nasazení je VyhodnoceníGates.
gateFailed	Stav operace nasazení je GateFailed.
manualInterventionPending	Stav operace nasazení je čekající na ručníintervention.
pending	Stav operace nasazení čeká na vyřízení.
phaseCanceled	Stav operace nasazení je zrušen.
phaseFailed	Stav operace nasazení je neúspěšný.
phaseInProgress	Stav operace nasazení probíhá ve fázi.
phasePartiallySucceeded	Stav operace nasazení je fáze částečně úspěšná.
phaseSucceeded	Stav operace nasazení je fáze úspěšná.
queued	Stav operace nasazení je zařazen do fronty.
queuedForAgent	Stav operace nasazení se zařadí do fronty pro agenta.
queuedForPipeline	Stav operace nasazení je zařazen do fronty pro kanál.
rejected	Stav operace nasazení se odmítne.
scheduled	Stav operace nasazení je naplánovaný.
undefined	Stav operace nasazení není definován.

DeploymentReason

Výčet

Získá důvod nasazení.

Hodnota	Description
automated	Důvod nasazení je automatizovaný.
manual	Důvod nasazení je ruční.
none	Důvod nasazení není žádný.
redeployTrigger	Důvodem nasazení je RedeployTrigger.
scheduled	Důvod nasazení je naplánovaný.

DeploymentStatus

Výčet

Získá stav nasazení.

Hodnota	Description
all	Stav nasazení je vše.
failed	Stav nasazení se nezdařil.
inProgress	Probíhá stav nasazení.
notDeployed	Stav nasazení není nasazený.
partiallySucceeded	Stav nasazení je částečně spuštěný.
succeeded	Stav nasazení byl úspěšný.
undefined	Stav nasazení není definován.

DeployPhase

Objekt

Name	Typ	Description
name	string	Získá a nastaví název fáze nasazení.
phaseType	DeployPhaseTypes	Označuje typ fáze nasazení.
rank	integer (int32)	Získá a nastaví pořadí fáze nasazení.
refName	string	Získá a nastaví referenční název fáze nasazení.
workflowTasks	WorkflowTask[]	Získá a nastaví úlohy pracovního postupu pro fázi nasazení.

DeployPhaseStatus

Výčet

Stav fáze

Hodnota	Description
canceled	Fáze provádění byla zrušena.
cancelling	Fáze je ve stavu zrušení.
failed	Provedení fáze se nezdařilo.
inProgress	Probíhá provádění fází.
notStarted	Spuštění fáze se nespustilo.
partiallySucceeded	Provedení fáze částečně proběhlo úspěšně.
skipped	Provádění fází se přeskočilo.
succeeded	Provedení fáze bylo úspěšné.
undefined	Stav fáze není nastaven.

DeployPhaseTypes

Výčet

Označuje typ fáze nasazení.

Hodnota	Description
agentBasedDeployment	Typ fáze, který obsahuje úlohy spouštěné v agentu.
deploymentGates	Typ fáze, který obsahuje úkoly, které fungují jako Brány pro nasazení, aby se předalo dál.
machineGroupBasedDeployment	Typ fáze, který obsahuje úlohy prováděné na počítačích skupiny nasazení.
runOnServer	Typ fáze, který obsahuje úkoly spouštěné serverem.
undefined	Typ fáze není definován. Nepoužívejte to.

EnvironmentOptions

Objekt

Name	Typ	Description
autoLinkWorkItems	boolean	Získá a nastaví jako pracovní položky automatického propojení, nebo ne.
badgeEnabled	boolean	Získá a nastaví jako odznáček povolený nebo ne.
publishDeploymentStatus	boolean	Získá a nastaví stav nasazení publikování nebo ne.
pullRequestDeploymentEnabled	boolean	Získá a nastaví jako povolené nasazení žádosti o přijetí změn nebo ne.

EnvironmentStatus

Výčet

Získá stav prostředí.

Hodnota	Description
canceled	Prostředí je v zrušeném stavu.
inProgress	Prostředí je ve stavu průběhu.
notStarted	Prostředí není spuštěno.
partiallySucceeded	Prostředí je v částečně úspěšném stavu.
queued	Prostředí je ve frontě.
rejected	Prostředí je v odmítnutém stavu.
scheduled	Prostředí je v naplánovaném stavu.
succeeded	Prostředí je v úspěšném stavu.
undefined	Stav prostředí není nastavený.

GateStatus

Výčet

Stav bran uvolnění.

Hodnota	Description
canceled	Spuštění brány bylo zrušeno.
failed	Spuštění brány se nezdařilo.
inProgress	Brána právě probíhá.
none	Brána nemá nastavenou stav.
pending	Brána je ve stavu čekání.
succeeded	Brána byla úspěšně dokončena.

IdentityRef

Objekt

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy 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 tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Lze načíst dotazem na stav členství v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

IgnoredGate

Objekt

Name	Typ	Description
lastModifiedOn	string (date-time)	Získá datum, kdy je brána naposledy ignorována.
name	string	Název brány byl ignorován.

Issue

Objekt

Name	Typ	Description
data	object	Vydání dat.
issueType	string	Typ problému, například chyba, upozornění nebo informace.
message	string	Zpráva o problému

ManualIntervention

Objekt

Name	Typ	Description
approver	IdentityRef	Získá nebo nastaví identitu, která by měla schválit.
comments	string	Získá nebo nastaví komentáře ke schválení.
createdOn	string (date-time)	Získá datum, ke kterému se vytvořilo.
id	integer (int32)	Získá jedinečný identifikátor pro ruční zásah.
instructions	string	Získá nebo nastaví pokyny ke schválení.
modifiedOn	string (date-time)	Získá datum, kdy byl změněn.
name	string	Získá nebo nastaví název.
release	ReleaseShallowReference	Získá releaseReference pro ruční zásah.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference pro ruční zásah.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference pro ruční zásah.
status	ManualInterventionStatus	Získá nebo nastaví stav ručního zásahu.
taskInstanceId	string (uuid)	Získejte identifikátor instance úlohy.
url	string	Získá adresu URL pro přístup k ručnímu zásahu.

ManualInterventionStatus

Výčet

Získá nebo nastaví stav ručního zásahu.

Hodnota	Description
approved	Ruční zásah je schválen.
canceled	Ruční zásah se zruší.
pending	Ruční zásah čeká na vyřízení.
rejected	Ruční zásah je odmítnut.
unknown	Ruční zásah nemá nastavenou stav.

ProcessParameters

Objekt

Name	Typ	Description
dataSourceBindings	DataSourceBindingBase[]	Představuje vazbu zdroje dat pro požadavek koncového bodu služby.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Objekt

Name	Typ	Description
id	string (uuid)	Získá jedinečný identifikátor tohoto pole.
name	string	Získá název projektu.

PropertiesCollection

Objekt

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Object) s výjimkou DBNull jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] byl očekáván jako řetězec kódovaný jako base64.

Name	Typ	Description
count	integer (int32)	Počet vlastností v kolekci.
item	object
keys	string[]	Sada klíčů v kolekci.
values	string[]	Sada hodnot v kolekci.

ReferenceLinks

Objekt

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení.

Release

Objekt

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy pro přístup k verzi.
artifacts	Artifact[]	Získá nebo nastaví seznam artefaktů.
comment	string	Získá nebo nastaví komentář.
createdBy	IdentityRef	Získá nebo nastaví identitu, která vytvořila.
createdFor	IdentityRef	Získá nebo nastaví identitu, pro kterou byla vydaná verze vytvořena.
createdOn	string (date-time)	Získá datum, ke kterému se vytvořilo.
definitionSnapshotRevision	integer (int32)	Získá číslo revize snímku definice.
description	string	Získá nebo nastaví popis verze.
environments	ReleaseEnvironment[]	Získá seznam prostředí.
id	integer (int32)	Získá jedinečný identifikátor tohoto pole.
keepForever	boolean	Určuje, jestli se má vyloučit uvolnění ze zásad uchovávání informací.
logsContainerUrl	string	Získá adresu URL kontejneru protokolů.
modifiedBy	IdentityRef	Získá nebo nastaví identitu, která změnila.
modifiedOn	string (date-time)	Získá datum, kdy byl změněn.
name	string	Získá název.
poolName	string	Získá název fondu.
projectReference	ProjectReference	Získá nebo nastaví odkaz na projekt.
properties	PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Hodnoty všech primitivních typů (libovolný typ s `TypeCode != TypeCode.Object`) s výjimkou `DBNull` jsou přijímány. Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají jejich typ, další primitivy jsou přeladěny jako String. Bajt[] byl očekáván jako řetězec kódovaný jako base64.
reason	ReleaseReason	Získá důvod vydání.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference, který určuje odkaz na definici vydané verze, ke které je tato verze přidružena.
releaseDefinitionRevision	integer (int32)	Získá nebo nastaví revizi definice vydané verze.
releaseNameFormat	string	Získá formát názvu verze.
status	ReleaseStatus	Získá stav.
tags	string[]	Získá nebo nastaví seznam značek.
triggeringArtifactAlias	string
variableGroups	VariableGroup[]	Získá seznam skupin proměnných.
variables	<string, ConfigurationVariableValue>	Získá nebo nastaví slovník proměnných.

ReleaseApproval

Objekt

Name	Typ	Description
approvalType	ApprovalType	Získá nebo nastaví typ schválení.
approvedBy	IdentityRef	Získá identitu, která schválila.
approver	IdentityRef	Získá nebo nastaví identitu, která by měla schválit.
attempt	integer (int32)	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 (date-time)	Získá datum, ke kterému se vytvořilo.
history	ReleaseApprovalHistory[]	Získá historii, která určuje všechna schválení přidružená k tomuto schválení.
id	integer (int32)	Získá jedinečný identifikátor tohoto pole.
isAutomated	boolean	Získá nebo nastaví, protože schválení je automatizované nebo ne.
modifiedOn	string (date-time)	Získá datum, kdy byl změněn.
rank	integer (int32)	Získá nebo nastaví pořadí, které určuje pořadí schválení. Například stejné pořadí označuje paralelní schvalování.
release	ReleaseShallowReference	Získá releaseReference, která určuje odkaz na verzi, ke které je toto schválení přidruženo.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference, který určuje odkaz na definici vydané verze, ke které je toto schválení přidruženo.
releaseEnvironment	ReleaseEnvironmentShallowReference	Získá releaseEnvironmentReference, která určuje odkaz na prostředí verze, ke kterému je toto schválení přidruženo.
revision	integer (int32)	Získá číslo revize.
status	ApprovalStatus	Získá nebo nastaví stav schválení.
url	string	Získá adresu URL pro přístup ke schválení.

ReleaseApprovalHistory

Objekt

Name	Typ	Description
approver	IdentityRef	Identita schvalovatele.
changedBy	IdentityRef	Identita objektu, který změnil schválení
comments	string	Komentáře k historii schválení
createdOn	string (date-time)	Čas vytvoření tohoto schválení
modifiedOn	string (date-time)	Čas změny tohoto schválení
revision	integer (int32)	Revize historie schválení

ReleaseCondition

Objekt

Name	Typ	Description
conditionType	ConditionType	Získá nebo nastaví typ podmínky.
name	string	Získá nebo nastaví název podmínky. např. ReleaseStarted.
result	boolean	Výsledek podmínky uvolnění.
value	string	Získá nebo nastaví hodnotu podmínky.

ReleaseDefinitionApprovals

Objekt

Name	Typ	Description
approvalOptions	ApprovalOptions	Získá nebo nastaví možnosti schválení.
approvals	ReleaseDefinitionApprovalStep[]	Získá nebo nastaví schválení.

ReleaseDefinitionApprovalStep

Objekt

Name	Typ	Description
approver	IdentityRef	Získá a nastaví schvalovatele.
id	integer (int32)	ID kroku schválení nebo nasazení
isAutomated	boolean	Určuje, jestli schválení bylo automatizované.
isNotificationOn	boolean	Určuje, jestli je nastaveno oznámení o schválení.
rank	integer (int32)	Získá nebo nastaví pořadí schvalovacího kroku.

ReleaseDefinitionGate

Objekt

Name	Typ	Description
tasks	WorkflowTask[]	Získá nebo nastaví pracovní postup bran.

ReleaseDefinitionGatesOptions

Objekt

Name	Typ	Description
isEnabled	boolean	Získá nebo nastaví jako povolené brány, nebo ne.
minimumSuccessDuration	integer (int32)	Získá nebo nastaví minimální dobu trvání pro stabilní výsledky po úspěšném vyhodnocení bran.
samplingInterval	integer (int32)	Získá nebo nastaví čas mezi opětovným vyhodnocením bran.
stabilizationTime	integer (int32)	Získá nebo nastaví zpoždění před vyhodnocením.
timeout	integer (int32)	Získá nebo nastaví časový limit, po kterém brány selžou.

ReleaseDefinitionGatesStep

Objekt

Name	Typ	Description
gates	ReleaseDefinitionGate[]	Získá nebo nastaví brány.
gatesOptions	ReleaseDefinitionGatesOptions	Získá nebo nastaví možnosti brány.
id	integer (int32)	ID of the ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Objekt

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro definici verze.
id	integer (int32)	Získá jedinečný identifikátor definice vydané verze.
name	string	Získá nebo nastaví název definice vydané verze.
path	string	Získá nebo nastaví cestu definice vydané verze.
projectReference	ProjectReference	Získá nebo nastaví odkaz na projekt.
url	string	Získá adresu URL rozhraní REST API pro přístup k definici vydané verze.

ReleaseDeployPhase

Objekt

Name	Typ	Description
deploymentJobs	DeploymentJob[]	Úlohy nasazení fáze
errorLog	string	Protokoly chyb provádění fází
manualInterventions	ManualIntervention[]	Seznam informací o provádění úkolů ručního zásahu ve fázi
name	string	Název fáze
phaseId	string	ID fáze.
phaseType	DeployPhaseTypes	Typ fáze.
rank	integer (int32)	Pořadí fáze.
runPlanId	string (uuid)	ID plánu spuštění fáze
startedOn	string (date-time)	Čas zahájení fáze
status	DeployPhaseStatus	Stav fáze

ReleaseEnvironment

Objekt

Name	Typ	Description
conditions	ReleaseCondition[]	Získá seznam podmínek.
createdOn	string (date-time)	Získá datum, ke kterému se vytvořilo.
definitionEnvironmentId	integer (int32)	Získá ID prostředí definice.
deployPhasesSnapshot	DeployPhase[]	Získá seznam snímků fází nasazení.
deploySteps	DeploymentAttempt[]	Získá kroky nasazení.
environmentOptions	EnvironmentOptions	Získá možnosti prostředí.
id	integer (int32)	Získá jedinečný identifikátor tohoto pole.
modifiedOn	string (date-time)	Získá datum, kdy byl změněn.
name	string	Získá název.
nextScheduledUtcTime	string (date-time)	Získá příští naplánovaný čas UTC.
owner	IdentityRef	Získá identitu, která je vlastníkem prostředí vydané verze.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Získá seznam snímků schválení po nasazení.
postDeployApprovals	ReleaseApproval[]	Získá seznam schválení po nasazení.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Data snímků bran po nasazení
preApprovalsSnapshot	ReleaseDefinitionApprovals	Získá seznam snímků schválení před nasazením.
preDeployApprovals	ReleaseApproval[]	Získá seznam schválení před nasazením.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Data snímků před nasazením.
processParameters	ProcessParameters	Získá parametry procesu.
rank	integer (int32)	Získá pořadí.
release	ReleaseShallowReference	Získá referenční informace k verzi, která určuje odkaz na verzi, ke které je toto prostředí verze přidruženo.
releaseCreatedBy	IdentityRef	Získá identitu, která vytvořila verzi.
releaseDefinition	ReleaseDefinitionShallowReference	Získá releaseDefinitionReference, který určuje odkaz na definici vydané verze, ke které je toto prostředí verze přidruženo.
releaseId	integer (int32)	Získá ID verze.
scheduledDeploymentTime	string (date-time)	Získá čas nasazení verze prostředí.
schedules	ReleaseSchedule[]	Získá seznam plánů.
status	EnvironmentStatus	Získá stav prostředí.
timeToDeploy	number (double)	Získá čas k nasazení.
triggerReason	string	Získá důvod triggeru.
variableGroups	VariableGroup[]	Získá seznam skupin proměnných.
variables	<string, ConfigurationVariableValue>	Získá slovník proměnných.

ReleaseEnvironmentShallowReference

Objekt

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení pro prostředí vydané verze.
id	integer (int32)	Získá jedinečný identifikátor prostředí verze.
name	string	Získá nebo nastaví název prostředí verze.
url	string	Získá adresu URL rozhraní REST API pro přístup k prostředí verze.

ReleaseGates

Objekt

Name	Typ	Description
deploymentJobs	DeploymentJob[]	Obsahuje podrobnosti o úloze brány každého vyhodnocení.
id	integer (int32)	ID vydaných bran.
ignoredGates	IgnoredGate[]	Seznam ignorovaných bran
lastModifiedOn	string (date-time)	Gates naposledy změnil čas.
runPlanId	string (uuid)	ID plánu spuštění brány
stabilizationCompletedOn	string (date-time)	Stabilizace bran dokončila datum a čas.
startedOn	string (date-time)	Čas zahájení vyhodnocení bran.
status	GateStatus	Stav bran uvolnění.
succeedingSince	string (date-time)	Datum a čas úspěšného spuštění všech bran.

ReleaseReason

Výčet

Získá důvod pro vydání.

Hodnota	Description
continuousIntegration	Označuje verzi aktivovanou kontinuální integrací.
manual	Označuje verzi aktivovanou ručně.
none	Označuje, že se důvod aktivace vydané verze nenastavil.
pullRequest	Označuje verzi aktivovanou žádostí PullRequest.
schedule	Označuje verzi aktivovanou podle plánu.

ReleaseSchedule

Objekt

Name	Typ	Description
daysToRelease	ScheduleDays	Dny v týdnu k vydání.
jobId	string (uuid)	ID úlohy definice team foundation.
scheduleOnlyWithChanges	boolean	Příznak, který určuje, jestli má být tento plán uvolněn pouze v případě změny přidruženého artefaktu nebo změny definice vydané verze.
startHours	integer (int32)	Místní hodina časového pásma, která se má spustit.
startMinutes	integer (int32)	Místní minuta časového pásma, která se má spustit.
timeZoneId	string	ID časového pásma plánu vydání, například UTC.

ReleaseShallowReference

Objekt

Name	Typ	Description
_links	ReferenceLinks	Získá odkazy na související prostředky, rozhraní API a zobrazení vydané verze.
id	integer (int32)	Získá jedinečný identifikátor vydané 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

Výčet

Získá stav.

Hodnota	Description
abandoned	Stav vydané verze je opuštěný.
active	Stav vydání je aktivní.
draft	Verze je ve stavu konceptu.
undefined	Stav vydané verze není nastavený.

ReleaseTask

Objekt

Name	Typ	Description
agentName	string	Název agenta, na kterém se úloha spustila.
finishTime	string (date-time)	Čas dokončení úkolu vydání
id	integer (int32)	ID úlohy vydání.
issues	Issue[]	Při provádění úlohy došlo k problémům.
lineCount	integer (int64)	Početřádkůch
logUrl	string	Adresa URL protokolu úkolu.
name	string	Název úkolu.
percentComplete	integer (int32)	Dokončení provádění úkolu je předem dokončeno.
rank	integer (int32)	Pořadí úkolu vydané verze
resultCode	string	Kód výsledku úkolu.
startTime	string (date-time)	ID úlohy vydání.
status	TaskStatus	Stav úlohy vydání
task	WorkflowTaskReference	Referenční informace k úkolům pracovního postupu
timelineRecordId	string (uuid)	ID záznamu časové osy úkolu vydané verze

ScheduleDays

Výčet

Dny v týdnu k vydání.

Hodnota	Description
all	Naplánováno na všechny dny v týdnu.
friday	Naplánováno v pátek.
monday	Naplánováno v pondělí.
none	Naplánovaný den není nastavený.
saturday	Naplánováno v sobotu.
sunday	Naplánováno v neděli.
thursday	Naplánováno ve čtvrtek.
tuesday	Naplánováno v úterý.
wednesday	Naplánováno ve středu.

SingleReleaseExpands

Výčet

Vlastnost, která by měla být rozšířena ve vydané verzi.

Hodnota	Description
none	Vrátí vlastnosti nejvyšší úrovně objektu.
tasks	Rozbalte vydání s úkoly.

TaskInputDefinitionBase

Objekt

Name	Typ	Description
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

Objekt

Name	Typ	Description
expression	string	Podmíněný výraz
message	string	Zpráva s vysvětlením, jak uživatel může opravit, pokud se ověření nezdaří

TaskSourceDefinitionBase

Objekt

Name	Typ	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TaskStatus

Výčet

Stav úlohy vydání

Hodnota	Description
canceled	Spuštění úkolu bylo zrušeno.
failed	Spuštění úlohy se nezdařilo.
failure	Spuštění úlohy se nezdařilo.
inProgress	Úkol právě probíhá.
partiallySucceeded	Částečně úspěšné spuštění úkolu.
pending	Úkol je ve stavu čekání na vyřízení.
skipped	Provádění úlohy bylo vynecháno.
succeeded	Úkol byl úspěšně dokončen.
success	Úkol byl úspěšně dokončen.
unknown	Úkol nemá nastavenou stav.

VariableGroup

Objekt

Name	Typ	Description
createdBy	IdentityRef	Získá nebo nastaví identitu, která vytvořila.
createdOn	string (date-time)	Získá datum, ke kterému se vytvořilo.
description	string	Získá nebo nastaví popis.
id	integer (int32)	Získá jedinečný identifikátor tohoto pole.
isShared	boolean	Označuje, jestli je skupina proměnných sdílena s jiným projektem nebo ne.
modifiedBy	IdentityRef	Získá nebo nastaví identitu, která změnila.
modifiedOn	string (date-time)	Získá datum, kdy byl změněn.
name	string	Získá nebo nastaví název.
providerData	VariableGroupProviderData	Získá nebo nastaví data zprostředkovatele.
type	string	Získá nebo nastaví typ.
variableGroupProjectReferences	VariableGroupProjectReference[]	všechny odkazy na projekt, kde je skupina proměnných sdílena s jinými projekty.
variables	<string, VariableValue>	Získá a nastaví slovník proměnných.

VariableGroupProjectReference

Objekt

Odkaz na skupinu proměnných je mělký odkaz na skupinu proměnných.

Name	Typ	Description
description	string	Získá nebo nastaví popis skupiny proměnných.
name	string	Získá nebo nastaví název skupiny proměnných.
projectReference	ProjectReference	Získá nebo nastaví odkaz projektu skupiny proměnných.

VariableGroupProviderData

Objekt

VariableValue

Objekt

Name	Typ	Description
isReadOnly	boolean	Získá nebo nastaví, pokud je proměnná jen pro čtení nebo ne.
isSecret	boolean	Získá nebo nastaví, protože proměnná je tajný nebo ne.
value	string	Získá nebo nastaví hodnotu.

WorkflowTask

Objekt

Name	Typ	Description
alwaysRun	boolean	Získá nebo nastaví jako úkol vždy spustit nebo ne.
condition	string	Získá nebo nastaví podmínku úkolu.
continueOnError	boolean	Získá nebo nastaví, protože úloha pokračuje ve spuštění při chybě nebo ne.
definitionType	string	Získá nebo nastaví typ definice úkolu. Příklad:- Agent, DeploymentGroup, Server nebo ServerGate.
enabled	boolean	Získá nebo nastaví jako povolenou úlohu nebo ne.
environment	object	Získá nebo nastaví proměnné prostředí úloh.
inputs	object	Získá nebo nastaví vstupy úkolů.
name	string	Získá nebo nastaví název úkolu.
overrideInputs	object	Získá nebo nastaví přepsat vstupy úkolu.
refName	string	Získá nebo nastaví název odkazu úkolu.
retryCountOnTaskFailure	integer (int32)	Získá nebo nastaví úkol retryCount.
taskId	string (uuid)	Získá nebo nastaví ID úkolu.
timeoutInMinutes	integer (int32)	Získá nebo nastaví časový limit úkolu.
version	string	Získá nebo nastaví verzi úlohy.

WorkflowTaskReference

Objekt

Name	Typ	Description
id	string (uuid)	Identifikátor úkolu.
name	string	Název úkolu.
version	string	Verze úlohy.

Sdílet prostřednictvím

Releases - Get Release

Parametry identifikátoru URI

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

Ukázkový požadavek

Ukázková odpověď

Definice

ApprovalExecutionOrder

ApprovalFilters

ApprovalOptions

ApprovalStatus

ApprovalType

Artifact

ArtifactSourceReference

AuthorizationHeader

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

DeploymentAttempt

DeploymentJob

DeploymentOperationStatus

DeploymentReason

DeploymentStatus

DeployPhase

DeployPhaseStatus

DeployPhaseTypes

EnvironmentOptions

EnvironmentStatus

GateStatus

IdentityRef

IgnoredGate

Issue

ManualIntervention

ManualInterventionStatus

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

Release

ReleaseApproval

ReleaseApprovalHistory

ReleaseCondition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionShallowReference

ReleaseDeployPhase

ReleaseEnvironment

ReleaseEnvironmentShallowReference

ReleaseGates

ReleaseReason

ReleaseSchedule

ReleaseShallowReference

ReleaseStatus

ReleaseTask

ScheduleDays

SingleReleaseExpands

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

TaskStatus

VariableGroup

VariableGroupProjectReference

VariableGroupProviderData

VariableValue

WorkflowTask

WorkflowTaskReference

Další materiály