Udostępnij za pośrednictwem


Releases - Create

Utwórz wydanie.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
path True

string

Nazwa organizacji usługi Azure DevOps.

project
path True

string

Identyfikator projektu lub nazwa projektu

api-version
query True

string

Wersja interfejsu API do użycia. Należy ustawić wartość "5.0", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa Typ Opis
artifacts

ArtifactMetadata[]

Ustawia listę artefaktów w celu utworzenia wydania.

definitionId

integer

Ustawia identyfikator definicji w celu utworzenia wydania.

description

string

Ustawia opis, aby utworzyć wydanie.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Zestawy listy metadanych środowisk.

isDraft

boolean

Ustawia wartość "true", aby utworzyć wydanie w trybie roboczym, w przeciwnym razie wartość "false".

manualEnvironments

string[]

Ustawia listę środowisk do ręcznego jako warunku.

properties

PropertiesCollection

Klasa reprezentuje torbę właściwości jako kolekcję par klucz-wartość. Wartości wszystkich typów pierwotnych (dowolnego typu z wartością TypeCode != TypeCode.Object) z wyjątkiem DBNull są 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

Ustawia przyczynę utworzenia wydania.

variables

<string,  ConfigurationVariableValue>

Ustawia listę zmiennych wydania, które mają być zastępowane w czasie wdrażania.

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_execute Daje możliwość odczytywania i aktualizowania artefaktów wydania, w tym wydań, definicji wydania i vrionmentu wydania oraz możliwości kolejkowania nowego wydania.

Przykłady

Sample Request

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

{
  "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://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {
      "self": {
        "href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
      }
    }
  },
  "description": "Creating Sample release",
  "reason": "manual",
  "releaseNameFormat": "Release-$(rev:r)",
  "keepForever": false,
  "definitionSnapshotRevision": 1,
  "logsContainerUrl": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19/logs",
  "url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/19",
  "_links": {
    "self": {
      "href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-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": {}
}

Definicje

Nazwa Opis
ApprovalExecutionOrder
ApprovalOptions
ApprovalStatus

Pobiera lub ustawia stan zatwierdzenia.

ApprovalType

Pobiera lub ustawia typ zatwierdzenia.

Artifact
ArtifactMetadata
ArtifactSourceReference
AuthorizationHeader
BuildVersion
ConditionType

Pobiera lub ustawia typ warunku.

ConfigurationVariableValue
DataSourceBindingBase

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

Demand
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus

Pobiera stan operacji wdrożenia.

DeploymentReason

Pobiera przyczynę wdrożenia.

DeploymentStatus

Pobiera stan wdrożenia.

DeployPhase
DeployPhaseStatus
DeployPhaseTypes
EnvironmentOptions
EnvironmentStatus

Pobiera stan środowiska.

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

Pobiera stan.

ReleaseTask
ScheduleDays

Dni tygodnia do wydania

SourcePullRequestVersion
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus
VariableGroup
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Nazwa Typ Opis
afterGatesAlways

string

afterSuccessfulGates

string

beforeGates

string

ApprovalOptions

Nazwa Typ Opis
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

enforceIdentityRevalidation

boolean

executionOrder

ApprovalExecutionOrder

releaseCreatorCanBeApprover

boolean

requiredApproverCount

integer

timeoutInMinutes

integer

ApprovalStatus

Pobiera lub ustawia stan zatwierdzenia.

Nazwa Typ Opis
approved

string

canceled

string

pending

string

reassigned

string

rejected

string

skipped

string

undefined

string

ApprovalType

Pobiera lub ustawia typ zatwierdzenia.

Nazwa Typ Opis
all

string

postDeploy

string

preDeploy

string

undefined

string

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-fd5b5aa90a6c","name":"myProject""},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}

isPrimary

boolean

Pobiera lub ustawia jako artefakt jest podstawowy lub nie.

isRetained

boolean

type

string

Pobiera lub ustawia typ. Może mieć wartość "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild".

ArtifactMetadata

Nazwa Typ Opis
alias

string

Ustawia alias artefaktu.

instanceReference

BuildVersion

Ustawia odwołanie do wystąpienia artefaktu. np. w przypadku artefaktu kompilacji jest to numer kompilacji.

ArtifactSourceReference

Nazwa Typ Opis
id

string

name

string

AuthorizationHeader

Nazwa Typ Opis
name

string

value

string

BuildVersion

Nazwa Typ Opis
commitMessage

string

definitionId

string

definitionName

string

id

string

isMultiDefinitionType

boolean

name

string

sourceBranch

string

sourcePullRequestVersion

SourcePullRequestVersion

sourceRepositoryId

string

sourceRepositoryType

string

sourceVersion

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 lub ustawia, czy zmienna może być zastępowana w czasie wdrażania, czy nie.

isSecret

boolean

Pobiera lub ustawia jako zmienną jest wpis tajny lub nie.

value

string

Pobiera lub 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.

resultSelector

string

Pobiera lub ustawia selektor wyników.

resultTemplate

string

Pobiera lub ustawia szablon wyników.

target

string

Pobiera lub ustawia element docelowy źródła danych.

Demand

Nazwa Typ Opis
name

string

value

string

DeploymentAttempt

Nazwa Typ Opis
attempt

integer

deploymentId

integer

hasStarted

boolean

Określa, czy wdrożenie zostało uruchomione, czy nie

id

integer

issues

Issue[]

Wszystkie problemy związane z wdrożeniem

job

ReleaseTask

lastModifiedBy

IdentityRef

lastModifiedOn

string

operationStatus

DeploymentOperationStatus

postDeploymentGates

ReleaseGates

preDeploymentGates

ReleaseGates

queuedOn

string

reason

DeploymentReason

releaseDeployPhases

ReleaseDeployPhase[]

requestedBy

IdentityRef

requestedFor

IdentityRef

runPlanId

string

status

DeploymentStatus

tasks

ReleaseTask[]

DeploymentJob

Nazwa Typ Opis
job

ReleaseTask

tasks

ReleaseTask[]

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 wdrożenia to etapowy ruch przychodzący.

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 to ruch przychodzący.

notDeployed

string

Stan wdrożenia nie jest wdrożony.

partiallySucceeded

string

Stan wdrożenia jest częściowo sytuowany.

succeeded

string

Stan wdrożenia zakończył się pomyślnie.

undefined

string

Stan wdrożenia jest niezdefiniowany.

DeployPhase

Nazwa Typ Opis
name

string

phaseType

DeployPhaseTypes

rank

integer

refName

string

workflowTasks

WorkflowTask[]

DeployPhaseStatus

Nazwa Typ Opis
canceled

string

cancelling

string

failed

string

inProgress

string

notStarted

string

partiallySucceeded

string

skipped

string

succeeded

string

undefined

string

DeployPhaseTypes

Nazwa Typ Opis
agentBasedDeployment

string

deploymentGates

string

Typ fazy, który zawiera zadania, które działają jako bramy wdrożenia, aby przejść do przodu.

machineGroupBasedDeployment

string

runOnServer

string

undefined

string

EnvironmentOptions

Nazwa Typ Opis
autoLinkWorkItems

boolean

badgeEnabled

boolean

emailNotificationType

string

emailRecipients

string

enableAccessToken

boolean

publishDeploymentStatus

boolean

pullRequestDeploymentEnabled

boolean

skipArtifactsDownload

boolean

timeoutInMinutes

integer

EnvironmentStatus

Pobiera stan środowiska.

Nazwa Typ Opis
canceled

string

inProgress

string

notStarted

string

partiallySucceeded

string

queued

string

rejected

string

scheduled

string

succeeded

string

undefined

string

GateStatus

Nazwa Typ Opis
canceled

string

failed

string

inProgress

string

none

string

pending

string

succeeded

string

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

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

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

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

issueType

string

message

string

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.

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.

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.

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.

isNotificationOn

boolean

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.

trialNumber

integer

url

string

Pobiera adres URL w celu uzyskania dostępu do zatwierdzenia.

ReleaseApprovalHistory

Nazwa Typ Opis
approver

IdentityRef

changedBy

IdentityRef

comments

string

createdOn

string

modifiedOn

string

revision

integer

ReleaseCondition

Nazwa Typ Opis
conditionType

ConditionType

Pobiera lub ustawia typ warunku.

name

string

Pobiera lub ustawia nazwę warunku. np. "ReleaseStarted".

result

boolean

value

string

Pobiera lub ustawia wartość warunku.

ReleaseDefinitionApprovals

Nazwa Typ Opis
approvalOptions

ApprovalOptions

approvals

ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Nazwa Typ Opis
approver

IdentityRef

id

integer

isAutomated

boolean

isNotificationOn

boolean

rank

integer

ReleaseDefinitionGate

Nazwa Typ Opis
tasks

WorkflowTask[]

ReleaseDefinitionGatesOptions

Nazwa Typ Opis
isEnabled

boolean

minimumSuccessDuration

integer

samplingInterval

integer

stabilizationTime

integer

timeout

integer

ReleaseDefinitionGatesStep

Nazwa Typ Opis
gates

ReleaseDefinitionGate[]

gatesOptions

ReleaseDefinitionGatesOptions

id

integer

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

errorLog

string

id

integer

manualInterventions

ManualIntervention[]

name

string

phaseId

string

phaseType

DeployPhaseTypes

rank

integer

runPlanId

string

startedOn

string

Godzina rozpoczęcia fazy

status

DeployPhaseStatus

ReleaseEnvironment

Nazwa Typ Opis
conditions

ReleaseCondition[]

Pobiera listę warunków.

createdOn

string

Pobiera datę utworzenia.

definitionEnvironmentId

integer

Pobiera identyfikator środowiska definicji.

demands

Demand[]

Pobiera wymagania.

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

preApprovalsSnapshot

ReleaseDefinitionApprovals

Pobiera listę migawek wstępnie wdrożonych zatwierdzeń.

preDeployApprovals

ReleaseApproval[]

Pobiera listę zatwierdzeń wstępnych.

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

processParameters

ProcessParameters

Pobiera parametry procesu.

queueId

integer

Pobiera identyfikator kolejki.

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.

releaseDescription

string

Pobiera opis 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.

workflowTasks

WorkflowTask[]

Pobiera listę zadań przepływu pracy.

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

id

integer

ignoredGates

IgnoredGate[]

lastModifiedOn

string

runPlanId

string

stabilizationCompletedOn

string

startedOn

string

status

GateStatus

succeedingSince

string

ReleaseReason

Pobiera przyczynę wydania.

Nazwa Typ Opis
continuousIntegration

string

manual

string

none

string

pullRequest

string

schedule

string

ReleaseSchedule

Nazwa Typ Opis
daysToRelease

ScheduleDays

Dni tygodnia do wydania

jobId

string

Identyfikator zadania definicji zadania programu Team Foundation

startHours

integer

Godzina lokalnej strefy czasowej do rozpoczęcia

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.

ReleaseStartEnvironmentMetadata

Nazwa Typ Opis
definitionEnvironmentId

integer

Ustawia identyfikator środowiska definicji wydania.

variables

<string,  ConfigurationVariableValue>

Ustawia listę zmiennych środowiskowych, które mają być zastępowane w czasie wdrażania.

ReleaseStartMetadata

Nazwa Typ Opis
artifacts

ArtifactMetadata[]

Ustawia listę artefaktów w celu utworzenia wydania.

definitionId

integer

Ustawia identyfikator definicji, aby utworzyć wydanie.

description

string

Ustawia opis, aby utworzyć wydanie.

environmentsMetadata

ReleaseStartEnvironmentMetadata[]

Ustawia listę metadanych środowisk.

isDraft

boolean

Ustawia wartość "true", aby utworzyć wydanie w trybie roboczym, "false" w przeciwnym razie.

manualEnvironments

string[]

Ustawia listę środowisk do ręcznego jako warunku.

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

Ustawia przyczynę utworzenia wydania.

variables

<string,  ConfigurationVariableValue>

Ustawia listę zmiennych wydania, które mają być zastępowane w czasie wdrażania.

ReleaseStatus

Pobiera stan.

Nazwa Typ Opis
abandoned

string

active

string

draft

string

undefined

string

ReleaseTask

Nazwa Typ Opis
agentName

string

finishTime

string

id

integer

issues

Issue[]

lineCount

integer

logUrl

string

name

string

percentComplete

integer

rank

integer

resultCode

string

startTime

string

status

TaskStatus

task

WorkflowTaskReference

timelineRecordId

string

ScheduleDays

Dni tygodnia do wydania

Nazwa Typ Opis
all

string

friday

string

monday

string

none

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

SourcePullRequestVersion

Nazwa Typ Opis
pullRequestId

string

Identyfikator żądania ściągnięcia, dla którego wydanie będzie publikować stan

pullRequestMergedAt

string

sourceBranchCommitId

string

Identyfikator zatwierdzenia gałęzi źródłowej żądania ściągnięcia, dla którego wydanie będzie publikować stan

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

Nazwa Typ Opis
canceled

string

failed

string

failure

string

inProgress

string

partiallySucceeded

string

pending

string

skipped

string

succeeded

string

success

string

unknown

string

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.

variables

<string,  VariableValue>

VariableGroupProviderData

VariableValue

Nazwa Typ Opis
isSecret

boolean

value

string

WorkflowTask

Nazwa Typ Opis
alwaysRun

boolean

condition

string

continueOnError

boolean

definitionType

string

enabled

boolean

environment

object

inputs

object

name

string

overrideInputs

object

refName

string

taskId

string

timeoutInMinutes

integer

version

string

WorkflowTaskReference

Nazwa Typ Opis
id

string

name

string

version

string