Sdílet prostřednictvím


Releases - Create

Vytvořte verzi.

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

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

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 nastavená na 7.1-preview.8.

Text požadavku

Name Typ Description
artifacts

ArtifactMetadata[]

Nastaví seznam artefaktů pro vytvoření verze.

definitionId

integer

Nastaví ID definice pro vytvoření verze.

description

string

Nastaví popis pro vytvoření verze.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Nastaví seznam metadat prostředí.

isDraft

boolean

Nastaví hodnotu true tak, aby se vytvořila verze v režimu konceptu, v opačném případě false.

manualEnvironments

string[]

Nastaví seznam prostředí na ruční jako podmínku.

properties

PropertiesCollection

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.

reason

ReleaseReason

Nastaví důvod vytvoření verze.

variables

<string,  ConfigurationVariableValue>

Nastaví seznam proměnných verze, které se mají v době nasazení přepsat.

Odpovědi

Name Typ Description
200 OK

Release

ú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_execute Umožňuje číst a aktualizovat artefakty vydaných verzí, včetně složek, vydaných verzí, definic vydaných verzí a prostředí vydaných verzí, a možnost zařadit novou verzi do fronty.

Příklady

Sample Request

POST https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases?api-version=7.1-preview.8

{
  "definitionId": 1,
  "description": "Creating Sample release",
  "artifacts": [
    {
      "alias": "Fabrikam.CI",
      "instanceReference": {
        "id": "2",
        "name": null
      }
    }
  ],
  "isDraft": false,
  "reason": "none",
  "manualEnvironments": null
}

Sample Response

{
  "id": 19,
  "name": "Release-19",
  "status": "active",
  "createdOn": "2017-06-16T01:53:32.777Z",
  "modifiedOn": "2017-06-16T01:53:32.777Z",
  "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": 73,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": 74,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": 75,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": 76,
      "releaseId": 19,
      "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": 19,
        "name": "Release-19",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
          }
        }
      },
      "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": ""
        },
        "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": ""
        }
      },
      "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/19/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=19&_a=release-summary"
    }
  },
  "tags": [],
  "projectReference": {
    "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
    "name": null
  },
  "properties": {}
}

Definice

Name Description
ApprovalExecutionOrder

Pořadí spuštění schválení.

ApprovalOptions
ApprovalStatus

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

ApprovalType

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

Artifact
ArtifactMetadata
ArtifactSourceReference
AuthorizationHeader
BuildVersion
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 vydaných verzí.

IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus

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

ProcessParameters
ProjectReference
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.Objectvý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.

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
ReleaseStartEnvironmentMetadata
ReleaseStartMetadata
ReleaseStatus

Získá stav.

ReleaseTask
ScheduleDays

Dny v týdnu k vydání.

SourcePullRequestVersion
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

Pořadí spuštění schválení.

Name Typ Description
afterGatesAlways

string

Schválení se zobrazují vždy po spuštění bran.

afterSuccessfulGates

string

Schválení zobrazená po úspěšném spuštění bran.

beforeGates

string

Schválení zobrazená před branami.

ApprovalOptions

Name Typ Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

Určete, zda lze schválení přeskočit, pokud stejný schvalovatel schválil předchozí fázi.

enforceIdentityRevalidation

boolean

Určete, jestli před dokončením schválení znovu ověřte identitu schvalovatele.

executionOrder

ApprovalExecutionOrder

Příkaz spuštění schválení.

releaseCreatorCanBeApprover

boolean

Určete, jestli má uživatel, který žádá o vydání nebo nasazení, povolit schvalovateli.

requiredApproverCount

integer

Počet schválení potřebných k přesunutí verze vpřed. "0" se rozumí všechna potřebná schválení.

timeoutInMinutes

integer

Vypršení časového limitu schválení. Výchozí časový limit schválení je 30 dnů. Maximální povolený časový limit je 365 dnů. "0" znamená výchozí časový limit, tj. 30 dnů.

ApprovalStatus

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

Name Typ Description
approved

string

Označuje, že schválení bylo schváleno.

canceled

string

Označuje, že schválení bylo zrušeno.

pending

string

Označuje, že schválení čeká na vyřízení.

reassigned

string

Označuje, že schválení bylo znovu přiřazeno.

rejected

string

Označuje, že schválení bylo zamítnuto.

skipped

string

Označuje, že se schválení přeskočí.

undefined

string

Označuje, že schválení nemá nastavený stav.

ApprovalType

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

Name Typ Description
all

string

Označuje všechna schválení.

postDeploy

string

Označuje schválení, která byla provedena po nasazení.

preDeploy

string

Označuje schválení, která byla provedena před nasazením.

undefined

string

Označuje, že typ schválení není nastaven.

Artifact

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

Označuje, jestli je artefakt uchována verzí nebo ne.

type

string

Získá nebo nastaví typ. Může mít hodnotu Build, Jenkins, GitHub, NuGet, Team Build (externí), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.

ArtifactMetadata

Name Typ Description
alias

string

Nastaví alias artefaktu.

instanceReference

BuildVersion

Nastaví odkaz na instanci artefaktu. Například pro artefakt sestavení je to číslo sestavení.

ArtifactSourceReference

Name Typ Description
id

string

ID zdroje artefaktů.

name

string

Název zdroje artefaktů.

AuthorizationHeader

Name Typ Description
name

string

value

string

BuildVersion

Name Typ Description
commitMessage

string

Získá nebo nastaví zprávu potvrzení artefaktu.

definitionId

string

Získá nebo nastaví ID definice.

definitionName

string

Získá nebo nastaví název definice.

id

string

Získá nebo nastaví ID sestavení.

isMultiDefinitionType

boolean

Získá nebo nastaví, pokud artefakt podporuje více definic.

name

string

Získá nebo nastaví číslo sestavení.

sourceBranch

string

Získá nebo nastaví zdrojová větev artefaktu.

sourcePullRequestVersion

SourcePullRequestVersion

Získá nebo nastaví verzi zdrojové žádosti o přijetí změn pro artefakt.

sourceRepositoryId

string

Získá nebo nastaví ID úložiště pro artefakt.

sourceRepositoryType

string

Získá nebo nastaví typ úložiště pro artefakt.

sourceVersion

string

Získá nebo nastaví zdroj verzi artefaktu.

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á a nastaví, pokud lze proměnnou v době nasazení přepsat nebo ne.

isSecret

boolean

Získá nebo nastaví, protože proměnná je tajný nebo ne.

value

string

Získá a nastaví hodnotu proměnné konfigurace.

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

Potřebujete 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

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

Name Typ Description
attempt

integer

Pokus o nasazení.

deploymentId

integer

ID nasazení.

hasStarted

boolean

Určuje, jestli se nasazení spustilo, nebo ne.

id

integer

ID nasazení.

issues

Issue[]

Všechny problémy související s nasazením

lastModifiedBy

IdentityRef

Identita, která toto nasazení naposledy upravila

lastModifiedOn

string

Čas, kdy se toto nasazení naposledy změnilo.

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

Když se toto nasazení zařadilo do fronty.

reason

DeploymentReason

Důvod nasazení

releaseDeployPhases

ReleaseDeployPhase[]

Seznam nasazení verzí spuštěných v tomto nasazení

requestedBy

IdentityRef

Identita, která o toto nasazení požádala.

requestedFor

IdentityRef

Identita pro toto nasazení byla požadována.

status

DeploymentStatus

stav nasazení.

DeploymentJob

Name Typ Description
job

ReleaseTask

Nadřazený úkol všech spuštěných úkolů.

tasks

ReleaseTask[]

Seznam spuštěných úkolů v úloze.

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í probíhá postupně.

phasePartiallySucceeded

string

Stav operace nasazení je fáze částečně úspěšná.

phaseSucceeded

string

Stav operace nasazení je fáze úspěšná.

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í probíhá.

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

Získá a nastaví název fáze nasazení.

phaseType

DeployPhaseTypes

Označuje typ fáze nasazení.

rank

integer

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

Stav fáze.

Name Typ Description
canceled

string

Provádění fáze bylo zrušeno.

cancelling

string

Fáze je ve stavu rušení.

failed

string

Spuštění fáze se nezdařilo.

inProgress

string

Probíhá provádění fází.

notStarted

string

Spuštění fáze nebylo zahájeno.

partiallySucceeded

string

Provedení fáze bylo částečně úspěšné.

skipped

string

Provádění fáze se přeskočí.

succeeded

string

Provedení fáze bylo úspěšné.

undefined

string

Stav fáze není nastavený.

DeployPhaseTypes

Označuje typ fáze nasazení.

Name Typ Description
agentBasedDeployment

string

Typ fáze, který obsahuje úlohy spuštěné v agentu.

deploymentGates

string

Typ fáze, který obsahuje úlohy, které fungují jako brány pro nasazení.

machineGroupBasedDeployment

string

Typ fáze, který obsahuje úlohy spouštěné na počítačích se skupinami nasazení.

runOnServer

string

Typ fáze, který obsahuje úlohy spouštěné serverem.

undefined

string

Typ fáze není definován. Tento parametr nepoužívejte.

EnvironmentOptions

Name Typ Description
autoLinkWorkItems

boolean

Získá a nastaví jako auto link workitems nebo ne.

badgeEnabled

boolean

Získá a nastaví jako odznak povolený nebo ne.

publishDeploymentStatus

boolean

Získá a nastaví stav nasazení publikování nebo ne.

pullRequestDeploymentEnabled

boolean

Získá a nastaví jako .pull request nasazení povoleno nebo ne.

EnvironmentStatus

Získá stav prostředí.

Name Typ Description
canceled

string

Prostředí je ve zrušeném stavu.

inProgress

string

Prostředí je v probíhajícím stavu.

notStarted

string

Prostředí je ve stavu nespustilo.

partiallySucceeded

string

Prostředí je v částečně úspěšném stavu.

queued

string

Prostředí je ve stavu fronty.

rejected

string

Prostředí je ve stavu zamítnutí.

scheduled

string

Prostředí je v naplánovaném stavu.

succeeded

string

Prostředí je v úspěšném stavu.

undefined

string

Stav prostředí není nastavený.

GateStatus

Stav bran vydaných verzí.

Name Typ Description
canceled

string

Spuštění brány se zrušilo.

failed

string

Spuštění brány se nezdařilo.

inProgress

string

Brána právě probíhá.

none

string

Brána nemá nastavený stav.

pending

string

Brána je ve stavu čekání.

succeeded

string

Brána se úspěšně dokončila.

IdentityRef

Name Typ Description
_links

ReferenceLinks

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

Zastaralé – Dá se načíst dotazem na uživatele Graphu odkazovaného v položce "self" slovníku IdentityRef "_links"

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

Zastaralé – k dispozici v položce "avatar" ve slovníku IdentityRef "_links"

inactive

boolean

Zastaralé – Můžete ho načíst dotazem na stav členství v Graphu, na který odkazuje položka membershipState slovníku _links GraphUser.

isAadIdentity

boolean

Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Zastaralé – Lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType).

isDeletedInOrigin

boolean

profileUrl

string

Zastaralé – nepoužívá se ve většině dříve existujících implementací ToIdentityRef

uniqueName

string

Zastaralé – místo toho použijte Domain+PrincipalName.

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 je ignorován.

Issue

Name Typ Description
data

object

Vydávkuje data.

issueType

string

Typ problému, například chyba, upozornění nebo informace.

message

string

Zpráva o problému

ManualIntervention

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

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

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

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

DataSourceBindingBase[]

Představuje vazbu zdroje dat pro požadavek koncového bodu služby.

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

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.Objectvý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.

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

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 verze vytvořena.

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

ReleaseEnvironment[]

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

IdentityRef

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

ProjectReference

Získá nebo nastaví odkaz na projekt.

properties

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.Objectvý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.

reason

ReleaseReason

Získá důvod uvolnění.

releaseDefinition

ReleaseDefinitionShallowReference

Získá releaseDefinitionReference určující odkaz na definici verze, ke které je přidružena tato verze.

releaseDefinitionRevision

integer

Získá nebo nastaví revizi definice 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

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

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

ReleaseApprovalHistory[]

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.

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

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 verze, ke které je přidruženo toto schválení.

releaseEnvironment

ReleaseEnvironmentShallowReference

Získá releaseEnvironmentReference, která určuje odkaz prostředí verze, ke kterému je toto schválení přidruženo.

revision

integer

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

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

Čas vytvoření tohoto schválení.

modifiedOn

string

Čas, kdy se toto schválení změnilo.

revision

integer

Revize historie schválení.

ReleaseCondition

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 vydání

value

string

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

ReleaseDefinitionApprovals

Name Typ Description
approvalOptions

ApprovalOptions

Získá nebo nastaví možnosti schválení.

approvals

ReleaseDefinitionApprovalStep[]

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

ReleaseDefinitionApprovalStep

Name Typ Description
approver

IdentityRef

Získá a nastaví schvalovatele.

id

integer

ID kroku schválení nebo nasazení

isAutomated

boolean

Určuje, jestli se schválení automatizovala.

isNotificationOn

boolean

Určuje, jestli je nastaveno oznámení o schválení.

rank

integer

Získá nebo nastaví pořadí kroku schválení.

ReleaseDefinitionGate

Name Typ Description
tasks

WorkflowTask[]

Získá nebo nastaví pracovní postup brány.

ReleaseDefinitionGatesOptions

Name Typ Description
isEnabled

boolean

Získá nebo nastaví jako brány povolené nebo ne.

minimumSuccessDuration

integer

Získá nebo nastaví minimální dobu trvání stabilní výsledky po úspěšném vyhodnocení bran.

samplingInterval

integer

Získá nebo nastaví čas mezi opětovným vyhodnocením bran.

stabilizationTime

integer

Získá nebo nastaví zpoždění před vyhodnocením.

timeout

integer

Získá nebo nastaví časový limit, po jehož uplynutí brány selžou.

ReleaseDefinitionGatesStep

Name Typ Description
gates

ReleaseDefinitionGate[]

Získá nebo nastaví brány.

gatesOptions

ReleaseDefinitionGatesOptions

Získá nebo nastaví možnosti brány.

id

integer

ID of the ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Name Typ Description
_links

ReferenceLinks

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 vydané verze.

path

string

Získá nebo nastaví cestu k definici 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 verze.

ReleaseDeployPhase

Name Typ Description
deploymentJobs

DeploymentJob[]

Úlohy nasazení fáze.

errorLog

string

Protokoly chyb spouštění fází.

manualInterventions

ManualIntervention[]

Seznam informací o provádění úloh 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

Pořadí fáze.

runPlanId

string

ID plánu spuštění fáze

startedOn

string

Čas zahájení fáze.

status

DeployPhaseStatus

Stav fáze.

ReleaseEnvironment

Name Typ Description
conditions

ReleaseCondition[]

Získá seznam podmínek.

createdOn

string

Získá datum, kdy byl vytvořen.

definitionEnvironmentId

integer

Získá ID prostředí definice.

deployPhasesSnapshot

DeployPhase[]

Získá seznam fází nasazení snímek.

deploySteps

DeploymentAttempt[]

Získá kroky nasazení.

environmentOptions

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

IdentityRef

Získá identitu, která je vlastníkem prostředí vydané verze.

postApprovalsSnapshot

ReleaseDefinitionApprovals

Získá snímek seznamu 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 schválení před nasazením snímek.

preDeployApprovals

ReleaseApproval[]

Získá seznam schválení před nasazením.

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Snímková data bran před nasazením.

processParameters

ProcessParameters

Získá parametry procesu.

rank

integer

Získá pořadí.

release

ReleaseShallowReference

Získá odkaz na verzi, která určuje odkaz na verzi, ke které je přidružena tato verze prostředí.

releaseCreatedBy

IdentityRef

Získá identitu, která vytvořila verzi.

releaseDefinition

ReleaseDefinitionShallowReference

Získá releaseDefinitionReference, který určuje odkaz na definici verze, ke které je přidružena tato verze prostředí.

releaseId

integer

Získá ID verze.

scheduledDeploymentTime

string

Získá plán nasazení prostředí vydané verze.

schedules

ReleaseSchedule[]

Získá seznam plánů.

status

EnvironmentStatus

Získá stav prostředí.

timeToDeploy

number

Získá čas na nasazení.

triggerReason

string

Získá důvod aktivační události.

variableGroups

VariableGroup[]

Získá seznam skupin proměnných.

variables

<string,  ConfigurationVariableValue>

Získá slovník proměnných.

ReleaseEnvironmentShallowReference

Name Typ Description
_links

ReferenceLinks

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

DeploymentJob[]

Obsahuje podrobnosti o úloze brány pro každé vyhodnocení.

id

integer

ID bran vydaných verzí.

ignoredGates

IgnoredGate[]

Seznam ignorovaných bran

lastModifiedOn

string

Čas poslední změny brány.

runPlanId

string

ID plánu spuštění bran.

stabilizationCompletedOn

string

Stabilizace hradla dokončeno datum a čas.

startedOn

string

Čas zahájení vyhodnocování bran

status

GateStatus

Stav bran vydaných verzí.

succeedingSince

string

Datum a čas, kdy se všechny brány úspěšně spustily.

ReleaseReason

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

Name Typ Description
continuousIntegration

string

Označuje vydání aktivované kontinuální integrací.

manual

string

Označuje vydání aktivované ručně.

none

string

Označuje důvod aktivace vydané verze, který není nastavený.

pullRequest

string

Označuje vydání aktivované pullRequest.

schedule

string

Označuje vydání aktivované podle plánu.

ReleaseSchedule

Name Typ Description
daysToRelease

ScheduleDays

Dny v týdnu k vydání.

jobId

string

ID úlohy definice team foundation

scheduleOnlyWithChanges

boolean

Příznakem určíte, jestli se má tento plán vydat jenom v případě, že došlo ke změně přidruženého artefaktu nebo změně definice verze.

startHours

integer

Začátek hodiny místního časového pásma

startMinutes

integer

Minuta od 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

ReferenceLinks

Získá odkazy na související prostředky, rozhraní API a zobrazení pro vydání.

id

integer

Získá jedinečný identifikátor vydané verze.

name

string

Získá nebo nastaví název vydané verze.

url

string

Získá adresu URL rozhraní REST API pro přístup k vydané verzi.

ReleaseStartEnvironmentMetadata

Name Typ Description
definitionEnvironmentId

integer

Nastaví ID prostředí definice verze.

variables

<string,  ConfigurationVariableValue>

Nastaví seznam proměnných prostředí, které se mají v době nasazení přepsat.

ReleaseStartMetadata

Name Typ Description
artifacts

ArtifactMetadata[]

Nastaví seznam artefaktů pro vytvoření verze.

definitionId

integer

Nastaví ID definice pro vytvoření verze.

description

string

Nastaví popis pro vytvoření verze.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Nastaví seznam metadat prostředí.

isDraft

boolean

Nastaví hodnotu true pro vytvoření verze v režimu konceptu, jinak false.

manualEnvironments

string[]

Nastaví seznam prostředí na ruční jako podmínku.

properties

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.Objectvý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.

reason

ReleaseReason

Nastaví důvod vytvoření verze.

variables

<string,  ConfigurationVariableValue>

Nastaví seznam proměnných verze, které se mají v době nasazení přepsat.

ReleaseStatus

Získá stav.

Name Typ Description
abandoned

string

Stav vydané verze je v opuštěném stavu.

active

string

Stav vydané verze je aktivní.

draft

string

Verze je ve stavu konceptu.

undefined

string

Stav vydané verze není nastavený.

ReleaseTask

Name Typ Description
agentName

string

Název agenta, na kterém se úloha spustila.

finishTime

string

Čas dokončení úlohy vydané verze.

id

integer

ID úlohy vydané verze.

issues

Issue[]

Seznam problémů, ke kterým došlo při provádění úlohy

lineCount

integer

Počet řádků, které má úloha uvolnění protokolu.

logUrl

string

Adresa URL protokolu úkolu.

name

string

Název úkolu.

percentComplete

integer

Dokončení spuštění úkolu před dokončením.

rank

integer

Pořadí úlohy vydané verze.

resultCode

string

Kód výsledku úkolu.

startTime

string

ID úlohy vydané verze.

status

TaskStatus

Stav úlohy vydání.

task

WorkflowTaskReference

Referenční informace k úkolům pracovního postupu

timelineRecordId

string

ID záznamu časové osy úlohy vydané verze

ScheduleDays

Dny v týdnu k vydání.

Name Typ Description
all

string

Naplánováno na všechny dny v týdnu.

friday

string

Naplánováno na pátek.

monday

string

Naplánováno na pondělí.

none

string

Naplánovaný den není nastavený.

saturday

string

Naplánováno na sobotu.

sunday

string

Naplánováno na neděli.

thursday

string

Naplánováno na čtvrtek.

tuesday

string

Naplánováno na úterý.

wednesday

string

Naplánováno na středu.

SourcePullRequestVersion

Name Typ Description
iterationId

string

ID iterace žádosti o přijetí změn, pro které bude verze publikovat stav.

pullRequestId

string

ID žádosti o přijetí změn, pro které bude verze publikovat stav.

pullRequestMergedAt

string

Datum a čas vytvoření žádosti o přijetí změn. Je nutné uchovávat záznamy o vydáních vytvořených žádostí o přijetí změn na časové ose.

sourceBranch

string

Zdrojová větev žádosti o přijetí změn.

sourceBranchCommitId

string

ID potvrzení zdrojové větve žádosti o přijetí změn, pro kterou bude verze publikovat stav.

targetBranch

string

Cílová větev žádosti o přijetí změn.

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

TaskInputValidation

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

Stav úlohy vydání.

Name Typ Description
canceled

string

Provádění úlohy se zrušilo.

failed

string

Spuštění úlohy se nezdařilo.

failure

string

Spuštění úlohy se nezdařilo.

inProgress

string

Úkol právě probíhá.

partiallySucceeded

string

Provedení úkolu bylo částečně úspěšné.

pending

string

Úkol je ve stavu čekání.

skipped

string

Provádění úlohy se přeskočí.

succeeded

string

Úkol se úspěšně dokončil.

success

string

Úkol se úspěšně dokončil.

unknown

string

Úkol nemá nastavený stav.

VariableGroup

Name Typ Description
createdBy

IdentityRef

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 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

Získá datum, kdy došlo k úpravě.

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

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

VariableValue

Name Typ Description
isReadOnly

boolean

Získá nebo nastaví, pokud proměnná je pouze 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

Name Typ Description
alwaysRun

boolean

Získá nebo nastaví jako úloha vždy spuštěna nebo ne.

condition

string

Získá nebo nastaví podmínku úkolu.

continueOnError

boolean

Získá nebo nastaví, jak úloha pokračuje při spuštění při chybě nebo ne.

definitionType

string

Získá nebo nastaví typ definice úlohy. Příklad: Agent, DeploymentGroup, Server nebo ServerGate.

enabled

boolean

Získá nebo nastaví jako úkol povolený nebo ne.

environment

object

Získá nebo nastaví proměnné prostředí úlohy.

inputs

object

Získá nebo nastaví vstupy úlohy.

name

string

Získá nebo nastaví název úlohy.

overrideInputs

object

Získá nebo nastaví vstupy přepsání úlohy.

refName

string

Získá nebo nastaví název odkazu úkolu.

retryCountOnTaskFailure

integer

Získá nebo nastaví úlohu retryCount.

taskId

string

Získá nebo nastaví ID úlohy.

timeoutInMinutes

integer

Získá nebo nastaví časový limit úkolu.

version

string

Získá nebo nastaví verzi úlohy.

WorkflowTaskReference

Name Typ Description
id

string

Identifikátor úkolu.

name

string

Název úkolu.

version

string

Verze úlohy.