七千块笔记本推荐 Releases

Get release summary of a given definition Id.

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?definitionId={definitionId}&releaseCount={releaseCount}&api-version=4.1-preview.6 With optional parameters: GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?definitionId={definitionId}&releaseCount={releaseCount}&includeArtifact={includeArtifact}&definitionEnvironmentIdsFilter={definitionEnvironmentIdsFilter}&api-version=4.1-preview.6 URI Parameters Name In Required Type Description organization path True

string

The name of the Azure DevOps organization.

project path True

string

Project ID or project name

api-version query True

string

Version of the API to use. This should be set to '4.1-preview.6' to use this version of the api.

definitionId query True

integer (int32)

Id of the definition to get release summary.

releaseCount query True

integer (int32)

Count of releases to be included in summary.

definitionEnvironmentIdsFilter query

string (array (int32))

includeArtifact query

boolean

Include artifact details.Default is 'false'.

Responses Name Type Description 200 OK

ReleaseDefinitionSummary

successful operation

Security oauth2

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

Scopes Name Description vso.release Grants the ability to read release artifacts, including releases, release definitions and release environment. Definitions Name Description ApprovalExecutionOrder ApprovalOptions ApprovalStatus

Gets or sets the status of the approval.

ApprovalType

Gets or sets the type of approval.

Artifact ArtifactSourceReference AuthorizationHeader ConditionType

Gets or sets the condition type.

ConfigurationVariableValue DataSourceBindingBase

Represents binding of data source for the service endpoint request.

Demand DeploymentAttempt DeploymentJob DeploymentOperationStatus

Gets operation status of deployment.

DeploymentReason

Gets reason of deployment.

DeploymentStatus

Gets status of the deployment.

DeployPhase DeployPhaseStatus DeployPhaseTypes EnvironmentOptions EnvironmentStatus

Gets environment status.

GateStatus IdentityRef Issue ManualIntervention ManualInterventionStatus

Gets or sets the status of the manual intervention.

ProcessParameters ProjectReference PropertiesCollection

The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a TypeCode != TypeCode.Object) except for DBNull are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.

ReferenceLinks

The class to represent a collection of REST reference links.

Release ReleaseApproval ReleaseApprovalHistory ReleaseCondition ReleaseDefinitionApprovals ReleaseDefinitionApprovalStep ReleaseDefinitionEnvironmentSummary ReleaseDefinitionGate ReleaseDefinitionGatesOptions ReleaseDefinitionGatesStep ReleaseDefinitionShallowReference ReleaseDefinitionSummary ReleaseDeployPhase ReleaseEnvironment ReleaseEnvironmentShallowReference ReleaseGates ReleaseReason

Gets reason for release.

ReleaseSchedule ReleaseShallowReference ReleaseStatus

Gets status.

ReleaseTask ScheduleDays

Days of the week to release

TaskInputDefinitionBase TaskInputValidation TaskSourceDefinitionBase TaskStatus VariableGroup VariableGroupProviderData VariableValue WorkflowTask WorkflowTaskReference ApprovalExecutionOrder Enumeration Value Description beforeGates afterSuccessfulGates afterGatesAlways ApprovalOptions Object Name Type Description autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

enforceIdentityRevalidation

boolean

executionOrder

ApprovalExecutionOrder

releaseCreatorCanBeApprover

boolean

requiredApproverCount

integer (int32)

timeoutInMinutes

integer (int32)

ApprovalStatus Enumeration

Gets or sets the status of the approval.

Value Description undefined pending approved rejected reassigned canceled skipped ApprovalType Enumeration

Gets or sets the type of approval.

Value Description undefined preDeploy postDeploy all Artifact Object Name Type Description alias

string

Gets or sets alias.

definitionReference

Gets or sets definition reference. e.g. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}

isPrimary

boolean

Gets or sets as artifact is primary or not.

type

string

Gets or sets type. It can he value as 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.

ArtifactSourceReference Object Name Type Description id

string

name

string

AuthorizationHeader Object Name Type Description name

string

value

string

ConditionType Enumeration

Gets or sets the condition type.

Value Description undefined

The condition type is undefined.

event

The condition type is event.

environmentState

The condition type is environment state.

artifact

The condition type is artifact.

ConfigurationVariableValue Object Name Type Description isSecret

boolean

Gets or sets as variable is secret or not.

value

string

Gets or sets value of the configuration variable.

DataSourceBindingBase Object

Represents binding of data source for the service endpoint request.

Name Type Description dataSourceName

string

Gets or sets the name of the data source.

endpointId

string

Gets or sets the endpoint Id.

endpointUrl

string

Gets or sets the url of the service endpoint.

headers

AuthorizationHeader[]

Gets or sets the authorization headers.

parameters

object

Gets or sets the parameters for the data source.

resultSelector

string

Gets or sets the result selector.

resultTemplate

string

Gets or sets the result template.

target

string

Gets or sets the target of the data source.

Demand Object Name Type Description name

string

value

string

DeploymentAttempt Object Name Type Description attempt

integer (int32)

deploymentId

integer (int32)

hasStarted

boolean

Specifies whether deployment has started or not

integer (int32)

issues

Issue[]

All the issues related to the deployment

job

ReleaseTask

lastModifiedBy

IdentityRef

lastModifiedOn

string (date-time)

operationStatus

DeploymentOperationStatus

postDeploymentGates

ReleaseGates

preDeploymentGates

ReleaseGates

queuedOn

string (date-time)

reason

DeploymentReason

releaseDeployPhases

ReleaseDeployPhase[]

requestedBy

IdentityRef

requestedFor

IdentityRef

runPlanId

string (uuid)

status

DeploymentStatus

tasks

ReleaseTask[]

DeploymentJob Object Name Type Description job

ReleaseTask

tasks

ReleaseTask[]

DeploymentOperationStatus Enumeration

Gets operation status of deployment.

Value Description undefined

The deployment operation status is undefined.

queued

The deployment operation status is queued.

scheduled

The deployment operation status is scheduled.

pending

The deployment operation status is pending.

approved

The deployment operation status is approved.

rejected

The deployment operation status is rejected.

deferred

The deployment operation status is deferred.

queuedForAgent

The deployment operation status is queued for agent.

phaseInProgress

The deployment operation status is phase inprogress.

phaseSucceeded

The deployment operation status is phase succeeded.

phasePartiallySucceeded

The deployment operation status is phase partially succeeded.

phaseFailed

The deployment operation status is phase failed.

canceled

The deployment operation status is canceled.

phaseCanceled

The deployment operation status is phase canceled.

manualInterventionPending

The deployment operation status is manualintervention pending.

queuedForPipeline

The deployment operation status is queued for pipeline.

cancelling

The deployment operation status is cancelling.

evaluatingGates

The deployment operation status is EvaluatingGates.

gateFailed

The deployment operation status is GateFailed.

all

The deployment operation status is all.

DeploymentReason Enumeration

Gets reason of deployment.

Value Description none

The deployment reason is none.

manual

The deployment reason is manual.

automated

The deployment reason is automated.

scheduled

The deployment reason is scheduled.

DeploymentStatus Enumeration

Gets status of the deployment.

Value Description undefined

The deployment status is undefined.

notDeployed

The deployment status is not deployed.

inProgress

The deployment status is inprogress.

succeeded

The deployment status is succeeded.

partiallySucceeded

The deployment status is partiallysucceeded.

failed

The deployment status is failed.

all

The deployment status is all.

DeployPhase Object Name Type Description name

string

phaseType

DeployPhaseTypes

rank

integer (int32)

workflowTasks

WorkflowTask[]

DeployPhaseStatus Enumeration Value Description undefined notStarted inProgress partiallySucceeded succeeded failed canceled skipped cancelling DeployPhaseTypes Enumeration Value Description undefined agentBasedDeployment runOnServer machineGroupBasedDeployment EnvironmentOptions Object Name Type Description autoLinkWorkItems

boolean

badgeEnabled

boolean

emailNotificationType

string

emailRecipients

string

enableAccessToken

boolean

publishDeploymentStatus

boolean

skipArtifactsDownload

boolean

timeoutInMinutes

integer (int32)

EnvironmentStatus Enumeration

Gets environment status.

Value Description undefined notStarted inProgress succeeded canceled rejected queued scheduled partiallySucceeded GateStatus Enumeration Value Description none pending inProgress succeeded failed IdentityRef Object Name Type Description _links

ReferenceLinks

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.

descriptor

string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

directoryAlias

string

displayName

string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

profileUrl

string

uniqueName

string

url

string

This url is the full route to the source resource of this graph subject.

Issue Object Name Type Description issueType

string

message

string

ManualIntervention Object Name Type Description approver

IdentityRef

Gets or sets the identity who should approve.

comments

string

Gets or sets comments for approval.

createdOn

string (date-time)

Gets date on which it got created.

integer (int32)

Gets the unique identifier for manual intervention.

instructions

string

Gets or sets instructions for approval.

modifiedOn

string (date-time)

Gets date on which it got modified.

name

string

Gets or sets the name.

release

ReleaseShallowReference

Gets releaseReference for manual intervention.

releaseDefinition

ReleaseDefinitionShallowReference

Gets releaseDefinitionReference for manual intervention.

releaseEnvironment

ReleaseEnvironmentShallowReference

Gets releaseEnvironmentReference for manual intervention.

status

ManualInterventionStatus

Gets or sets the status of the manual intervention.

taskInstanceId

string (uuid)

Get task instance identifier.

url

string

Gets url to access the manual intervention.

ManualInterventionStatus Enumeration

Gets or sets the status of the manual intervention.

Value Description unknown

The manual intervention does not he the status set.

pending

The manual intervention is pending.

rejected

The manual intervention is rejected.

approved

The manual intervention is approved.

canceled

The manual intervention is canceled.

ProcessParameters Object Name Type Description dataSourceBindings

DataSourceBindingBase[]

Represents binding of data source for the service endpoint request.

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference Object Name Type Description id

string (uuid)

Gets the unique identifier of this field.

name

string

Gets name of project.

PropertiesCollection Object

Name Type Description count

integer (int32)

The count of properties in the collection.

item

object

keys

string[]

The set of keys in the collection.

values

string[]

The set of values in the collection.

ReferenceLinks Object

The class to represent a collection of REST reference links.

Name Type Description links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

Release Object Name Type Description _links

ReferenceLinks

Gets links to access the release.

artifacts

Artifact[]

Gets or sets the list of artifacts.

comment

string

Gets or sets comment.

createdBy

IdentityRef

Gets or sets the identity who created.

createdOn

string (date-time)

Gets date on which it got created.

definitionSnapshotRevision

integer (int32)

Gets revision number of definition snapshot.

description

string

Gets or sets description of release.

environments

ReleaseEnvironment[]

Gets list of environments.

integer (int32)

Gets the unique identifier of this field.

keepForever

boolean

Whether to exclude the release from retention policies.

logsContainerUrl

string

Gets logs container url.

modifiedBy

IdentityRef

Gets or sets the identity who modified.

modifiedOn

string (date-time)

Gets date on which it got modified.

name

string

Gets name.

poolName

string

Gets pool name.

projectReference

ProjectReference

Gets or sets project reference.

properties

PropertiesCollection

reason

ReleaseReason

Gets reason of release.

releaseDefinition

ReleaseDefinitionShallowReference

Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated.

releaseNameFormat

string

Gets release name format.

status

ReleaseStatus

Gets status.