Releases - Get Release

Service:

Release

API Version:

7.1-preview.8

Uzyskiwanie wydania

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
releaseId	path	True	integer int32	Identyfikator wydania.
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.8", aby używać tej wersji interfejsu API.
$expand	query		SingleReleaseExpands	Właściwość, która powinna zostać rozszerzona w wydaniu.
$topGateRecords	query		integer int32	Liczba rekordów bramy wydania do pobrania. Wartość domyślna to 5.
approvalFilters	query		ApprovalFilters	Filtr, który umożliwia selektywne pobieranie kroków zatwierdzania na podstawie tego, czy jest zautomatyzowany, czy ręczny. Pozwoliłoby to również zdecydować, czy należy pobrać migawki przed zatwierdzeniem i po ich opublikowaniu. Zakłada, że domyślnie wszystkie
propertyFilters	query		string array (string)	Rozdzielana przecinkami lista właściwości rozszerzonych do pobrania. W przypadku ustawienia zwrócone wydanie będzie zawierać wartości dla określonych identyfikatorów właściwości (jeśli istnieją). Jeśli nie zostanie ustawiona, właściwości nie zostaną uwzględnione.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Release	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nazwa	Opis
vso.release	Umożliwia odczytywanie artefaktów wydania, w tym folderów, wydań, definicji wydania i środowiska wydania.

Przykłady

Sample Request

HTTP

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

Sample Response

Status code:

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": {}
}

Definicje

Nazwa	Opis
ApprovalExecutionOrder	Kolejność wykonywania zatwierdzeń.
ApprovalFilters	Filtr, który umożliwia selektywne pobieranie kroków zatwierdzania na podstawie tego, czy jest zautomatyzowany, czy ręczny. Pozwoliłoby to również zdecydować, czy należy pobrać migawki przed zatwierdzeniem i po jego opublikowaniu. Zakłada, że domyślnie wszystkie
ApprovalOptions
ApprovalStatus	Pobiera lub ustawia stan zatwierdzenia.
ApprovalType	Pobiera lub ustawia typ zatwierdzenia.
Artifact
ArtifactSourceReference
AuthorizationHeader
ConditionType	Pobiera lub ustawia typ warunku.
ConfigurationVariableValue
DataSourceBindingBase	Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Pobiera stan operacji wdrożenia.
DeploymentReason	Pobiera przyczynę wdrożenia.
DeploymentStatus	Pobiera stan wdrożenia.
DeployPhase
DeployPhaseStatus	Stan fazy.
DeployPhaseTypes	Wskazuje typ fazy wdrożenia.
EnvironmentOptions
EnvironmentStatus	Pobiera stan środowiska.
GateStatus	Stan bram wydania.
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Pobiera lub ustawia stan interwencji ręcznej.
ProcessParameters
ProjectReference
PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason	Pobiera przyczynę wydania.
ReleaseSchedule
ReleaseShallowReference
ReleaseStatus	Pobiera stan.
ReleaseTask
ScheduleDays	Dni tygodnia do wydania.
SingleReleaseExpands	Właściwość, która powinna zostać rozszerzona w wydaniu.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	Stan zadania wydania.
VariableGroup
VariableGroupProjectReference	Odwołanie do grupy zmiennych jest płytkim odwołaniem do grupy zmiennych.
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Kolejność wykonywania zatwierdzeń.

Nazwa	Typ	Opis
afterGatesAlways	string	Zatwierdzenia wyświetlane zawsze po wykonaniu bram.
afterSuccessfulGates	string	Zatwierdzenia wyświetlane po pomyślnym wykonaniu bram.
beforeGates	string	Zatwierdzenia wyświetlane przed bramami.

ApprovalFilters

Filtr, który umożliwia selektywne pobieranie kroków zatwierdzania na podstawie tego, czy jest zautomatyzowany, czy ręczny. Pozwoliłoby to również zdecydować, czy należy pobrać migawki przed zatwierdzeniem i po jego opublikowaniu. Zakłada, że domyślnie wszystkie

Nazwa	Typ	Opis
all	string	Wszystkie kroki zatwierdzania i migawki zatwierdzenia.
approvalSnapshots	string	Nie ma kroków zatwierdzania, ale migawek zatwierdzania (użyj z instrukcjami ManualApprovals lub AutomatedApprovals w celu wykonania kroków zatwierdzania).
automatedApprovals	string	Kroki automatycznego zatwierdzania, ale brak migawek zatwierdzania (użyj z migawkami ApprovalSnapshots).
manualApprovals	string	Kroki zatwierdzania ręcznego, ale nie są migawek zatwierdzania (użyj funkcji ApprovalSnapshots dla migawek).
none	string	Brak zatwierdzeń ani migawek zatwierdzania.

ApprovalOptions

Nazwa	Typ	Opis
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Określ, czy zatwierdzenie można pominąć, jeśli ten sam osoba zatwierdzająca zatwierdziła poprzedni etap.
enforceIdentityRevalidation	boolean	Określ, czy przed ukończeniem zatwierdzenia należy ponownie określić tożsamość osoby zatwierdzającej.
executionOrder	ApprovalExecutionOrder	Kolejność wykonywania zatwierdzeń.
releaseCreatorCanBeApprover	boolean	Określ, czy użytkownik żądający wydania lub wdrożenia powinien zezwalać na zatwierdzanie.
requiredApproverCount	integer	Liczba zatwierdzeń wymaganych do przeniesienia wydania do przodu. "0" oznacza wszystkie wymagane zatwierdzenia.
timeoutInMinutes	integer	Limit czasu zatwierdzania. Domyślny limit czasu zatwierdzania wynosi 30 dni. Maksymalny dozwolony limit czasu wynosi 365 dni. Wartość "0" oznacza domyślny limit czasu, tj. 30 dni.

ApprovalStatus

Pobiera lub ustawia stan zatwierdzenia.

Nazwa	Typ	Opis
approved	string	Wskazuje zatwierdzenie zatwierdzenia.
canceled	string	Wskazuje, że zatwierdzenie zostało anulowane.
pending	string	Wskazuje, że zatwierdzenie oczekuje.
reassigned	string	Wskazuje, że zatwierdzenie zostało ponownie przydzielone.
rejected	string	Wskazuje, że zatwierdzenie zostało odrzucone.
skipped	string	Wskazuje, że zatwierdzenie zostało pominięte.
undefined	string	Wskazuje, że zatwierdzenie nie ma ustawionego stanu.

ApprovalType

Pobiera lub ustawia typ zatwierdzenia.

Nazwa	Typ	Opis
all	string	Wskazuje wszystkie zatwierdzenia.
postDeploy	string	Wskazuje zatwierdzenia wykonywane po wdrożeniu.
preDeploy	string	Wskazuje zatwierdzenia wykonywane przed wdrożeniem.
undefined	string	Wskazuje, że typ zatwierdzenia nie jest ustawiony.

Artifact

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

ArtifactSourceReference

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

AuthorizationHeader

Nazwa	Typ	Opis
name	string
value	string

ConditionType

Pobiera lub ustawia typ warunku.

Nazwa	Typ	Opis
artifact	string	Typ warunku to artefakt.
environmentState	string	Typ warunku to stan środowiska.
event	string	Typ warunku to zdarzenie.
undefined	string	Typ warunku jest niezdefiniowany.

ConfigurationVariableValue

Nazwa	Typ	Opis
allowOverride	boolean	Pobiera i ustawia, czy zmienna może zostać zastąpiona w czasie wdrażania, czy nie.
isSecret	boolean	Pobiera lub ustawia jako zmienną jest wpis tajny lub nie.
value	string	Pobiera i ustawia wartość zmiennej konfiguracji.

DataSourceBindingBase

Reprezentuje powiązanie źródła danych dla żądania punktu końcowego usługi.

Nazwa	Typ	Opis
callbackContextTemplate	string	Format stronicowania obsługiwany przez to źródło danych (ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Potrzebne są kolejne połączenia?
dataSourceName	string	Pobiera lub ustawia nazwę źródła danych.
endpointId	string	Pobiera lub ustawia identyfikator punktu końcowego.
endpointUrl	string	Pobiera lub ustawia adres URL punktu końcowego usługi.
headers	AuthorizationHeader[]	Pobiera lub ustawia nagłówki autoryzacji.
initialContextTemplate	string	Definiuje początkową wartość parametrów zapytania
parameters	object	Pobiera lub ustawia parametry dla źródła danych.
requestContent	string	Pobiera lub ustawia treść żądania HTTP
requestVerb	string	Pobiera lub ustawia czasownik żądania HTTP
resultSelector	string	Pobiera lub ustawia selektor wyników.
resultTemplate	string	Pobiera lub ustawia szablon wyników.
target	string	Pobiera lub ustawia element docelowy źródła danych.

DeploymentAttempt

Nazwa	Typ	Opis
attempt	integer	Próba wdrożenia.
deploymentId	integer	Identyfikator wdrożenia.
hasStarted	boolean	Określa, czy wdrożenie zostało uruchomione, czy nie.
id	integer	Identyfikator wdrożenia.
issues	Issue[]	Wszystkie problemy związane z wdrożeniem.
lastModifiedBy	IdentityRef	Tożsamość, która ostatnio zmodyfikowała to wdrożenie.
lastModifiedOn	string	Czas ostatniej modyfikacji tego wdrożenia.
operationStatus	DeploymentOperationStatus	Stan operacji wdrożenia.
postDeploymentGates	ReleaseGates	Po wdrożeniu bramy wykonane w tym wdrożeniu.
preDeploymentGates	ReleaseGates	Bramy przed wdrożeniem wykonywane w tym wdrożeniu.
queuedOn	string	Gdy to wdrożenie zostanie w kolejce.
reason	DeploymentReason	Przyczyna wdrożenia.
releaseDeployPhases	ReleaseDeployPhase[]	Lista wdrożeń wersji wykonanych w tym wdrożeniu.
requestedBy	IdentityRef	Tożsamość, która zażądała tego wdrożenia.
requestedFor	IdentityRef	Zażądano tożsamości dla tego wdrożenia.
status	DeploymentStatus	stan wdrożenia.

DeploymentJob

Nazwa	Typ	Opis
job	ReleaseTask	Nadrzędne zadanie wszystkich wykonanych zadań.
tasks	ReleaseTask[]	Lista wykonanych zadań w zadaniu.

DeploymentOperationStatus

Pobiera stan operacji wdrożenia.

Nazwa	Typ	Opis
all	string	Stan operacji wdrażania to wszystko.
approved	string	Stan operacji wdrażania jest zatwierdzony.
canceled	string	Stan operacji wdrażania jest anulowany.
cancelling	string	Stan operacji wdrażania jest anulowany.
deferred	string	Stan operacji wdrażania jest odroczony.
evaluatingGates	string	Stan operacji wdrażania to EvaluatingGates.
gateFailed	string	Stan operacji wdrożenia to GateFailed.
manualInterventionPending	string	Stan operacji wdrożenia to oczekiwanie na ręczne wymyślanie.
pending	string	Stan operacji wdrożenia jest oczekujący.
phaseCanceled	string	Stan operacji wdrożenia jest anulowany.
phaseFailed	string	Stan operacji wdrażania nie powiodło się.
phaseInProgress	string	Stan operacji wdrażania jest w toku.
phasePartiallySucceeded	string	Stan operacji wdrożenia jest częściowo zakończony powodzeniem.
phaseSucceeded	string	Stan operacji wdrożenia zakończył się pomyślnie.
queued	string	Stan operacji wdrażania jest w kolejce.
queuedForAgent	string	Stan operacji wdrażania jest ustawiany w kolejce dla agenta.
queuedForPipeline	string	Stan operacji wdrażania jest ustawiany w kolejce dla potoku.
rejected	string	Stan operacji wdrażania jest odrzucany.
scheduled	string	Zaplanowano stan operacji wdrażania.
undefined	string	Stan operacji wdrażania jest niezdefiniowany.

DeploymentReason

Pobiera przyczynę wdrożenia.

Nazwa	Typ	Opis
automated	string	Przyczyna wdrożenia jest zautomatyzowana.
manual	string	Przyczyną wdrożenia jest ręczne.
none	string	Przyczyna wdrożenia nie jest żadna.
redeployTrigger	string	Przyczyną wdrożenia jest ponowne wdrożenieTrigger.
scheduled	string	Przyczyna wdrożenia jest zaplanowana.

DeploymentStatus

Pobiera stan wdrożenia.

Nazwa	Typ	Opis
all	string	Stan wdrożenia to wszystko.
failed	string	Stan wdrożenia nie powiódł się.
inProgress	string	Stan wdrożenia jest w toku.
notDeployed	string	Stan wdrożenia nie jest wdrożony.
partiallySucceeded	string	Stan wdrożenia jest częściowo zaplanowany.
succeeded	string	Stan wdrożenia zakończył się pomyślnie.
undefined	string	Stan wdrożenia jest niezdefiniowany.

DeployPhase

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

DeployPhaseStatus

Stan fazy.

Nazwa	Typ	Opis
canceled	string	Anulowano wykonywanie fazy.
cancelling	string	Faza jest w stanie anulowania.
failed	string	Wykonanie fazy nie powiodło się.
inProgress	string	Wykonywanie fazy w toku.
notStarted	string	Nie rozpoczęto wykonywania fazy.
partiallySucceeded	string	Wykonanie fazy zakończyło się częściowo pomyślnie.
skipped	string	Pominięto wykonywanie fazy.
succeeded	string	Wykonanie fazy powiodło się.
undefined	string	Nie ustawiono stanu fazy.

DeployPhaseTypes

Wskazuje typ fazy wdrożenia.

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

EnvironmentOptions

Nazwa	Typ	Opis
autoLinkWorkItems	boolean	Pobiera i ustawia jako element roboczy linku automatycznego lub nie.
badgeEnabled	boolean	Pobiera i ustawia jako wskaźnik włączony lub nie.
publishDeploymentStatus	boolean	Pobiera i ustawia jako stan wdrożenia publikowania lub nie.
pullRequestDeploymentEnabled	boolean	Pobiera i ustawia jako wdrożenie żądania ściągnięcia włączone lub nie.

EnvironmentStatus

Pobiera stan środowiska.

Nazwa	Typ	Opis
canceled	string	Środowisko jest w stanie anulowania.
inProgress	string	Środowisko jest w stanie postępu.
notStarted	string	Środowisko nie jest w stanie uruchomienia.
partiallySucceeded	string	Środowisko jest w stanie częściowo zakończonym powodzeniem.
queued	string	Środowisko jest w stanie kolejki.
rejected	string	Środowisko jest w stanie odrzuconym.
scheduled	string	Środowisko jest w stanie zaplanowanym.
succeeded	string	Środowisko jest w stanie powodzenia.
undefined	string	Stan środowiska nie jest ustawiony.

GateStatus

Stan bram wydania.

Nazwa	Typ	Opis
canceled	string	Wykonanie bramy zostało anulowane.
failed	string	Wykonanie bramy nie powiodło się.
inProgress	string	Brama jest obecnie w toku.
none	string	Brama nie ma ustawionego stanu.
pending	string	Brama jest w stanie oczekiwania.
succeeded	string	Brama została pomyślnie ukończona.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można pobrać, wysyłając zapytanie do użytkownika programu Graph przywoływanego w wpisie "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne w wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wysyłając zapytanie do stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji toIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

IgnoredGate

Nazwa	Typ	Opis
lastModifiedOn	string	Pobiera datę ostatniego ignorowania bramy.
name	string	Nazwa bramy ignorowana.

Issue

Nazwa	Typ	Opis
data	object	Dane dotyczące problemu.
issueType	string	Typ problemu, na przykład błąd, ostrzeżenie lub informacje.
message	string	Komunikat o problemie.

ManualIntervention

Nazwa	Typ	Opis
approver	IdentityRef	Pobiera lub ustawia tożsamość, która powinna zostać zatwierdzana.
comments	string	Pobiera lub ustawia komentarze do zatwierdzenia.
createdOn	string	Pobiera datę utworzenia.
id	integer	Pobiera unikatowy identyfikator interwencji ręcznej.
instructions	string	Pobiera lub ustawia instrukcje dotyczące zatwierdzenia.
modifiedOn	string	Pobiera datę modyfikacji.
name	string	Pobiera lub ustawia nazwę.
release	ReleaseShallowReference	Pobiera odwołanie releaseReference na potrzeby interwencji ręcznej.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera instrukcję releaseDefinitionReference na potrzeby interwencji ręcznej.
releaseEnvironment	ReleaseEnvironmentShallowReference	Pobiera zwolnienieEnvironmentReference dla interwencji ręcznej.
status	ManualInterventionStatus	Pobiera lub ustawia stan interwencji ręcznej.
taskInstanceId	string	Pobierz identyfikator wystąpienia zadania.
url	string	Pobiera adres URL w celu uzyskania dostępu do interwencji ręcznej.

ManualInterventionStatus

Pobiera lub ustawia stan interwencji ręcznej.

Nazwa	Typ	Opis
approved	string	Interwencja ręczna jest zatwierdzana.
canceled	string	Interwencja ręczna zostanie anulowana.
pending	string	Ręczna interwencja jest w toku.
rejected	string	Interwencja ręczna jest odrzucana.
unknown	string	Interwencja ręczna nie ma ustawionego stanu.

ProcessParameters

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

ProjectReference

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

PropertiesCollection

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

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

ReferenceLinks

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

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

Release

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki umożliwiające uzyskanie dostępu do wersji.
artifacts	Artifact[]	Pobiera lub ustawia listę artefaktów.
comment	string	Pobiera lub ustawia komentarz.
createdBy	IdentityRef	Pobiera lub ustawia tożsamość, która została utworzona.
createdFor	IdentityRef	Pobiera lub ustawia tożsamość, dla której utworzono wydanie.
createdOn	string	Pobiera datę utworzenia.
definitionSnapshotRevision	integer	Pobiera numer poprawki migawki definicji.
description	string	Pobiera lub ustawia opis wydania.
environments	ReleaseEnvironment[]	Pobiera listę środowisk.
id	integer	Pobiera unikatowy identyfikator tego pola.
keepForever	boolean	Czy wykluczyć wydanie z zasad przechowywania.
logsContainerUrl	string	Pobiera adres URL kontenera dzienników.
modifiedBy	IdentityRef	Pobiera lub ustawia tożsamość, która została zmodyfikowana.
modifiedOn	string	Pobiera datę, w której został zmodyfikowany.
name	string	Pobiera nazwę.
poolName	string	Pobiera nazwę puli.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu.
properties	PropertiesCollection	Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolny typ z ) TypeCode != TypeCode.Objectz wyjątkiem są DBNull akceptowane. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są dostrojone jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.
reason	ReleaseReason	Pobiera przyczynę wydania.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera releaseDefinitionReference, która określa odwołanie do definicji wydania, do której jest skojarzona ta wersja.
releaseDefinitionRevision	integer	Pobiera lub ustawia poprawkę definicji wydania.
releaseNameFormat	string	Pobiera format nazwy wydania.
status	ReleaseStatus	Pobiera stan.
tags	string[]	Pobiera lub ustawia listę tagów.
triggeringArtifactAlias	string
variableGroups	VariableGroup[]	Pobiera listę grup zmiennych.
variables	<string,  ConfigurationVariableValue>	Pobiera lub ustawia słownik zmiennych.

ReleaseApproval

Nazwa	Typ	Opis
approvalType	ApprovalType	Pobiera lub ustawia typ zatwierdzenia.
approvedBy	IdentityRef	Pobiera tożsamość, która zatwierdziła.
approver	IdentityRef	Pobiera lub ustawia tożsamość, która powinna zostać zatwierdzana.
attempt	integer	Pobiera lub ustawia próbę, która określa, do której próby wdrożenia należy.
comments	string	Pobiera lub ustawia komentarze do zatwierdzenia.
createdOn	string	Pobiera datę utworzenia.
history	ReleaseApprovalHistory[]	Pobiera historię określającą wszystkie zatwierdzenia skojarzone z tym zatwierdzeniem.
id	integer	Pobiera unikatowy identyfikator tego pola.
isAutomated	boolean	Pobiera lub ustawia jako zatwierdzenie jest zautomatyzowane lub nie.
modifiedOn	string	Pobiera datę, w której został zmodyfikowany.
rank	integer	Pobiera lub ustawia rangę określającą kolejność zatwierdzenia. np. Ta sama ranga oznacza zatwierdzenie równoległe.
release	ReleaseShallowReference	Pobiera wartość releaseReference, która określa odwołanie do wydania, do którego jest skojarzone to zatwierdzenie.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera releaseDefinitionReference, która określa odwołanie do definicji wydania, do której jest skojarzone to zatwierdzenie.
releaseEnvironment	ReleaseEnvironmentShallowReference	Pobiera releaseEnvironmentReference, który określa odwołanie do środowiska wydania, do którego jest skojarzone to zatwierdzenie.
revision	integer	Pobiera numer poprawki.
status	ApprovalStatus	Pobiera lub ustawia stan zatwierdzenia.
url	string	Pobiera adres URL w celu uzyskania dostępu do zatwierdzenia.

ReleaseApprovalHistory

Nazwa	Typ	Opis
approver	IdentityRef	Tożsamość osoby zatwierdzającej.
changedBy	IdentityRef	Tożsamość obiektu, który zmienił zatwierdzenie.
comments	string	Komentarze historii zatwierdzania.
createdOn	string	Godzina utworzenia tego zatwierdzenia.
modifiedOn	string	Godzina modyfikacji tego zatwierdzenia.
revision	integer	Poprawka historii zatwierdzania.

ReleaseCondition

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

ReleaseDefinitionApprovals

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

ReleaseDefinitionApprovalStep

Nazwa	Typ	Opis
approver	IdentityRef	Pobiera i ustawia osoba zatwierdzająca.
id	integer	Identyfikator kroku zatwierdzania lub wdrażania.
isAutomated	boolean	Wskazuje, czy zatwierdzenie jest zautomatyzowane.
isNotificationOn	boolean	Wskazuje, czy zestaw powiadomień o zatwierdzeniu.
rank	integer	Pobiera lub ustawia rangę kroku zatwierdzania.

ReleaseDefinitionGate

Nazwa	Typ	Opis
tasks	WorkflowTask[]	Pobiera lub ustawia przepływ pracy bram.

ReleaseDefinitionGatesOptions

Nazwa	Typ	Opis
isEnabled	boolean	Pobiera lub ustawia jako bramy włączone lub nie.
minimumSuccessDuration	integer	Pobiera lub ustawia minimalny czas trwania dla stałych wyników po pomyślnej ocenie bram.
samplingInterval	integer	Pobiera lub ustawia czas między ponowną oceną bram.
stabilizationTime	integer	Pobiera lub ustawia opóźnienie przed oceną.
timeout	integer	Pobiera lub ustawia limit czasu, po którym bramy kończą się niepowodzeniem.

ReleaseDefinitionGatesStep

Nazwa	Typ	Opis
gates	ReleaseDefinitionGate[]	Pobiera lub ustawia bramy.
gatesOptions	ReleaseDefinitionGatesOptions	Pobiera lub ustawia opcje bramy.
id	integer	Identyfikator elementu ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków definicji wydania.
id	integer	Pobiera unikatowy identyfikator definicji wydania.
name	string	Pobiera lub ustawia nazwę definicji wydania.
path	string	Pobiera lub ustawia ścieżkę definicji wydania.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do definicji wydania.

ReleaseDeployPhase

Nazwa	Typ	Opis
deploymentJobs	DeploymentJob[]	Zadania wdrażania fazy.
errorLog	string	Dzienniki błędów wykonywania fazy.
manualInterventions	ManualIntervention[]	Lista informacji o wykonywaniu zadań interwencji ręcznej w fazie.
name	string	Nazwa fazy.
phaseId	string	Identyfikator fazy.
phaseType	DeployPhaseTypes	Typ fazy.
rank	integer	Ranga fazy.
runPlanId	string	Uruchom identyfikator planu fazy.
startedOn	string	Godzina rozpoczęcia fazy.
status	DeployPhaseStatus	Stan fazy.

ReleaseEnvironment

Nazwa	Typ	Opis
conditions	ReleaseCondition[]	Pobiera listę warunków.
createdOn	string	Pobiera datę utworzenia.
definitionEnvironmentId	integer	Pobiera identyfikator środowiska definicji.
deployPhasesSnapshot	DeployPhase[]	Pobiera listę migawek faz wdrażania.
deploySteps	DeploymentAttempt[]	Pobiera kroki wdrażania.
environmentOptions	EnvironmentOptions	Pobiera opcje środowiska.
id	integer	Pobiera unikatowy identyfikator tego pola.
modifiedOn	string	Pobiera datę, w której został zmodyfikowany.
name	string	Pobiera nazwę.
nextScheduledUtcTime	string	Pobiera następny zaplanowany czas UTC.
owner	IdentityRef	Pobiera tożsamość, która jest właścicielem środowiska wydania.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Pobiera listę migawek po wdrożeniu zatwierdzeń.
postDeployApprovals	ReleaseApproval[]	Pobiera listę zatwierdzeń po wdrożeniu.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Po wdrożeniu bramy migawki danych.
preApprovalsSnapshot	ReleaseDefinitionApprovals	Pobiera listę migawek wstępnie wdrożonych zatwierdzeń.
preDeployApprovals	ReleaseApproval[]	Pobiera listę zatwierdzeń wstępnych.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Dane migawek bram przed wdrożeniem.
processParameters	ProcessParameters	Pobiera parametry procesu.
rank	integer	Pobiera rangę.
release	ReleaseShallowReference	Pobiera odwołanie do wydania, które określa odwołanie do wydania, do którego jest skojarzone to środowisko wydania.
releaseCreatedBy	IdentityRef	Pobiera tożsamość, która utworzyła wydanie.
releaseDefinition	ReleaseDefinitionShallowReference	Pobiera releaseDefinitionReference, która określa odwołanie do definicji wydania, z którą jest skojarzone to środowisko wydania.
releaseId	integer	Pobiera identyfikator wydania.
scheduledDeploymentTime	string	Pobiera zaplanowany czas wdrożenia środowiska wydania.
schedules	ReleaseSchedule[]	Pobiera listę harmonogramów.
status	EnvironmentStatus	Pobiera stan środowiska.
timeToDeploy	number	Pobiera czas na wdrożenie.
triggerReason	string	Pobiera przyczynę wyzwalacza.
variableGroups	VariableGroup[]	Pobiera listę grup zmiennych.
variables	<string,  ConfigurationVariableValue>	Pobiera słownik zmiennych.

ReleaseEnvironmentShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków środowiska wydania.
id	integer	Pobiera unikatowy identyfikator środowiska wydania.
name	string	Pobiera lub ustawia nazwę środowiska wydania.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do środowiska wydania.

ReleaseGates

Nazwa	Typ	Opis
deploymentJobs	DeploymentJob[]	Zawiera szczegóły zadania bram dla każdej oceny.
id	integer	Identyfikator bram wydania.
ignoredGates	IgnoredGate[]	Lista ignorowanych bram.
lastModifiedOn	string	Czas ostatniej modyfikacji bram.
runPlanId	string	Uruchom identyfikator planu bram.
stabilizationCompletedOn	string	Stabilizacja bram zakończyła datę i godzinę.
startedOn	string	Czas rozpoczęcia oceny bram.
status	GateStatus	Stan bram wydania.
succeedingSince	string	Data i godzina pomyślnego wykonania wszystkich bram.

ReleaseReason

Pobiera przyczynę wydania.

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

ReleaseSchedule

Nazwa	Typ	Opis
daysToRelease	ScheduleDays	Dni tygodnia do wydania.
jobId	string	Identyfikator zadania definicji zadania programu Team Foundation.
scheduleOnlyWithChanges	boolean	Flaga określająca, czy ten harmonogram powinien zostać zwolniony tylko wtedy, gdy skojarzony artefakt został zmieniony lub zmieniono definicję wydania.
startHours	integer	Godzina lokalnej strefy czasowej, która ma być uruchomiona.
startMinutes	integer	Godzina rozpoczęcia lokalnej strefy czasowej.
timeZoneId	string	Identyfikator strefy czasowej harmonogramu wydania, taki jak "UTC".

ReleaseShallowReference

Nazwa	Typ	Opis
_links	ReferenceLinks	Pobiera linki do powiązanych zasobów, interfejsów API i widoków dla wydania.
id	integer	Pobiera unikatowy identyfikator wydania.
name	string	Pobiera lub ustawia nazwę wydania.
url	string	Pobiera adres URL interfejsu API REST w celu uzyskania dostępu do wersji.

ReleaseStatus

Pobiera stan.

Nazwa	Typ	Opis
abandoned	string	Stan wydania jest porzucany.
active	string	Stan wydania jest aktywny.
draft	string	Wydanie jest w stanie wersji roboczej.
undefined	string	Stan wydania nie jest ustawiony.

ReleaseTask

Nazwa	Typ	Opis
agentName	string	Nazwa agenta, na którym wykonano zadanie.
finishTime	string	Godzina zakończenia zadania wydania.
id	integer	Identyfikator zadania wydania.
issues	Issue[]	Lista problemów wystąpiła podczas wykonywania zadania.
lineCount	integer	Liczba wierszy zadania zwolnienia dziennika.
logUrl	string	Adres URL dziennika zadania.
name	string	Nazwa zadania.
percentComplete	integer	Zakończenie wykonywania zadania.
rank	integer	Ranga zadania wydania.
resultCode	string	Kod wyniku zadania.
startTime	string	Identyfikator zadania wydania.
status	TaskStatus	Stan zadania wydania.
task	WorkflowTaskReference	Dokumentacja zadania przepływu pracy.
timelineRecordId	string	Identyfikator rekordu osi czasu zadania wydania.

ScheduleDays

Dni tygodnia do wydania.

Nazwa	Typ	Opis
all	string	Zaplanowane na wszystkie dni w tygodniu.
friday	string	Zaplanowane w piątek.
monday	string	Zaplanowane w poniedziałek.
none	string	Nie ustawiono zaplanowanego dnia.
saturday	string	Zaplanowane w sobotę.
sunday	string	Zaplanowane w niedzielę.
thursday	string	Zaplanowane w czwartek.
tuesday	string	Zaplanowane we wtorek.
wednesday	string	Zaplanowane w środę.

SingleReleaseExpands

Właściwość, która powinna zostać rozszerzona w wydaniu.

Nazwa	Typ	Opis
none	string	Zwraca właściwości najwyższego poziomu obiektu.
tasks	string	Rozwiń węzeł release z zadaniami.

TaskInputDefinitionBase

Nazwa	Typ	Opis
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

Nazwa	Typ	Opis
expression	string	Wyrażenie warunkowe
message	string	Komunikat wyjaśniający, jak użytkownik może poprawić, jeśli walidacja nie powiedzie się

TaskSourceDefinitionBase

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

TaskStatus

Stan zadania wydania.

Nazwa	Typ	Opis
canceled	string	Wykonanie zadania zostało anulowane.
failed	string	Wykonanie zadania nie powiodło się.
failure	string	Wykonanie zadania nie powiodło się.
inProgress	string	Zadanie jest obecnie w toku.
partiallySucceeded	string	Wykonanie zadania zakończyło się częściowo pomyślnie.
pending	string	Zadanie jest w stanie oczekiwania.
skipped	string	Wykonanie zadania zostało pominięte.
succeeded	string	Zadanie zostało ukończone pomyślnie.
success	string	Zadanie zostało ukończone pomyślnie.
unknown	string	Zadanie nie ma ustawionego stanu.

VariableGroup

Nazwa	Typ	Opis
createdBy	IdentityRef	Pobiera lub ustawia tożsamość, która została utworzona.
createdOn	string	Pobiera datę utworzenia.
description	string	Pobiera lub ustawia opis.
id	integer	Pobiera unikatowy identyfikator tego pola.
isShared	boolean	Określa, czy grupa zmiennych jest współużytkowana z innym projektem, czy nie.
modifiedBy	IdentityRef	Pobiera lub ustawia tożsamość, która została zmodyfikowana.
modifiedOn	string	Pobiera datę, w której został zmodyfikowany.
name	string	Pobiera lub ustawia nazwę.
providerData	VariableGroupProviderData	Pobiera lub ustawia dane dostawcy.
type	string	Pobiera lub ustawia typ.
variableGroupProjectReferences	VariableGroupProjectReference[]	wszystkie odwołania do projektu, w których grupa zmiennych jest współużytkowana z innymi projektami.
variables	<string,  VariableValue>	Pobiera i ustawia słownik zmiennych.

VariableGroupProjectReference

Odwołanie do grupy zmiennych jest płytkim odwołaniem do grupy zmiennych.

Nazwa	Typ	Opis
description	string	Pobiera lub ustawia opis grupy zmiennych.
name	string	Pobiera lub ustawia nazwę grupy zmiennych.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu dla grupy zmiennych.

VariableGroupProviderData

VariableValue

Nazwa	Typ	Opis
isReadOnly	boolean	Pobiera lub ustawia, jeśli zmienna jest tylko do odczytu, czy nie.
isSecret	boolean	Pobiera lub ustawia jako zmienną wpis tajny lub nie.
value	string	Pobiera lub ustawia wartość.

WorkflowTask

Nazwa	Typ	Opis
alwaysRun	boolean	Pobiera lub ustawia jako zadanie zawsze uruchamiane lub nie.
condition	string	Pobiera lub ustawia warunek zadania.
continueOnError	boolean	Pobiera lub ustawia jako zadanie kontynuowane w przypadku błędu lub nie.
definitionType	string	Pobiera lub ustawia typ definicji zadania. Przykład: "Agent", DeploymentGroup", "Server" lub "ServerGate".
enabled	boolean	Pobiera lub ustawia jako zadanie włączone lub nie.
environment	object	Pobiera lub ustawia zmienne środowiskowe zadania.
inputs	object	Pobiera lub ustawia dane wejściowe zadania.
name	string	Pobiera lub ustawia nazwę zadania.
overrideInputs	object	Pobiera lub ustawia dane wejściowe zastępowania zadań.
refName	string	Pobiera lub ustawia nazwę odwołania zadania.
retryCountOnTaskFailure	integer	Pobiera lub ustawia zadanie retryCount.
taskId	string	Pobiera lub ustawia identyfikator zadania.
timeoutInMinutes	integer	Pobiera lub ustawia limit czasu zadania.
version	string	Pobiera lub ustawia wersję zadania.

WorkflowTaskReference

Nazwa	Typ	Opis
id	string	Identyfikator zadania.
name	string	Nazwa zadania.
version	string	Wersja zadania.