Udostępnij za pośrednictwem


Releases - Update Release

Aktualizowanie kompletnego obiektu wydania.

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

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 do aktualizacji.

api-version
query True

string

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

Treść żądania

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 utworzyła.

createdFor

IdentityRef

Pobiera lub ustawia tożsamość, dla której utworzono wydanie.

createdOn

string (date-time)

Pobiera datę utworzenia.

definitionSnapshotRevision

integer (int32)

Pobiera numer poprawki migawki definicji.

description

string

Pobiera lub ustawia opis wydania.

environments

ReleaseEnvironment[]

Pobiera listę środowisk.

id

integer (int32)

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 (date-time)

Pobiera datę modyfikacji.

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ść. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z TypeCode != TypeCode.Object), z wyjątkiem DBNull. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.

reason

ReleaseReason

Pobiera przyczynę wydania.

releaseDefinition

ReleaseDefinitionShallowReference

Pobiera wartość releaseDefinitionReference, która określa odwołanie do definicji wydania, z którą jest skojarzona ta wersja.

releaseDefinitionRevision

integer (int32)

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.

Odpowiedzi

Nazwa Typ Opis
200 OK

Release

operacja zakończona powodzeniem

Zabezpieczenia

oauth2

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

Zakresy

Nazwa Opis
vso.release_execute Umożliwia odczytywanie i aktualizowanie artefaktów wydania, w tym folderów, wydań, definicji wydania i środowiska wydania oraz możliwość kolejkowania nowej wersji.

Przykłady

Update the release

Przykładowe żądanie

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

{
  "id": 39,
  "name": "Release-1",
  "status": "active",
  "createdOn": "2018-12-10T12:43:34.223Z",
  "modifiedOn": "2018-12-10T12:43:34.223Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "environments": [
    {
      "id": 39,
      "releaseId": 39,
      "name": "PROD",
      "status": "notStarted",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 0
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 1,
      "definitionEnvironmentId": 21,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 0,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "schedules": [],
      "release": {
        "id": 39,
        "name": "Release-1",
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
          }
        }
      },
      "releaseDefinition": {
        "id": 21,
        "name": "Fabrikam-web",
        "path": "\\",
        "projectReference": null,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
          }
        }
      },
      "releaseCreatedBy": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "triggerReason": "Manual",
      "preDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      }
    }
  ],
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    },
    "System.Debug": {
      "value": "false",
      "allowOverride": true
    }
  },
  "variableGroups": [],
  "artifacts": [],
  "releaseDefinition": {
    "id": 21,
    "name": "Fabrikam-web",
    "path": "\\",
    "projectReference": null,
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
      }
    }
  },
  "description": "Creating Sample release",
  "reason": "manual",
  "releaseNameFormat": "Release-$(Rev:r)",
  "keepForever": false,
  "definitionSnapshotRevision": 1,
  "logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
    }
  },
  "tags": [],
  "triggeringArtifactAlias": null,
  "projectReference": {
    "id": "42fa3371-9e49-4858-8f49-9d4f2d0b32e8",
    "name": null
  },
  "properties": {}
}

Przykładowa odpowiedź

{
  "id": 39,
  "name": "Release-1",
  "status": "active",
  "createdOn": "2018-12-10T12:43:34.223Z",
  "modifiedOn": "2018-12-10T12:43:36.537Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "environments": [
    {
      "id": 39,
      "releaseId": 39,
      "name": "PROD",
      "status": "notStarted",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 0
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 1,
      "definitionEnvironmentId": 21,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 0,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "schedules": [],
      "release": {
        "id": 39,
        "name": "Release-1",
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
          }
        }
      },
      "releaseDefinition": {
        "id": 21,
        "name": "Fabrikam-web",
        "path": "\\",
        "projectReference": null,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
          }
        }
      },
      "releaseCreatedBy": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "triggerReason": "Manual",
      "preDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      }
    }
  ],
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    },
    "System.Debug": {
      "value": "false",
      "allowOverride": true
    }
  },
  "variableGroups": [],
  "artifacts": [],
  "releaseDefinition": {
    "id": 21,
    "name": "Fabrikam-web",
    "path": "\\",
    "projectReference": null,
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
      }
    }
  },
  "description": "Creating Sample release",
  "reason": "manual",
  "releaseNameFormat": "Release-$(Rev:r)",
  "keepForever": false,
  "definitionSnapshotRevision": 2,
  "logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
    }
  },
  "tags": [],
  "triggeringArtifactAlias": null,
  "projectReference": {
    "id": "42fa3371-9e49-4858-8f49-9d4f2d0b32e8",
    "name": null
  },
  "properties": {}
}

Definicje

Nazwa Opis
ApprovalExecutionOrder

Kolejność wykonywania zatwierdzeń.

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 wdrażania.

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ść. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z TypeCode != TypeCode.Object), z wyjątkiem DBNull. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane 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.

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

Wartość Opis
afterGatesAlways

Zatwierdzenia wyświetlane zawsze po wykonaniu bram.

afterSuccessfulGates

Zatwierdzenia wyświetlane po pomyślnym wykonaniu bram.

beforeGates

Zatwierdzenia wyświetlane przed bramami.

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 tożsamość osoby zatwierdzającej zostanie ponownie zaktualizowana przed ukończeniem zatwierdzenia.

executionOrder

ApprovalExecutionOrder

Kolejność wykonywania zatwierdzeń.

releaseCreatorCanBeApprover

boolean

Określ, czy użytkownik żądający wydania lub wdrożenia powinien zezwalać na zatwierdzanie.

requiredApproverCount

integer (int32)

Liczba zatwierdzeń wymaganych do przeniesienia wydania do przodu. "0" oznacza wszystkie wymagane zatwierdzenia.

timeoutInMinutes

integer (int32)

Limit czasu zatwierdzenia. 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.

Wartość Opis
approved

Wskazuje, że zatwierdzenie zostało zatwierdzone.

canceled

Wskazuje, że zatwierdzenie zostało anulowane.

pending

Wskazuje, że zatwierdzenie oczekuje.

reassigned

Wskazuje, że zatwierdzenie jest ponownie przypisywane.

rejected

Wskazuje, że zatwierdzenie zostało odrzucone.

skipped

Wskazuje, że zatwierdzenie zostało pominięte.

undefined

Wskazuje, że zatwierdzenie nie ma ustawionego stanu.

ApprovalType

Pobiera lub ustawia typ zatwierdzenia.

Wartość Opis
all

Wskazuje wszystkie zatwierdzenia.

postDeploy

Wskazuje zatwierdzenia wykonywane po wdrożeniu.

preDeploy

Wskazuje zatwierdzenia wykonywane przed wdrożeniem.

undefined

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.

Wartość Opis
artifact

Typ warunku to artefakt.

environmentState

Typ warunku to stan środowiska.

event

Typ warunku to zdarzenie.

undefined

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, czy 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 (int32)

Próba wdrożenia.

deploymentId

integer (int32)

Identyfikator wdrożenia.

hasStarted

boolean

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

id

integer (int32)

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 (date-time)

Czas ostatniej modyfikacji tego wdrożenia.

operationStatus

DeploymentOperationStatus

Stan operacji wdrożenia.

postDeploymentGates

ReleaseGates

Po wdrożeniu bramy wykonywane w tym wdrożeniu.

preDeploymentGates

ReleaseGates

Bramy przed wdrożeniem wykonywane w tym wdrożeniu.

queuedOn

string (date-time)

Gdy to wdrożenie zostanie włączone 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.

Wartość Opis
all

Stan operacji wdrożenia to wszystko.

approved

Stan operacji wdrożenia jest zatwierdzony.

canceled

Stan operacji wdrożenia jest anulowany.

cancelling

Stan operacji wdrożenia jest anulowany.

deferred

Stan operacji wdrożenia jest odroczony.

evaluatingGates

Stan operacji wdrożenia to EvaluatingGates.

gateFailed

Stan operacji wdrożenia to GateFailed.

manualInterventionPending

Stan operacji wdrożenia to oczekiwanie na ręczne wymyślenie.

pending

Stan operacji wdrożenia to oczekiwanie.

phaseCanceled

Stan operacji wdrożenia to faza anulowana.

phaseFailed

Stan operacji wdrożenia to faza nie powiodła się.

phaseInProgress

Stan operacji wdrażania to faza w toku.

phasePartiallySucceeded

Stan operacji wdrożenia to faza częściowo powiodła się.

phaseSucceeded

Stan operacji wdrożenia to faza powodzenia.

queued

Stan operacji wdrażania jest w kolejce.

queuedForAgent

Stan operacji wdrażania jest ustawiany w kolejce dla agenta.

queuedForPipeline

Stan operacji wdrażania jest ustawiany w kolejce dla potoku.

rejected

Stan operacji wdrożenia jest odrzucany.

scheduled

Stan operacji wdrożenia jest zaplanowany.

undefined

Stan operacji wdrożenia jest niezdefiniowany.

DeploymentReason

Pobiera przyczynę wdrożenia.

Wartość Opis
automated

Przyczyna wdrożenia jest zautomatyzowana.

manual

Przyczyną wdrożenia jest ręczne.

none

Przyczyna wdrożenia nie jest żadna.

redeployTrigger

Przyczyną wdrożenia jest Ponowne wdrożenieTrigger.

scheduled

Przyczyna wdrożenia jest zaplanowana.

DeploymentStatus

Pobiera stan wdrożenia.

Wartość Opis
all

Stan wdrożenia to wszystko.

failed

Stan wdrożenia nie powiedzie się.

inProgress

Stan wdrożenia jest w toku.

notDeployed

Stan wdrożenia nie jest wdrożony.

partiallySucceeded

Stan wdrożenia jest częściowo sytuowany.

succeeded

Stan wdrożenia to powodzenie.

undefined

Stan wdrożenia jest niezdefiniowany.

DeployPhase

Nazwa Typ Opis
name

string

Pobiera i ustawia nazwę fazy wdrażania.

phaseType

DeployPhaseTypes

Wskazuje typ fazy wdrażania.

rank

integer (int32)

Pobiera i ustawia rangę fazy wdrażania.

refName

string

Pobiera i ustawia nazwę odwołania fazy wdrażania.

workflowTasks

WorkflowTask[]

Pobiera i ustawia zadania przepływu pracy dla fazy wdrażania.

DeployPhaseStatus

Stan fazy.

Wartość Opis
canceled

Anulowano wykonywanie fazy.

cancelling

Faza jest w stanie anulowania.

failed

Wykonanie fazy nie powiodło się.

inProgress

Wykonywanie fazy w toku.

notStarted

Nie uruchomiono wykonywania fazy.

partiallySucceeded

Wykonanie fazy częściowo zakończyło się pomyślnie.

skipped

Pominięto wykonywanie fazy.

succeeded

Wykonanie fazy zakończyło się pomyślnie.

undefined

Nie ustawiono stanu fazy.

DeployPhaseTypes

Wskazuje typ fazy wdrażania.

Wartość Opis
agentBasedDeployment

Typ fazy, który zawiera zadania wykonywane na agencie.

deploymentGates

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

machineGroupBasedDeployment

Typ fazy, który zawiera zadania wykonywane na maszynach grupy wdrożeń.

runOnServer

Typ fazy, który zawiera zadania wykonywane przez serwer.

undefined

Nie zdefiniowano typu fazy. Nie używaj tego.

EnvironmentOptions

Nazwa Typ Opis
autoLinkWorkItems

boolean

Pobiera i ustawia jako element roboczy linku automatycznego, a nie.

badgeEnabled

boolean

Pobiera i ustawia jako wskaźnik włączony lub nie.

publishDeploymentStatus

boolean

Pobiera i ustawia jako stan wdrożenia publikowania, czy nie.

pullRequestDeploymentEnabled

boolean

Pobiera i ustawia jako wdrożenie żądania ściągnięcia włączone lub nie.

EnvironmentStatus

Pobiera stan środowiska.

Wartość Opis
canceled

Środowisko jest w stanie anulowania.

inProgress

Środowisko jest w toku.

notStarted

Środowisko nie jest w stanie uruchomienia.

partiallySucceeded

Środowisko jest w stanie częściowo zakończonym powodzeniem.

queued

Środowisko jest w stanie w kolejce.

rejected

Środowisko jest w stanie odrzuconym.

scheduled

Środowisko jest w stanie zaplanowanym.

succeeded

Środowisko jest w stanie powodzenia.

undefined

Stan środowiska nie jest ustawiony.

GateStatus

Stan bram wydania.

Wartość Opis
canceled

Wykonanie bramy zostało anulowane.

failed

Wykonanie bramy nie powiodło się.

inProgress

Brama jest obecnie w toku.

none

Brama nie ma ustawionego stanu.

pending

Brama jest w stanie oczekiwania.

succeeded

Brama została ukończona pomyślnie.

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 go pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"

displayName

string

Jest to unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.

id

string

imageUrl

string

Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"

inactive

boolean

Przestarzałe — można pobrać, wykonując zapytanie dotyczące 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 elementu ToIdentityRef

uniqueName

string

Przestarzałe — zamiast tego użyj nazwy głównej i domeny

url

string

Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

IgnoredGate

Nazwa Typ Opis
lastModifiedOn

string (date-time)

Pobiera datę ostatniego ignorowania bramy.

name

string

Nazwa bramy zignorowana.

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 (date-time)

Pobiera datę utworzenia.

id

integer (int32)

Pobiera unikatowy identyfikator interwencji ręcznej.

instructions

string

Pobiera lub ustawia instrukcje dotyczące zatwierdzenia.

modifiedOn

string (date-time)

Pobiera datę modyfikacji.

name

string

Pobiera lub ustawia nazwę.

release

ReleaseShallowReference

Pobiera odwołanie releaseReference na potrzeby interwencji ręcznej.

releaseDefinition

ReleaseDefinitionShallowReference

Pobiera releaseDefinitionReference na potrzeby interwencji ręcznej.

releaseEnvironment

ReleaseEnvironmentShallowReference

Pobiera wydanieEnvironmentReference na potrzeby interwencji ręcznej.

status

ManualInterventionStatus

Pobiera lub ustawia stan interwencji ręcznej.

taskInstanceId

string (uuid)

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.

Wartość Opis
approved

Interwencja ręczna jest zatwierdzona.

canceled

Interwencja ręczna zostanie anulowana.

pending

Interwencja ręczna jest oczekująca.

rejected

Interwencja ręczna jest odrzucana.

unknown

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 (uuid)

Pobiera unikatowy identyfikator tego pola.

name

string

Pobiera nazwę projektu.

PropertiesCollection

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

Nazwa Typ Opis
count

integer (int32)

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 odwołania są tylko do odczytu, 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 utworzyła.

createdFor

IdentityRef

Pobiera lub ustawia tożsamość, dla której utworzono wydanie.

createdOn

string (date-time)

Pobiera datę utworzenia.

definitionSnapshotRevision

integer (int32)

Pobiera numer poprawki migawki definicji.

description

string

Pobiera lub ustawia opis wydania.

environments

ReleaseEnvironment[]

Pobiera listę środowisk.

id

integer (int32)

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 (date-time)

Pobiera datę modyfikacji.

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ść. Akceptowane są wartości wszystkich typów pierwotnych (dowolnego typu z TypeCode != TypeCode.Object), z wyjątkiem DBNull. Wartości typu Byte[], Int32, Double, DateType i String zachowują swój typ, inne typy pierwotne są zmieniane jako ciąg. Bajt[] oczekiwany jako ciąg zakodowany w formacie base64.

reason

ReleaseReason

Pobiera przyczynę wydania.

releaseDefinition

ReleaseDefinitionShallowReference

Pobiera wartość releaseDefinitionReference, która określa odwołanie do definicji wydania, z którą jest skojarzona ta wersja.

releaseDefinitionRevision

integer (int32)

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 (int32)

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 (date-time)

Pobiera datę utworzenia.

history

ReleaseApprovalHistory[]

Pobiera historię określającą wszystkie zatwierdzenia skojarzone z tym zatwierdzeniem.

id

integer (int32)

Pobiera unikatowy identyfikator tego pola.

isAutomated

boolean

Pobiera lub ustawia jako zatwierdzenie jest zautomatyzowane lub nie.

modifiedOn

string (date-time)

Pobiera datę modyfikacji.

rank

integer (int32)

Pobiera lub ustawia rangę, która określa kolejność zatwierdzenia. Na przykład ta sama ranga oznacza zatwierdzenie równoległe.

release

ReleaseShallowReference

Pobiera releaseReference, który określa odwołanie do wydania, do którego jest skojarzone to zatwierdzenie.

releaseDefinition

ReleaseDefinitionShallowReference

Pobiera wartość releaseDefinitionReference, która określa odwołanie do definicji wydania, z którą jest skojarzone to zatwierdzenie.

releaseEnvironment

ReleaseEnvironmentShallowReference

Pobiera releaseEnvironmentReference, który określa odwołanie do środowiska wydania, z którym jest skojarzone to zatwierdzenie.

revision

integer (int32)

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 (date-time)

Czas utworzenia tego zatwierdzenia.

modifiedOn

string (date-time)

Czas modyfikacji tego zatwierdzenia.

revision

integer (int32)

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 (int32)

Identyfikator kroku zatwierdzania lub wdrażania.

isAutomated

boolean

Wskazuje, czy zatwierdzenie jest zautomatyzowane.

isNotificationOn

boolean

Wskazuje, czy zestaw powiadomień o zatwierdzeniu.

rank

integer (int32)

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 (int32)

Pobiera lub ustawia minimalny czas trwania dla stałych wyników po pomyślnej ocenie bram.

samplingInterval

integer (int32)

Pobiera lub ustawia czas między ponowną oceną bram.

stabilizationTime

integer (int32)

Pobiera lub ustawia opóźnienie przed oceną.

timeout

integer (int32)

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 (int32)

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 (int32)

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 (int32)

Ranga fazy.

runPlanId

string (uuid)

Uruchom identyfikator planu fazy.

startedOn

string (date-time)

Godzina rozpoczęcia fazy.

status

DeployPhaseStatus

Stan fazy.

ReleaseEnvironment

Nazwa Typ Opis
conditions

ReleaseCondition[]

Pobiera listę warunków.

createdOn

string (date-time)

Pobiera datę utworzenia.

definitionEnvironmentId

integer (int32)

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 (int32)

Pobiera unikatowy identyfikator tego pola.

modifiedOn

string (date-time)

Pobiera datę modyfikacji.

name

string

Pobiera nazwę.

nextScheduledUtcTime

string (date-time)

Pobiera następny zaplanowany czas UTC.

owner

IdentityRef

Pobiera tożsamość, która jest właścicielem środowiska wydania.

postApprovalsSnapshot

ReleaseDefinitionApprovals

Pobiera listę migawek zatwierdzeń po wdrożeniu.

postDeployApprovals

ReleaseApproval[]

Pobiera listę zatwierdzeń po wdrożeniu.

postDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Publikowanie danych migawek bram wdrożenia.

preApprovalsSnapshot

ReleaseDefinitionApprovals

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

preDeployApprovals

ReleaseApproval[]

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

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Dane migawek bram przed wdrożeniem.

processParameters

ProcessParameters

Pobiera parametry procesu.

rank

integer (int32)

Pobiera rangę.

release

ReleaseShallowReference

Pobiera odwołanie do wydania, które określa odwołanie do wydania, z którym jest skojarzone to środowisko wydania.

releaseCreatedBy

IdentityRef

Pobiera tożsamość, która utworzyła wydanie.

releaseDefinition

ReleaseDefinitionShallowReference

Pobiera wartość releaseDefinitionReference, która określa odwołanie do definicji wydania, z którą jest skojarzone to środowisko wydania.

releaseId

integer (int32)

Pobiera identyfikator wydania.

scheduledDeploymentTime

string (date-time)

Pobiera zaplanowany czas wdrożenia środowiska wydania.

schedules

ReleaseSchedule[]

Pobiera listę harmonogramów.

status

EnvironmentStatus

Pobiera stan środowiska.

timeToDeploy

number (double)

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 (int32)

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 bramy dla każdej oceny.

id

integer (int32)

Identyfikator bram wydania.

ignoredGates

IgnoredGate[]

Lista ignorowanych bram.

lastModifiedOn

string (date-time)

Czas ostatniej modyfikacji bram.

runPlanId

string (uuid)

Uruchom identyfikator planu bram.

stabilizationCompletedOn

string (date-time)

Stabilizacja bramy zakończyła datę i godzinę.

startedOn

string (date-time)

Godzina rozpoczęcia oceny bram.

status

GateStatus

Stan bram wydania.

succeedingSince

string (date-time)

Data i godzina pomyślnego wykonania wszystkich bram.

ReleaseReason

Pobiera przyczynę wydania.

Wartość Opis
continuousIntegration

Wskazuje wydanie wyzwalane przez ciągłą integrację.

manual

Wskazuje, że wersja została wyzwolona ręcznie.

none

Wskazuje, że przyczyna wyzwolenia wydania nie została ustawiona.

pullRequest

Wskazuje wydanie wyzwalane przez ciąg PullRequest.

schedule

Wskazuje wydanie wyzwalane zgodnie z harmonogramem.

ReleaseSchedule

Nazwa Typ Opis
daysToRelease

ScheduleDays

Dni tygodnia do wydania.

jobId

string (uuid)

Identyfikator zadania definicji zadania programu Team Foundation.

scheduleOnlyWithChanges

boolean

Flaga określająca, czy ten harmonogram powinien być zwalniany tylko wtedy, gdy skojarzony artefakt został zmieniony lub zmieniono definicję wydania.

startHours

integer (int32)

Godzina lokalnej strefy czasowej do uruchomienia.

startMinutes

integer (int32)

Lokalna minuta strefy czasowej do uruchomienia.

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 (int32)

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.

Wartość Opis
abandoned

Stan wydania jest porzucony.

active

Stan wydania jest aktywny.

draft

Wydanie jest w stanie roboczym.

undefined

Stan wydania nie jest ustawiony.

ReleaseTask

Nazwa Typ Opis
agentName

string

Nazwa agenta, na którym zostało wykonane zadanie.

finishTime

string (date-time)

Godzina zakończenia zadania wydania.

id

integer (int32)

Identyfikator zadania wydania.

issues

Issue[]

Lista problemów wystąpiła podczas wykonywania zadania.

lineCount

integer (int64)

Liczba wierszy zadania zwolnienia dziennika.

logUrl

string

Adres URL dziennika zadania.

name

string

Nazwa zadania.

percentComplete

integer (int32)

Wykonywanie zadania kończy się w precentr.

rank

integer (int32)

Ranga zadania wydania.

resultCode

string

Kod wyniku zadania.

startTime

string (date-time)

Identyfikator zadania wydania.

status

TaskStatus

Stan zadania wydania.

task

WorkflowTaskReference

Dokumentacja zadania przepływu pracy.

timelineRecordId

string (uuid)

Identyfikator rekordu osi czasu zadania wydania.

ScheduleDays

Dni tygodnia do wydania.

Wartość Opis
all

Zaplanowane na wszystkie dni w tygodniu.

friday

Zaplanowane w piątek.

monday

Zaplanowane w poniedziałek.

none

Nie ustawiono zaplanowanego dnia.

saturday

Zaplanowane w sobotę.

sunday

Zaplanowane w niedzielę.

thursday

Zaplanowane w czwartek.

tuesday

Zaplanowane we wtorek.

wednesday

Zaplanowane w środę.

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ć, czy walidacja nie powiedzie się

TaskSourceDefinitionBase

Nazwa Typ Opis
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

TaskStatus

Stan zadania wydania.

Wartość Opis
canceled

Wykonanie zadania zostało anulowane.

failed

Wykonanie zadania nie powiodło się.

failure

Wykonanie zadania nie powiodło się.

inProgress

Zadanie jest obecnie w toku.

partiallySucceeded

Wykonanie zadania częściowo zakończyło się pomyślnie.

pending

Zadanie jest w stanie oczekiwania.

skipped

Wykonanie zadania zostało pominięte.

succeeded

Zadanie zostało ukończone pomyślnie.

success

Zadanie zostało ukończone pomyślnie.

unknown

Zadanie nie ma ustawionego stanu.

VariableGroup

Nazwa Typ Opis
createdBy

IdentityRef

Pobiera lub ustawia tożsamość, która utworzyła.

createdOn

string (date-time)

Pobiera datę utworzenia.

description

string

Pobiera lub ustawia opis.

id

integer (int32)

Pobiera unikatowy identyfikator tego pola.

isShared

boolean

Określa, czy grupa zmiennych jest udostępniana innym projektom, czy nie.

modifiedBy

IdentityRef

Pobiera lub ustawia tożsamość, która została zmodyfikowana.

modifiedOn

string (date-time)

Pobiera datę modyfikacji.

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żytkowany 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 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ą jest 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, które będzie 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 przesłonięcia danych wejściowych zadania.

refName

string

Pobiera lub ustawia nazwę odwołania zadania.

retryCountOnTaskFailure

integer (int32)

Pobiera lub ustawia zadanie retryCount.

taskId

string (uuid)

Pobiera lub ustawia identyfikator zadania.

timeoutInMinutes

integer (int32)

Pobiera lub ustawia limit czasu zadania.

version

string

Pobiera lub ustawia wersję zadania.

WorkflowTaskReference

Nazwa Typ Opis
id

string (uuid)

Identyfikator zadania.

name

string

Nazwa zadania.

version

string

Wersja zadania.