Documentation ¶
Index ¶
- Variables
- type AgentArtifactDefinition
- type AgentArtifactType
- type AgentBasedDeployPhase
- type AgentDeploymentInput
- type AgentSpecification
- type ApprovalExecutionOrder
- type ApprovalFilters
- type ApprovalOptions
- type ApprovalStatus
- type ApprovalType
- type Artifact
- type ArtifactContributionDefinition
- type ArtifactDownloadInputBase
- type ArtifactFilter
- type ArtifactInstanceData
- type ArtifactMetadata
- type ArtifactProvider
- type ArtifactSourceId
- type ArtifactSourceIdsQueryResult
- type ArtifactSourceReference
- type ArtifactSourceTrigger
- type ArtifactTriggerConfiguration
- type ArtifactTypeDefinition
- type ArtifactVersion
- type ArtifactVersionQueryResult
- type ArtifactsDownloadInput
- type AuditAction
- type AuthorizationHeaderFor
- type AutoTriggerIssue
- type AzureKeyVaultVariableGroupProviderData
- type AzureKeyVaultVariableValue
- type BaseDeploymentInput
- type BuildArtifactDownloadInput
- type BuildVersion
- type Change
- type Client
- type ClientImpl
- func (client *ClientImpl) CreateFolder(ctx context.Context, args CreateFolderArgs) (*Folder, error)
- func (client *ClientImpl) CreateRelease(ctx context.Context, args CreateReleaseArgs) (*Release, error)
- func (client *ClientImpl) CreateReleaseDefinition(ctx context.Context, args CreateReleaseDefinitionArgs) (*ReleaseDefinition, error)
- func (client *ClientImpl) DeleteFolder(ctx context.Context, args DeleteFolderArgs) error
- func (client *ClientImpl) DeleteReleaseDefinition(ctx context.Context, args DeleteReleaseDefinitionArgs) error
- func (client *ClientImpl) GetApprovals(ctx context.Context, args GetApprovalsArgs) (*GetApprovalsResponseValue, error)
- func (client *ClientImpl) GetDefinitionRevision(ctx context.Context, args GetDefinitionRevisionArgs) (io.ReadCloser, error)
- func (client *ClientImpl) GetDeployments(ctx context.Context, args GetDeploymentsArgs) (*GetDeploymentsResponseValue, error)
- func (client *ClientImpl) GetFolders(ctx context.Context, args GetFoldersArgs) (*[]Folder, error)
- func (client *ClientImpl) GetLogs(ctx context.Context, args GetLogsArgs) (io.ReadCloser, error)
- func (client *ClientImpl) GetManualIntervention(ctx context.Context, args GetManualInterventionArgs) (*ManualIntervention, error)
- func (client *ClientImpl) GetManualInterventions(ctx context.Context, args GetManualInterventionsArgs) (*[]ManualIntervention, error)
- func (client *ClientImpl) GetRelease(ctx context.Context, args GetReleaseArgs) (*Release, error)
- func (client *ClientImpl) GetReleaseDefinition(ctx context.Context, args GetReleaseDefinitionArgs) (*ReleaseDefinition, error)
- func (client *ClientImpl) GetReleaseDefinitionHistory(ctx context.Context, args GetReleaseDefinitionHistoryArgs) (*[]ReleaseDefinitionRevision, error)
- func (client *ClientImpl) GetReleaseDefinitions(ctx context.Context, args GetReleaseDefinitionsArgs) (*GetReleaseDefinitionsResponseValue, error)
- func (client *ClientImpl) GetReleaseEnvironment(ctx context.Context, args GetReleaseEnvironmentArgs) (*ReleaseEnvironment, error)
- func (client *ClientImpl) GetReleaseRevision(ctx context.Context, args GetReleaseRevisionArgs) (io.ReadCloser, error)
- func (client *ClientImpl) GetReleaseTaskAttachmentContent(ctx context.Context, args GetReleaseTaskAttachmentContentArgs) (io.ReadCloser, error)
- func (client *ClientImpl) GetReleaseTaskAttachments(ctx context.Context, args GetReleaseTaskAttachmentsArgs) (*[]ReleaseTaskAttachment, error)
- func (client *ClientImpl) GetReleases(ctx context.Context, args GetReleasesArgs) (*GetReleasesResponseValue, error)
- func (client *ClientImpl) GetTaskLog(ctx context.Context, args GetTaskLogArgs) (io.ReadCloser, error)
- func (client *ClientImpl) UpdateFolder(ctx context.Context, args UpdateFolderArgs) (*Folder, error)
- func (client *ClientImpl) UpdateGates(ctx context.Context, args UpdateGatesArgs) (*ReleaseGates, error)
- func (client *ClientImpl) UpdateManualIntervention(ctx context.Context, args UpdateManualInterventionArgs) (*ManualIntervention, error)
- func (client *ClientImpl) UpdateRelease(ctx context.Context, args UpdateReleaseArgs) (*Release, error)
- func (client *ClientImpl) UpdateReleaseApproval(ctx context.Context, args UpdateReleaseApprovalArgs) (*ReleaseApproval, error)
- func (client *ClientImpl) UpdateReleaseDefinition(ctx context.Context, args UpdateReleaseDefinitionArgs) (*ReleaseDefinition, error)
- func (client *ClientImpl) UpdateReleaseEnvironment(ctx context.Context, args UpdateReleaseEnvironmentArgs) (*ReleaseEnvironment, error)
- func (client *ClientImpl) UpdateReleaseResource(ctx context.Context, args UpdateReleaseResourceArgs) (*Release, error)
- type CodeRepositoryReference
- type ComplianceSettings
- type Condition
- type ConditionType
- type ConfigurationVariableValue
- type Consumer
- type ContainerImageTrigger
- type ContinuousDeploymentTriggerIssue
- type ControlOptions
- type CreateFolderArgs
- type CreateReleaseArgs
- type CreateReleaseDefinitionArgs
- type CustomArtifactDownloadInput
- type DataSourceBinding
- type DefinitionEnvironmentReference
- type DeleteFolderArgs
- type DeleteReleaseDefinitionArgs
- type Demand
- type DeployPhase
- type DeployPhaseStatus
- type DeployPhaseTypes
- type Deployment
- type DeploymentApprovalCompletedEvent
- type DeploymentApprovalPendingEvent
- type DeploymentAttempt
- type DeploymentAuthorizationInfo
- type DeploymentAuthorizationOwner
- type DeploymentCompletedEvent
- type DeploymentEvent
- type DeploymentExpands
- type DeploymentInput
- type DeploymentJob
- type DeploymentManualInterventionPendingEvent
- type DeploymentOperationStatus
- type DeploymentQueryParameters
- type DeploymentReason
- type DeploymentStartedEvent
- type DeploymentStatus
- type DeploymentsQueryType
- type EmailRecipients
- type EnvironmentExecutionPolicy
- type EnvironmentOptions
- type EnvironmentRetentionPolicy
- type EnvironmentStatus
- type EnvironmentTrigger
- type EnvironmentTriggerContent
- type EnvironmentTriggerType
- type ExecutionInput
- type FavoriteItem
- type Folder
- type FolderPathQueryOrder
- type GateStatus
- type GateUpdateMetadata
- type GatesDeployPhase
- type GatesDeploymentInput
- type GetApprovalsArgs
- type GetApprovalsResponseValue
- type GetDefinitionRevisionArgs
- type GetDeploymentsArgs
- type GetDeploymentsResponseValue
- type GetFoldersArgs
- type GetLogsArgs
- type GetManualInterventionArgs
- type GetManualInterventionsArgs
- type GetReleaseArgs
- type GetReleaseDefinitionArgs
- type GetReleaseDefinitionHistoryArgs
- type GetReleaseDefinitionsArgs
- type GetReleaseDefinitionsResponseValue
- type GetReleaseEnvironmentArgs
- type GetReleaseRevisionArgs
- type GetReleaseTaskAttachmentContentArgs
- type GetReleaseTaskAttachmentsArgs
- type GetReleasesArgs
- type GetReleasesResponseValue
- type GetTaskLogArgs
- type GitArtifactDownloadInput
- type GitHubArtifactDownloadInput
- type IgnoredGate
- type Issue
- type IssueSource
- type JenkinsArtifactDownloadInput
- type MachineGroupBasedDeployPhase
- type MachineGroupDeploymentInput
- type MailMessage
- type MailSectionType
- type ManualIntervention
- type ManualInterventionStatus
- type ManualInterventionUpdateMetadata
- type MappingDetails
- type Metric
- type MultiConfigInput
- type MultiMachineInput
- type OrgPipelineReleaseSettings
- type OrgPipelineReleaseSettingsUpdateParameters
- type PackageTrigger
- type ParallelExecutionInputBase
- type ParallelExecutionTypes
- type PipelineProcessTypes
- type ProjectPipelineReleaseSettings
- type ProjectPipelineReleaseSettingsUpdateParameters
- type ProjectReference
- type PropertySelector
- type PropertySelectorType
- type PullRequestConfiguration
- type PullRequestFilter
- type PullRequestSystemType
- type PullRequestTrigger
- type QueuedReleaseData
- type RealtimeReleaseDefinitionEvent
- type RealtimeReleaseEvent
- type Release
- type ReleaseAbandonedEvent
- type ReleaseApproval
- type ReleaseApprovalHistory
- type ReleaseApprovalPendingEvent
- type ReleaseArtifact
- type ReleaseCondition
- type ReleaseCreatedEvent
- type ReleaseDefinition
- type ReleaseDefinitionApprovalStep
- type ReleaseDefinitionApprovals
- type ReleaseDefinitionDeployStep
- type ReleaseDefinitionEnvironment
- type ReleaseDefinitionEnvironmentStep
- type ReleaseDefinitionEnvironmentSummary
- type ReleaseDefinitionEnvironmentTemplate
- type ReleaseDefinitionExpands
- type ReleaseDefinitionGate
- type ReleaseDefinitionGatesOptions
- type ReleaseDefinitionGatesStep
- type ReleaseDefinitionQueryOrder
- type ReleaseDefinitionRevision
- type ReleaseDefinitionShallowReference
- type ReleaseDefinitionSource
- type ReleaseDefinitionSummary
- type ReleaseDefinitionUndeleteParameter
- type ReleaseDeployPhase
- type ReleaseEnvironment
- type ReleaseEnvironmentCompletedEvent
- type ReleaseEnvironmentExpands
- type ReleaseEnvironmentShallowReference
- type ReleaseEnvironmentStatusUpdatedEvent
- type ReleaseEnvironmentUpdateMetadata
- type ReleaseEvent
- type ReleaseExpands
- type ReleaseGates
- type ReleaseGatesPhase
- type ReleaseManagementInputValue
- type ReleaseNotCreatedEvent
- type ReleaseQueryOrder
- type ReleaseReason
- type ReleaseReference
- type ReleaseRevision
- type ReleaseSchedule
- type ReleaseSettings
- type ReleaseShallowReference
- type ReleaseStartEnvironmentMetadata
- type ReleaseStartMetadata
- type ReleaseStatus
- type ReleaseTask
- type ReleaseTaskAttachment
- type ReleaseTaskLogUpdatedEvent
- type ReleaseTasksUpdatedEvent
- type ReleaseTriggerBase
- type ReleaseTriggerType
- type ReleaseUpdateMetadata
- type ReleaseUpdatedEvent
- type ReleaseWorkItemRef
- type RetentionPolicy
- type RetentionSettings
- type RunOnServerDeployPhase
- type ScheduleDays
- type ScheduledReleaseTrigger
- type SenderType
- type ServerDeploymentInput
- type SingleReleaseExpands
- type SourceIdInput
- type SourcePullRequestVersion
- type SourceRepoTrigger
- type SummaryMailSection
- type TagFilter
- type TaskOrchestrationPlanGroupReference
- type TaskOrchestrationPlanGroupsStartedEvent
- type TaskStatus
- type TfvcArtifactDownloadInput
- type TimeZone
- type TimeZoneList
- type UpdateFolderArgs
- type UpdateGatesArgs
- type UpdateManualInterventionArgs
- type UpdateReleaseApprovalArgs
- type UpdateReleaseArgs
- type UpdateReleaseDefinitionArgs
- type UpdateReleaseEnvironmentArgs
- type UpdateReleaseResourceArgs
- type VariableGroup
- type VariableGroupActionFilter
- type VariableGroupProjectReference
- type VariableGroupProviderData
- type VariableValue
- type WorkflowTask
- type WorkflowTaskReference
- type YamlFileSourceTypes
Constants ¶
This section is empty.
Variables ¶
var AgentArtifactTypeValues = agentArtifactTypeValuesType{
XamlBuild: "xamlBuild",
Build: "build",
Jenkins: "jenkins",
FileShare: "fileShare",
Nuget: "nuget",
TfsOnPrem: "tfsOnPrem",
GitHub: "gitHub",
TfGit: "tfGit",
ExternalTfsBuild: "externalTfsBuild",
Custom: "custom",
Tfvc: "tfvc",
}
var ApprovalExecutionOrderValues = approvalExecutionOrderValuesType{
BeforeGates: "beforeGates",
AfterSuccessfulGates: "afterSuccessfulGates",
AfterGatesAlways: "afterGatesAlways",
}
var ApprovalFiltersValues = approvalFiltersValuesType{
None: "none",
ManualApprovals: "manualApprovals",
AutomatedApprovals: "automatedApprovals",
ApprovalSnapshots: "approvalSnapshots",
All: "all",
}
var ApprovalStatusValues = approvalStatusValuesType{
Undefined: "undefined",
Pending: "pending",
Approved: "approved",
Rejected: "rejected",
Reassigned: "reassigned",
Canceled: "canceled",
Skipped: "skipped",
}
var ApprovalTypeValues = approvalTypeValuesType{
Undefined: "undefined",
PreDeploy: "preDeploy",
PostDeploy: "postDeploy",
All: "all",
}
var AuditActionValues = auditActionValuesType{
Add: "add",
Update: "update",
Delete: "delete",
Undelete: "undelete",
}
var AuthorizationHeaderForValues = authorizationHeaderForValuesType{
RevalidateApproverIdentity: "revalidateApproverIdentity",
OnBehalfOf: "onBehalfOf",
}
var ConditionTypeValues = conditionTypeValuesType{ Undefined: "undefined", Event: "event", EnvironmentState: "environmentState", Artifact: "artifact", }
var DeployPhaseStatusValues = deployPhaseStatusValuesType{
Undefined: "undefined",
NotStarted: "notStarted",
InProgress: "inProgress",
PartiallySucceeded: "partiallySucceeded",
Succeeded: "succeeded",
Failed: "failed",
Canceled: "canceled",
Skipped: "skipped",
Cancelling: "cancelling",
}
var DeployPhaseTypesValues = deployPhaseTypesValuesType{
Undefined: "undefined",
AgentBasedDeployment: "agentBasedDeployment",
RunOnServer: "runOnServer",
MachineGroupBasedDeployment: "machineGroupBasedDeployment",
DeploymentGates: "deploymentGates",
}
var DeploymentAuthorizationOwnerValues = deploymentAuthorizationOwnerValuesType{
Automatic: "automatic",
DeploymentSubmitter: "deploymentSubmitter",
FirstPreDeploymentApprover: "firstPreDeploymentApprover",
}
var DeploymentExpandsValues = deploymentExpandsValuesType{
All: "all",
DeploymentOnly: "deploymentOnly",
Approvals: "approvals",
Artifacts: "artifacts",
}
var DeploymentOperationStatusValues = deploymentOperationStatusValuesType{
Undefined: "undefined",
Queued: "queued",
Scheduled: "scheduled",
Pending: "pending",
Approved: "approved",
Rejected: "rejected",
Deferred: "deferred",
QueuedForAgent: "queuedForAgent",
PhaseInProgress: "phaseInProgress",
PhaseSucceeded: "phaseSucceeded",
PhasePartiallySucceeded: "phasePartiallySucceeded",
PhaseFailed: "phaseFailed",
Canceled: "canceled",
PhaseCanceled: "phaseCanceled",
ManualInterventionPending: "manualInterventionPending",
QueuedForPipeline: "queuedForPipeline",
Cancelling: "cancelling",
EvaluatingGates: "evaluatingGates",
GateFailed: "gateFailed",
All: "all",
}
var DeploymentReasonValues = deploymentReasonValuesType{
None: "none",
Manual: "manual",
Automated: "automated",
Scheduled: "scheduled",
RedeployTrigger: "redeployTrigger",
}
var DeploymentStatusValues = deploymentStatusValuesType{
Undefined: "undefined",
NotDeployed: "notDeployed",
InProgress: "inProgress",
Succeeded: "succeeded",
PartiallySucceeded: "partiallySucceeded",
Failed: "failed",
All: "all",
}
var DeploymentsQueryTypeValues = deploymentsQueryTypeValuesType{
Regular: "regular",
FailingSince: "failingSince",
}
var EnvironmentStatusValues = environmentStatusValuesType{
Undefined: "undefined",
NotStarted: "notStarted",
InProgress: "inProgress",
Succeeded: "succeeded",
Canceled: "canceled",
Rejected: "rejected",
Queued: "queued",
Scheduled: "scheduled",
PartiallySucceeded: "partiallySucceeded",
}
var EnvironmentTriggerTypeValues = environmentTriggerTypeValuesType{
Undefined: "undefined",
DeploymentGroupRedeploy: "deploymentGroupRedeploy",
RollbackRedeploy: "rollbackRedeploy",
}
var FolderPathQueryOrderValues = folderPathQueryOrderValuesType{
None: "none",
Ascending: "ascending",
Descending: "descending",
}
var GateStatusValues = gateStatusValuesType{
None: "none",
Pending: "pending",
InProgress: "inProgress",
Succeeded: "succeeded",
Failed: "failed",
Canceled: "canceled",
}
var IssueSourceValues = issueSourceValuesType{
None: "none",
User: "user",
System: "system",
}
var MailSectionTypeValues = mailSectionTypeValuesType{
Details: "details",
Environments: "environments",
Issues: "issues",
TestResults: "testResults",
WorkItems: "workItems",
ReleaseInfo: "releaseInfo",
}
var ManualInterventionStatusValues = manualInterventionStatusValuesType{
Unknown: "unknown",
Pending: "pending",
Rejected: "rejected",
Approved: "approved",
Canceled: "canceled",
}
var ParallelExecutionTypesValues = parallelExecutionTypesValuesType{
None: "none",
MultiConfiguration: "multiConfiguration",
MultiMachine: "multiMachine",
}
var PipelineProcessTypesValues = pipelineProcessTypesValuesType{
Designer: "designer",
Yaml: "yaml",
}
var PropertySelectorTypeValues = propertySelectorTypeValuesType{
Inclusion: "inclusion",
Exclusion: "exclusion",
}
var PullRequestSystemTypeValues = pullRequestSystemTypeValuesType{
None: "none",
TfsGit: "tfsGit",
GitHub: "gitHub",
}
var ReleaseDefinitionExpandsValues = releaseDefinitionExpandsValuesType{
None: "none",
Environments: "environments",
Artifacts: "artifacts",
Triggers: "triggers",
Variables: "variables",
Tags: "tags",
LastRelease: "lastRelease",
}
var ReleaseDefinitionQueryOrderValues = releaseDefinitionQueryOrderValuesType{
IdAscending: "idAscending",
IdDescending: "idDescending",
NameAscending: "nameAscending",
NameDescending: "nameDescending",
}
var ReleaseDefinitionSourceValues = releaseDefinitionSourceValuesType{
Undefined: "undefined",
RestApi: "restApi",
UserInterface: "userInterface",
Ibiza: "ibiza",
PortalExtensionApi: "portalExtensionApi",
}
var ReleaseEnvironmentExpandsValues = releaseEnvironmentExpandsValuesType{
None: "none",
Tasks: "tasks",
}
var ReleaseExpandsValues = releaseExpandsValuesType{
None: "none",
Environments: "environments",
Artifacts: "artifacts",
Approvals: "approvals",
ManualInterventions: "manualInterventions",
Variables: "variables",
Tags: "tags",
}
var ReleaseQueryOrderValues = releaseQueryOrderValuesType{
Descending: "descending",
Ascending: "ascending",
}
var ReleaseReasonValues = releaseReasonValuesType{
None: "none",
Manual: "manual",
ContinuousIntegration: "continuousIntegration",
Schedule: "schedule",
PullRequest: "pullRequest",
}
var ReleaseStatusValues = releaseStatusValuesType{
Undefined: "undefined",
Draft: "draft",
Active: "active",
Abandoned: "abandoned",
}
var ReleaseTriggerTypeValues = releaseTriggerTypeValuesType{
Undefined: "undefined",
ArtifactSource: "artifactSource",
Schedule: "schedule",
SourceRepo: "sourceRepo",
ContainerImage: "containerImage",
Package: "package",
PullRequest: "pullRequest",
}
var ResourceAreaId, _ = uuid.Parse("efc2f575-36ef-48e9-b672-0c6fb4a48ac5")
var ScheduleDaysValues = scheduleDaysValuesType{
None: "none",
Monday: "monday",
Tuesday: "tuesday",
Wednesday: "wednesday",
Thursday: "thursday",
Friday: "friday",
Saturday: "saturday",
Sunday: "sunday",
All: "all",
}
var SenderTypeValues = senderTypeValuesType{
ServiceAccount: "serviceAccount",
RequestingUser: "requestingUser",
}
var SingleReleaseExpandsValues = singleReleaseExpandsValuesType{
None: "none",
Tasks: "tasks",
}
var TaskStatusValues = taskStatusValuesType{
Unknown: "unknown",
Pending: "pending",
InProgress: "inProgress",
Success: "success",
Failure: "failure",
Canceled: "canceled",
Skipped: "skipped",
Succeeded: "succeeded",
Failed: "failed",
PartiallySucceeded: "partiallySucceeded",
}
var VariableGroupActionFilterValues = variableGroupActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var YamlFileSourceTypesValues = yamlFileSourceTypesValuesType{
None: "none",
TfsGit: "tfsGit",
}
Functions ¶
This section is empty.
Types ¶
type AgentArtifactDefinition ¶
type AgentArtifactDefinition struct { // Gets or sets the artifact definition alias. Alias *string `json:"alias,omitempty"` // Gets or sets the artifact type. ArtifactType *AgentArtifactType `json:"artifactType,omitempty"` // Gets or sets the artifact definition details. Details *string `json:"details,omitempty"` // Gets or sets the name of artifact definition. Name *string `json:"name,omitempty"` // Gets or sets the version of artifact definition. Version *string `json:"version,omitempty"` }
type AgentArtifactType ¶
type AgentArtifactType string
type AgentBasedDeployPhase ¶
type AgentBasedDeployPhase struct { // Gets and sets the name of deploy phase. Name *string `json:"name,omitempty"` // Indicates the deploy phase type. PhaseType *DeployPhaseTypes `json:"phaseType,omitempty"` // Gets and sets the rank of deploy phase. Rank *int `json:"rank,omitempty"` // Gets and sets the reference name of deploy phase. RefName *string `json:"refName,omitempty"` // Gets and sets the workflow tasks for the deploy phase. WorkflowTasks *[]WorkflowTask `json:"workflowTasks,omitempty"` // Gets and sets the agent job deployment input DeploymentInput *AgentDeploymentInput `json:"deploymentInput,omitempty"` }
type AgentDeploymentInput ¶
type AgentDeploymentInput struct { // Gets or sets the job condition. Condition *string `json:"condition,omitempty"` // Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment. JobCancelTimeoutInMinutes *int `json:"jobCancelTimeoutInMinutes,omitempty"` // Gets or sets the override inputs. OverrideInputs *map[string]string `json:"overrideInputs,omitempty"` // Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` // Artifacts that downloaded during job execution. ArtifactsDownloadInput *ArtifactsDownloadInput `json:"artifactsDownloadInput,omitempty"` // List demands that needs to meet to execute the job. Demands *[]interface{} `json:"demands,omitempty"` // Indicates whether to include access token in deployment job or not. EnableAccessToken *bool `json:"enableAccessToken,omitempty"` // Id of the pool on which job get executed. QueueId *int `json:"queueId,omitempty"` // Indicates whether artifacts downloaded while job execution or not. SkipArtifactsDownload *bool `json:"skipArtifactsDownload,omitempty"` // Specification for an agent on which a job gets executed. AgentSpecification *AgentSpecification `json:"agentSpecification,omitempty"` // Gets or sets the image ID. ImageId *int `json:"imageId,omitempty"` // Gets or sets the parallel execution input. ParallelExecution *ExecutionInput `json:"parallelExecution,omitempty"` }
type AgentSpecification ¶
type AgentSpecification struct { // Agent specification unique identifier. Identifier *string `json:"identifier,omitempty"` }
Specification of the agent defined by the pool provider.
type ApprovalOptions ¶
type ApprovalOptions struct { // Specify whether the approval can be skipped if the same approver approved the previous stage. AutoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped *bool `json:"autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped,omitempty"` // Specify whether revalidate identity of approver before completing the approval. EnforceIdentityRevalidation *bool `json:"enforceIdentityRevalidation,omitempty"` // Approvals execution order. ExecutionOrder *ApprovalExecutionOrder `json:"executionOrder,omitempty"` // Specify whether the user requesting a release or deployment should allow to approver. ReleaseCreatorCanBeApprover *bool `json:"releaseCreatorCanBeApprover,omitempty"` // The number of approvals required to move release forward. '0' means all approvals required. RequiredApproverCount *int `json:"requiredApproverCount,omitempty"` // Approval timeout. Approval default timeout is 30 days. Maximum allowed timeout is 365 days. '0' means default timeout i.e 30 days. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` }
type ApprovalStatus ¶
type ApprovalStatus string
type ApprovalType ¶
type ApprovalType string
type Artifact ¶
type Artifact struct { // Gets or sets alias. Alias *string `json:"alias,omitempty"` // 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"}}. DefinitionReference *map[string]ArtifactSourceReference `json:"definitionReference,omitempty"` // Indicates whether artifact is primary or not. IsPrimary *bool `json:"isPrimary,omitempty"` // Indicates whether artifact is retained by release or not. IsRetained *bool `json:"isRetained,omitempty"` // Deprecated: This property is deprecated use Alias instead and remove all its references SourceId *string `json:"sourceId,omitempty"` // Gets or sets type. It can have value as 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'. Type *string `json:"type,omitempty"` }
type ArtifactContributionDefinition ¶
type ArtifactContributionDefinition struct { ArtifactTriggerConfiguration *ArtifactTriggerConfiguration `json:"artifactTriggerConfiguration,omitempty"` ArtifactType *string `json:"artifactType,omitempty"` ArtifactTypeStreamMapping *map[string]string `json:"artifactTypeStreamMapping,omitempty"` BrowsableArtifactTypeMapping *map[string]string `json:"browsableArtifactTypeMapping,omitempty"` DataSourceBindings *[]DataSourceBinding `json:"dataSourceBindings,omitempty"` DisplayName *string `json:"displayName,omitempty"` DownloadTaskId *string `json:"downloadTaskId,omitempty"` EndpointTypeId *string `json:"endpointTypeId,omitempty"` InputDescriptors *[]forminput.InputDescriptor `json:"inputDescriptors,omitempty"` IsCommitsTraceabilitySupported *bool `json:"isCommitsTraceabilitySupported,omitempty"` IsWorkitemsTraceabilitySupported *bool `json:"isWorkitemsTraceabilitySupported,omitempty"` Name *string `json:"name,omitempty"` TaskInputMapping *map[string]string `json:"taskInputMapping,omitempty"` UniqueSourceIdentifier *string `json:"uniqueSourceIdentifier,omitempty"` }
type ArtifactDownloadInputBase ¶
type ArtifactDownloadInputBase struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'. ArtifactDownloadMode *string `json:"artifactDownloadMode,omitempty"` // Gets or sets the artifact items of the input. ArtifactItems *[]string `json:"artifactItems,omitempty"` // Gets or sets the type of artifact. ArtifactType *string `json:"artifactType,omitempty"` }
type ArtifactFilter ¶
type ArtifactFilter struct { // Gets or sets whether a release should be created on build tagging. CreateReleaseOnBuildTagging *bool `json:"createReleaseOnBuildTagging,omitempty"` // Gets or sets the branch for the filter. SourceBranch *string `json:"sourceBranch,omitempty"` // Gets or sets the regex based tag filter. TagFilter *TagFilter `json:"tagFilter,omitempty"` // Gets or sets the list of tags for the filter. Tags *[]string `json:"tags,omitempty"` // Gets or sets whether filter should default to build definition branch. UseBuildDefinitionBranch *bool `json:"useBuildDefinitionBranch,omitempty"` }
type ArtifactInstanceData ¶
type ArtifactMetadata ¶
type ArtifactMetadata struct { // Sets alias of artifact. Alias *string `json:"alias,omitempty"` // Sets instance reference of artifact. e.g. for build artifact it is build number. InstanceReference *BuildVersion `json:"instanceReference,omitempty"` }
type ArtifactProvider ¶
type ArtifactProvider struct { // Gets or sets the id of artifact provider. Id *int `json:"id,omitempty"` // Gets or sets the name of artifact provider. Name *string `json:"name,omitempty"` // Gets or sets the link of artifact provider. SourceUri *string `json:"sourceUri,omitempty"` // Gets or sets the version of artifact provider. Version *string `json:"version,omitempty"` }
type ArtifactSourceId ¶
type ArtifactSourceId struct { // Gets or sets the artifact type of artifact source. ArtifactTypeId *string `json:"artifactTypeId,omitempty"` // Gets or sets the list of sourceIdInput of artifact source. SourceIdInputs *[]SourceIdInput `json:"sourceIdInputs,omitempty"` }
type ArtifactSourceIdsQueryResult ¶
type ArtifactSourceIdsQueryResult struct { // Gets or sets the list of artifactsourceIds. ArtifactSourceIds *[]ArtifactSourceId `json:"artifactSourceIds,omitempty"` }
type ArtifactSourceReference ¶
type ArtifactSourceTrigger ¶
type ArtifactSourceTrigger struct { // Type of release trigger. TriggerType *ReleaseTriggerType `json:"triggerType,omitempty"` // Artifact source alias for Artifact Source trigger type ArtifactAlias *string `json:"artifactAlias,omitempty"` TriggerConditions *[]ArtifactFilter `json:"triggerConditions,omitempty"` }
type ArtifactTriggerConfiguration ¶
type ArtifactTriggerConfiguration struct { // Gets or sets the whether trigger is supported or not. IsTriggerSupported *bool `json:"isTriggerSupported,omitempty"` // Gets or sets the whether trigger is supported only on hosted environment. IsTriggerSupportedOnlyInHosted *bool `json:"isTriggerSupportedOnlyInHosted,omitempty"` // Gets or sets the whether webhook is supported at server level. IsWebhookSupportedAtServerLevel *bool `json:"isWebhookSupportedAtServerLevel,omitempty"` // Gets or sets the payload hash header name for the artifact trigger configuration. PayloadHashHeaderName *string `json:"payloadHashHeaderName,omitempty"` // Gets or sets the resources for artifact trigger configuration. Resources *map[string]string `json:"resources,omitempty"` // Gets or sets the webhook payload mapping for artifact trigger configuration. WebhookPayloadMapping *map[string]string `json:"webhookPayloadMapping,omitempty"` }
type ArtifactTypeDefinition ¶
type ArtifactTypeDefinition struct { // Gets or sets the artifact trigger configuration of artifact type definition. ArtifactTriggerConfiguration *ArtifactTriggerConfiguration `json:"artifactTriggerConfiguration,omitempty"` // Gets or sets the artifact type of artifact type definition. Valid values are 'Build', 'Package', 'Source' or 'ContainerImage'. ArtifactType *string `json:"artifactType,omitempty"` // Gets or sets the display name of artifact type definition. DisplayName *string `json:"displayName,omitempty"` // Gets or sets the endpoint type id of artifact type definition. EndpointTypeId *string `json:"endpointTypeId,omitempty"` // Gets or sets the input descriptors of artifact type definition. InputDescriptors *[]forminput.InputDescriptor `json:"inputDescriptors,omitempty"` // Gets or sets the is commits tracebility supported value of artifact type defintion. IsCommitsTraceabilitySupported *bool `json:"isCommitsTraceabilitySupported,omitempty"` // Gets or sets the is workitems tracebility supported value of artifact type defintion. IsWorkitemsTraceabilitySupported *bool `json:"isWorkitemsTraceabilitySupported,omitempty"` // Gets or sets the name of artifact type definition. Name *string `json:"name,omitempty"` // Gets or sets the unique source identifier of artifact type definition. UniqueSourceIdentifier *string `json:"uniqueSourceIdentifier,omitempty"` }
type ArtifactVersion ¶
type ArtifactVersion struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the default version of artifact. DefaultVersion *BuildVersion `json:"defaultVersion,omitempty"` // Gets or sets the error message encountered during querying of versions for artifact. ErrorMessage *string `json:"errorMessage,omitempty"` // Deprecated: This property is deprecated use Alias instead and remove all its references SourceId *string `json:"sourceId,omitempty"` // Gets or sets the list of build versions of artifact. Versions *[]BuildVersion `json:"versions,omitempty"` }
type ArtifactVersionQueryResult ¶
type ArtifactVersionQueryResult struct { // Gets or sets the list for artifact versions of artifact version query result. ArtifactVersions *[]ArtifactVersion `json:"artifactVersions,omitempty"` }
type ArtifactsDownloadInput ¶
type ArtifactsDownloadInput struct {
DownloadInputs *[]ArtifactDownloadInputBase `json:"downloadInputs,omitempty"`
}
type AuditAction ¶
type AuditAction string
type AuthorizationHeaderFor ¶
type AuthorizationHeaderFor string
type AutoTriggerIssue ¶
type AutoTriggerIssue struct { Issue *Issue `json:"issue,omitempty"` IssueSource *IssueSource `json:"issueSource,omitempty"` Project *ProjectReference `json:"project,omitempty"` ReleaseDefinitionReference *ReleaseDefinitionShallowReference `json:"releaseDefinitionReference,omitempty"` ReleaseTriggerType *ReleaseTriggerType `json:"releaseTriggerType,omitempty"` }
type AzureKeyVaultVariableGroupProviderData ¶
type AzureKeyVaultVariableGroupProviderData struct { // Gets or sets last refreshed time. LastRefreshedOn *azuredevops.Time `json:"lastRefreshedOn,omitempty"` // Gets or sets the service endpoint ID. ServiceEndpointId *uuid.UUID `json:"serviceEndpointId,omitempty"` // Gets or sets the vault name. Vault *string `json:"vault,omitempty"` }
type AzureKeyVaultVariableValue ¶
type AzureKeyVaultVariableValue struct { // Gets or sets if the variable is read only or not. IsReadOnly *bool `json:"isReadOnly,omitempty"` // Gets or sets as the variable is secret or not. IsSecret *bool `json:"isSecret,omitempty"` // Gets or sets the value. Value *string `json:"value,omitempty"` // Gets or sets the content type of key vault variable value. ContentType *string `json:"contentType,omitempty"` // Indicates the vault variable value enabled or not. Enabled *bool `json:"enabled,omitempty"` // Gets or sets the expire time of key vault variable value. Expires *azuredevops.Time `json:"expires,omitempty"` }
type BaseDeploymentInput ¶
type BaseDeploymentInput struct { // Gets or sets the job condition. Condition *string `json:"condition,omitempty"` // Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment. JobCancelTimeoutInMinutes *int `json:"jobCancelTimeoutInMinutes,omitempty"` // Gets or sets the override inputs. OverrideInputs *map[string]string `json:"overrideInputs,omitempty"` // Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` }
type BuildArtifactDownloadInput ¶
type BuildArtifactDownloadInput struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'. ArtifactDownloadMode *string `json:"artifactDownloadMode,omitempty"` // Gets or sets the artifact items of the input. ArtifactItems *[]string `json:"artifactItems,omitempty"` // Gets or sets the type of artifact. ArtifactType *string `json:"artifactType,omitempty"` }
type BuildVersion ¶
type BuildVersion struct { // Gets or sets the commit message for the artifact. CommitMessage *string `json:"commitMessage,omitempty"` // Gets or sets the definition id. DefinitionId *string `json:"definitionId,omitempty"` // Gets or sets the definition name. DefinitionName *string `json:"definitionName,omitempty"` // Gets or sets the build id. Id *string `json:"id,omitempty"` // Gets or sets if the artifact supports multiple definitions. IsMultiDefinitionType *bool `json:"isMultiDefinitionType,omitempty"` // Gets or sets the build number. Name *string `json:"name,omitempty"` // Gets or sets the source branch for the artifact. SourceBranch *string `json:"sourceBranch,omitempty"` // Gets or sets the source pull request version for the artifact. SourcePullRequestVersion *SourcePullRequestVersion `json:"sourcePullRequestVersion,omitempty"` // Gets or sets the repository id for the artifact. SourceRepositoryId *string `json:"sourceRepositoryId,omitempty"` // Gets or sets the repository type for the artifact. SourceRepositoryType *string `json:"sourceRepositoryType,omitempty"` // Gets or sets the source version for the artifact. SourceVersion *string `json:"sourceVersion,omitempty"` }
type Change ¶
type Change struct { // The author of the change. Author *webapi.IdentityRef `json:"author,omitempty"` // The location of a user-friendly representation of the resource. DisplayUri *string `json:"displayUri,omitempty"` // The type of source. "TfsVersionControl", "TfsGit", etc. ChangeType *string `json:"changeType,omitempty"` // Something that identifies the change. For a commit, this would be the SHA1. For a TFVC changeset, this would be the changeset id. Id *string `json:"id,omitempty"` // The location of the full representation of the resource. Location *string `json:"location,omitempty"` // A description of the change. This might be a commit message or changeset description. Message *string `json:"message,omitempty"` // The person or process that pushed the change. PushedBy *webapi.IdentityRef `json:"pushedBy,omitempty"` // Deprecated: Use PushedBy instead Pusher *string `json:"pusher,omitempty"` // A timestamp for the change. Timestamp *azuredevops.Time `json:"timestamp,omitempty"` }
Represents a change associated with a build.
type Client ¶
type Client interface { // [Preview API] Creates a new folder. CreateFolder(context.Context, CreateFolderArgs) (*Folder, error) // [Preview API] Create a release. CreateRelease(context.Context, CreateReleaseArgs) (*Release, error) // [Preview API] Create a release definition CreateReleaseDefinition(context.Context, CreateReleaseDefinitionArgs) (*ReleaseDefinition, error) // [Preview API] Deletes a definition folder for given folder name and path and all it's existing definitions. DeleteFolder(context.Context, DeleteFolderArgs) error // [Preview API] Delete a release definition. DeleteReleaseDefinition(context.Context, DeleteReleaseDefinitionArgs) error // [Preview API] Get a list of approvals GetApprovals(context.Context, GetApprovalsArgs) (*GetApprovalsResponseValue, error) // [Preview API] Get release definition for a given definitionId and revision GetDefinitionRevision(context.Context, GetDefinitionRevisionArgs) (io.ReadCloser, error) // [Preview API] GetDeployments(context.Context, GetDeploymentsArgs) (*GetDeploymentsResponseValue, error) // [Preview API] Gets folders. GetFolders(context.Context, GetFoldersArgs) (*[]Folder, error) // [Preview API] Get logs for a release Id. GetLogs(context.Context, GetLogsArgs) (io.ReadCloser, error) // [Preview API] Get manual intervention for a given release and manual intervention id. GetManualIntervention(context.Context, GetManualInterventionArgs) (*ManualIntervention, error) // [Preview API] List all manual interventions for a given release. GetManualInterventions(context.Context, GetManualInterventionsArgs) (*[]ManualIntervention, error) // [Preview API] Get a Release GetRelease(context.Context, GetReleaseArgs) (*Release, error) // [Preview API] Get a release definition. GetReleaseDefinition(context.Context, GetReleaseDefinitionArgs) (*ReleaseDefinition, error) // [Preview API] Get revision history for a release definition GetReleaseDefinitionHistory(context.Context, GetReleaseDefinitionHistoryArgs) (*[]ReleaseDefinitionRevision, error) // [Preview API] Get a list of release definitions. GetReleaseDefinitions(context.Context, GetReleaseDefinitionsArgs) (*GetReleaseDefinitionsResponseValue, error) // [Preview API] Get a release environment. GetReleaseEnvironment(context.Context, GetReleaseEnvironmentArgs) (*ReleaseEnvironment, error) // [Preview API] Get release for a given revision number. GetReleaseRevision(context.Context, GetReleaseRevisionArgs) (io.ReadCloser, error) // [Preview API] Get a list of releases GetReleases(context.Context, GetReleasesArgs) (*GetReleasesResponseValue, error) // [Preview API] Get a release task attachment. GetReleaseTaskAttachmentContent(context.Context, GetReleaseTaskAttachmentContentArgs) (io.ReadCloser, error) // [Preview API] Get the release task attachments. GetReleaseTaskAttachments(context.Context, GetReleaseTaskAttachmentsArgs) (*[]ReleaseTaskAttachment, error) // [Preview API] Gets the task log of a release as a plain text file. GetTaskLog(context.Context, GetTaskLogArgs) (io.ReadCloser, error) // [Preview API] Updates an existing folder at given existing path. UpdateFolder(context.Context, UpdateFolderArgs) (*Folder, error) // [Preview API] Updates the gate for a deployment. UpdateGates(context.Context, UpdateGatesArgs) (*ReleaseGates, error) // [Preview API] Update manual intervention. UpdateManualIntervention(context.Context, UpdateManualInterventionArgs) (*ManualIntervention, error) // [Preview API] Update a complete release object. UpdateRelease(context.Context, UpdateReleaseArgs) (*Release, error) // [Preview API] Update status of an approval UpdateReleaseApproval(context.Context, UpdateReleaseApprovalArgs) (*ReleaseApproval, error) // [Preview API] Update a release definition. UpdateReleaseDefinition(context.Context, UpdateReleaseDefinitionArgs) (*ReleaseDefinition, error) // [Preview API] Update the status of a release environment UpdateReleaseEnvironment(context.Context, UpdateReleaseEnvironmentArgs) (*ReleaseEnvironment, error) // [Preview API] Update few properties of a release. UpdateReleaseResource(context.Context, UpdateReleaseResourceArgs) (*Release, error) }
type ClientImpl ¶
type ClientImpl struct {
Client azuredevops.Client
}
func (*ClientImpl) CreateFolder ¶
func (client *ClientImpl) CreateFolder(ctx context.Context, args CreateFolderArgs) (*Folder, error)
[Preview API] Creates a new folder.
func (*ClientImpl) CreateRelease ¶
func (client *ClientImpl) CreateRelease(ctx context.Context, args CreateReleaseArgs) (*Release, error)
[Preview API] Create a release.
func (*ClientImpl) CreateReleaseDefinition ¶
func (client *ClientImpl) CreateReleaseDefinition(ctx context.Context, args CreateReleaseDefinitionArgs) (*ReleaseDefinition, error)
[Preview API] Create a release definition
func (*ClientImpl) DeleteFolder ¶
func (client *ClientImpl) DeleteFolder(ctx context.Context, args DeleteFolderArgs) error
[Preview API] Deletes a definition folder for given folder name and path and all it's existing definitions.
func (*ClientImpl) DeleteReleaseDefinition ¶
func (client *ClientImpl) DeleteReleaseDefinition(ctx context.Context, args DeleteReleaseDefinitionArgs) error
[Preview API] Delete a release definition.
func (*ClientImpl) GetApprovals ¶
func (client *ClientImpl) GetApprovals(ctx context.Context, args GetApprovalsArgs) (*GetApprovalsResponseValue, error)
[Preview API] Get a list of approvals
func (*ClientImpl) GetDefinitionRevision ¶
func (client *ClientImpl) GetDefinitionRevision(ctx context.Context, args GetDefinitionRevisionArgs) (io.ReadCloser, error)
[Preview API] Get release definition for a given definitionId and revision
func (*ClientImpl) GetDeployments ¶
func (client *ClientImpl) GetDeployments(ctx context.Context, args GetDeploymentsArgs) (*GetDeploymentsResponseValue, error)
[Preview API]
func (*ClientImpl) GetFolders ¶
func (client *ClientImpl) GetFolders(ctx context.Context, args GetFoldersArgs) (*[]Folder, error)
[Preview API] Gets folders.
func (*ClientImpl) GetLogs ¶
func (client *ClientImpl) GetLogs(ctx context.Context, args GetLogsArgs) (io.ReadCloser, error)
[Preview API] Get logs for a release Id.
func (*ClientImpl) GetManualIntervention ¶
func (client *ClientImpl) GetManualIntervention(ctx context.Context, args GetManualInterventionArgs) (*ManualIntervention, error)
[Preview API] Get manual intervention for a given release and manual intervention id.
func (*ClientImpl) GetManualInterventions ¶
func (client *ClientImpl) GetManualInterventions(ctx context.Context, args GetManualInterventionsArgs) (*[]ManualIntervention, error)
[Preview API] List all manual interventions for a given release.
func (*ClientImpl) GetRelease ¶
func (client *ClientImpl) GetRelease(ctx context.Context, args GetReleaseArgs) (*Release, error)
[Preview API] Get a Release
func (*ClientImpl) GetReleaseDefinition ¶
func (client *ClientImpl) GetReleaseDefinition(ctx context.Context, args GetReleaseDefinitionArgs) (*ReleaseDefinition, error)
[Preview API] Get a release definition.
func (*ClientImpl) GetReleaseDefinitionHistory ¶
func (client *ClientImpl) GetReleaseDefinitionHistory(ctx context.Context, args GetReleaseDefinitionHistoryArgs) (*[]ReleaseDefinitionRevision, error)
[Preview API] Get revision history for a release definition
func (*ClientImpl) GetReleaseDefinitions ¶
func (client *ClientImpl) GetReleaseDefinitions(ctx context.Context, args GetReleaseDefinitionsArgs) (*GetReleaseDefinitionsResponseValue, error)
[Preview API] Get a list of release definitions.
func (*ClientImpl) GetReleaseEnvironment ¶
func (client *ClientImpl) GetReleaseEnvironment(ctx context.Context, args GetReleaseEnvironmentArgs) (*ReleaseEnvironment, error)
[Preview API] Get a release environment.
func (*ClientImpl) GetReleaseRevision ¶
func (client *ClientImpl) GetReleaseRevision(ctx context.Context, args GetReleaseRevisionArgs) (io.ReadCloser, error)
[Preview API] Get release for a given revision number.
func (*ClientImpl) GetReleaseTaskAttachmentContent ¶
func (client *ClientImpl) GetReleaseTaskAttachmentContent(ctx context.Context, args GetReleaseTaskAttachmentContentArgs) (io.ReadCloser, error)
[Preview API] Get a release task attachment.
func (*ClientImpl) GetReleaseTaskAttachments ¶
func (client *ClientImpl) GetReleaseTaskAttachments(ctx context.Context, args GetReleaseTaskAttachmentsArgs) (*[]ReleaseTaskAttachment, error)
[Preview API] Get the release task attachments.
func (*ClientImpl) GetReleases ¶
func (client *ClientImpl) GetReleases(ctx context.Context, args GetReleasesArgs) (*GetReleasesResponseValue, error)
[Preview API] Get a list of releases
func (*ClientImpl) GetTaskLog ¶
func (client *ClientImpl) GetTaskLog(ctx context.Context, args GetTaskLogArgs) (io.ReadCloser, error)
[Preview API] Gets the task log of a release as a plain text file.
func (*ClientImpl) UpdateFolder ¶
func (client *ClientImpl) UpdateFolder(ctx context.Context, args UpdateFolderArgs) (*Folder, error)
[Preview API] Updates an existing folder at given existing path.
func (*ClientImpl) UpdateGates ¶
func (client *ClientImpl) UpdateGates(ctx context.Context, args UpdateGatesArgs) (*ReleaseGates, error)
[Preview API] Updates the gate for a deployment.
func (*ClientImpl) UpdateManualIntervention ¶
func (client *ClientImpl) UpdateManualIntervention(ctx context.Context, args UpdateManualInterventionArgs) (*ManualIntervention, error)
[Preview API] Update manual intervention.
func (*ClientImpl) UpdateRelease ¶
func (client *ClientImpl) UpdateRelease(ctx context.Context, args UpdateReleaseArgs) (*Release, error)
[Preview API] Update a complete release object.
func (*ClientImpl) UpdateReleaseApproval ¶
func (client *ClientImpl) UpdateReleaseApproval(ctx context.Context, args UpdateReleaseApprovalArgs) (*ReleaseApproval, error)
[Preview API] Update status of an approval
func (*ClientImpl) UpdateReleaseDefinition ¶
func (client *ClientImpl) UpdateReleaseDefinition(ctx context.Context, args UpdateReleaseDefinitionArgs) (*ReleaseDefinition, error)
[Preview API] Update a release definition.
func (*ClientImpl) UpdateReleaseEnvironment ¶
func (client *ClientImpl) UpdateReleaseEnvironment(ctx context.Context, args UpdateReleaseEnvironmentArgs) (*ReleaseEnvironment, error)
[Preview API] Update the status of a release environment
func (*ClientImpl) UpdateReleaseResource ¶
func (client *ClientImpl) UpdateReleaseResource(ctx context.Context, args UpdateReleaseResourceArgs) (*Release, error)
[Preview API] Update few properties of a release.
type CodeRepositoryReference ¶
type CodeRepositoryReference struct { // Gets and sets the repository references. RepositoryReference *map[string]ReleaseManagementInputValue `json:"repositoryReference,omitempty"` // It can have value as ‘GitHub’, ‘Vsts’. SystemType *PullRequestSystemType `json:"systemType,omitempty"` }
type ComplianceSettings ¶
type ComplianceSettings struct { // Scan the release definition for secrets CheckForCredentialsAndOtherSecrets *bool `json:"checkForCredentialsAndOtherSecrets,omitempty"` }
type Condition ¶
type Condition struct { // Gets or sets the condition type. ConditionType *ConditionType `json:"conditionType,omitempty"` // Gets or sets the name of the condition. e.g. 'ReleaseStarted'. Name *string `json:"name,omitempty"` // Gets or set value of the condition. Value *string `json:"value,omitempty"` }
type ConditionType ¶
type ConditionType string
type ConfigurationVariableValue ¶
type ConfigurationVariableValue struct { // Gets and sets if a variable can be overridden at deployment time or not. AllowOverride *bool `json:"allowOverride,omitempty"` // Gets or sets as variable is secret or not. IsSecret *bool `json:"isSecret,omitempty"` // Gets and sets value of the configuration variable. Value *string `json:"value,omitempty"` }
type ContainerImageTrigger ¶
type ContainerImageTrigger struct { // Type of release trigger. TriggerType *ReleaseTriggerType `json:"triggerType,omitempty"` // Alias of the trigger. Alias *string `json:"alias,omitempty"` // List tag filters applied while trigger. TagFilters *[]TagFilter `json:"tagFilters,omitempty"` }
type ContinuousDeploymentTriggerIssue ¶
type ContinuousDeploymentTriggerIssue struct { Issue *Issue `json:"issue,omitempty"` IssueSource *IssueSource `json:"issueSource,omitempty"` Project *ProjectReference `json:"project,omitempty"` ReleaseDefinitionReference *ReleaseDefinitionShallowReference `json:"releaseDefinitionReference,omitempty"` ReleaseTriggerType *ReleaseTriggerType `json:"releaseTriggerType,omitempty"` // Artifact type. ArtifactType *string `json:"artifactType,omitempty"` // ArtifactVersion ID. ArtifactVersionId *string `json:"artifactVersionId,omitempty"` // Artifact source ID. SourceId *string `json:"sourceId,omitempty"` }
type ControlOptions ¶
type CreateFolderArgs ¶
type CreateFolderArgs struct { // (required) Folder to create. Folder *Folder // (required) Project ID or project name Project *string }
Arguments for the CreateFolder function
type CreateReleaseArgs ¶
type CreateReleaseArgs struct { // (required) Metadata to create a release. ReleaseStartMetadata *ReleaseStartMetadata // (required) Project ID or project name Project *string }
Arguments for the CreateRelease function
type CreateReleaseDefinitionArgs ¶
type CreateReleaseDefinitionArgs struct { // (required) release definition object to create. ReleaseDefinition *ReleaseDefinition // (required) Project ID or project name Project *string }
Arguments for the CreateReleaseDefinition function
type CustomArtifactDownloadInput ¶
type CustomArtifactDownloadInput struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'. ArtifactDownloadMode *string `json:"artifactDownloadMode,omitempty"` // Gets or sets the artifact items of the input. ArtifactItems *[]string `json:"artifactItems,omitempty"` // Gets or sets the type of artifact. ArtifactType *string `json:"artifactType,omitempty"` }
type DataSourceBinding ¶
type DataSourceBinding struct { // Pagination format supported by this data source(ContinuationToken/SkipTop). CallbackContextTemplate *string `json:"callbackContextTemplate,omitempty"` // Subsequent calls needed? CallBackRequiredTemplate *string `json:"callBackRequiredTemplate,omitempty"` // Name of the datasource. DataSourceName *string `json:"dataSourceName,omitempty"` // Endpoint ID of the datasource. EndpointId *string `json:"endpointId,omitempty"` // Endpoint URL of the datasource. EndpointUrl *string `json:"endpointUrl,omitempty"` // Defines the initial value of the query params InitialContextTemplate *string `json:"initialContextTemplate,omitempty"` // Parameters of the datasource. Parameters *map[string]string `json:"parameters,omitempty"` // Gets or sets http request body RequestContent *string `json:"requestContent,omitempty"` // Gets or sets http request verb RequestVerb *string `json:"requestVerb,omitempty"` // Result selector applied on output of datasource result, for example jsonpath:$.value[?(@.properties.isEnabled == true)]. ResultSelector *string `json:"resultSelector,omitempty"` // Format of the return results, for example. { "Value" : "{{{id}}}", "DisplayValue" : "{{{name}}}" }. ResultTemplate *string `json:"resultTemplate,omitempty"` // Target of the datasource. Target *string `json:"target,omitempty"` }
type DefinitionEnvironmentReference ¶
type DefinitionEnvironmentReference struct { // Definition environment ID. DefinitionEnvironmentId *int `json:"definitionEnvironmentId,omitempty"` // Definition environment name. DefinitionEnvironmentName *string `json:"definitionEnvironmentName,omitempty"` // ReleaseDefinition ID. ReleaseDefinitionId *int `json:"releaseDefinitionId,omitempty"` // ReleaseDefinition name. ReleaseDefinitionName *string `json:"releaseDefinitionName,omitempty"` }
type DeleteFolderArgs ¶
type DeleteFolderArgs struct { // (required) Project ID or project name Project *string // (required) Path of the folder to delete. Path *string }
Arguments for the DeleteFolder function
type DeleteReleaseDefinitionArgs ¶
type DeleteReleaseDefinitionArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release definition. DefinitionId *int // (optional) Comment for deleting a release definition. Comment *string // (optional) 'true' to automatically cancel any in-progress release deployments and proceed with release definition deletion . Default is 'false'. ForceDelete *bool }
Arguments for the DeleteReleaseDefinition function
type DeployPhase ¶
type DeployPhase struct { // Gets and sets the name of deploy phase. Name *string `json:"name,omitempty"` // Indicates the deploy phase type. PhaseType *DeployPhaseTypes `json:"phaseType,omitempty"` // Gets and sets the rank of deploy phase. Rank *int `json:"rank,omitempty"` // Gets and sets the reference name of deploy phase. RefName *string `json:"refName,omitempty"` // Gets and sets the workflow tasks for the deploy phase. WorkflowTasks *[]WorkflowTask `json:"workflowTasks,omitempty"` }
type Deployment ¶
type Deployment struct { // Deprecated: Use ReleaseReference instead. Links interface{} `json:"_links,omitempty"` // Gets attempt number. Attempt *int `json:"attempt,omitempty"` // Gets the date on which deployment is complete. CompletedOn *azuredevops.Time `json:"completedOn,omitempty"` // Gets the list of condition associated with deployment. Conditions *[]Condition `json:"conditions,omitempty"` // Gets release definition environment id. DefinitionEnvironmentId *int `json:"definitionEnvironmentId,omitempty"` // Gets status of the deployment. DeploymentStatus *DeploymentStatus `json:"deploymentStatus,omitempty"` // Gets the unique identifier for deployment. Id *int `json:"id,omitempty"` // Gets the identity who last modified the deployment. LastModifiedBy *webapi.IdentityRef `json:"lastModifiedBy,omitempty"` // Gets the date on which deployment is last modified. LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"` // Gets operation status of deployment. OperationStatus *DeploymentOperationStatus `json:"operationStatus,omitempty"` // Gets list of PostDeployApprovals. PostDeployApprovals *[]ReleaseApproval `json:"postDeployApprovals,omitempty"` // Gets list of PreDeployApprovals. PreDeployApprovals *[]ReleaseApproval `json:"preDeployApprovals,omitempty"` // Gets or sets project reference. ProjectReference *ProjectReference `json:"projectReference,omitempty"` // Gets the date on which deployment is queued. QueuedOn *azuredevops.Time `json:"queuedOn,omitempty"` // Gets reason of deployment. Reason *DeploymentReason `json:"reason,omitempty"` // Gets the reference of release. Release *ReleaseReference `json:"release,omitempty"` // Gets releaseDefinitionReference which specifies the reference of the release definition to which the deployment is associated. ReleaseDefinition *ReleaseDefinitionShallowReference `json:"releaseDefinition,omitempty"` // Gets releaseEnvironmentReference which specifies the reference of the release environment to which the deployment is associated. ReleaseEnvironment *ReleaseEnvironmentShallowReference `json:"releaseEnvironment,omitempty"` // Gets the identity who requested. RequestedBy *webapi.IdentityRef `json:"requestedBy,omitempty"` // Gets the identity for whom deployment is requested. RequestedFor *webapi.IdentityRef `json:"requestedFor,omitempty"` // Gets the date on which deployment is scheduled. ScheduledDeploymentTime *azuredevops.Time `json:"scheduledDeploymentTime,omitempty"` // Gets the date on which deployment is started. StartedOn *azuredevops.Time `json:"startedOn,omitempty"` }
type DeploymentApprovalCompletedEvent ¶
type DeploymentApprovalCompletedEvent struct { Id *int `json:"id,omitempty"` Url *string `json:"url,omitempty"` AttemptId *int `json:"attemptId,omitempty"` StageName *string `json:"stageName,omitempty"` Approval *ReleaseApproval `json:"approval,omitempty"` Project *ProjectReference `json:"project,omitempty"` Release *Release `json:"release,omitempty"` }
type DeploymentApprovalPendingEvent ¶
type DeploymentApprovalPendingEvent struct { Id *int `json:"id,omitempty"` Url *string `json:"url,omitempty"` AttemptId *int `json:"attemptId,omitempty"` StageName *string `json:"stageName,omitempty"` Approval *ReleaseApproval `json:"approval,omitempty"` ApprovalOptions *ApprovalOptions `json:"approvalOptions,omitempty"` CompletedApprovals *[]ReleaseApproval `json:"completedApprovals,omitempty"` Data *map[string]interface{} `json:"data,omitempty"` Deployment *Deployment `json:"deployment,omitempty"` IsMultipleRankApproval *bool `json:"isMultipleRankApproval,omitempty"` PendingApprovals *[]ReleaseApproval `json:"pendingApprovals,omitempty"` Project *ProjectReference `json:"project,omitempty"` Release *Release `json:"release,omitempty"` }
type DeploymentAttempt ¶
type DeploymentAttempt struct { // Deployment attempt. Attempt *int `json:"attempt,omitempty"` // ID of the deployment. DeploymentId *int `json:"deploymentId,omitempty"` // Deprecated: Instead use Issues which contains both errors and warnings related to deployment ErrorLog *string `json:"errorLog,omitempty"` // Specifies whether deployment has started or not. HasStarted *bool `json:"hasStarted,omitempty"` // ID of deployment. Id *int `json:"id,omitempty"` // All the issues related to the deployment. Issues *[]Issue `json:"issues,omitempty"` // Deprecated: Use ReleaseDeployPhase.DeploymentJobs.Job instead. Job *ReleaseTask `json:"job,omitempty"` // Identity who last modified this deployment. LastModifiedBy *webapi.IdentityRef `json:"lastModifiedBy,omitempty"` // Time when this deployment last modified. LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"` // Deployment operation status. OperationStatus *DeploymentOperationStatus `json:"operationStatus,omitempty"` // Post deployment gates that executed in this deployment. PostDeploymentGates *ReleaseGates `json:"postDeploymentGates,omitempty"` // Pre deployment gates that executed in this deployment. PreDeploymentGates *ReleaseGates `json:"preDeploymentGates,omitempty"` // When this deployment queued on. QueuedOn *azuredevops.Time `json:"queuedOn,omitempty"` // Reason for the deployment. Reason *DeploymentReason `json:"reason,omitempty"` // List of release deployphases executed in this deployment. ReleaseDeployPhases *[]ReleaseDeployPhase `json:"releaseDeployPhases,omitempty"` // Identity who requested this deployment. RequestedBy *webapi.IdentityRef `json:"requestedBy,omitempty"` // Identity for this deployment requested. RequestedFor *webapi.IdentityRef `json:"requestedFor,omitempty"` // Deprecated: Use ReleaseDeployPhase.RunPlanId instead. RunPlanId *uuid.UUID `json:"runPlanId,omitempty"` // status of the deployment. Status *DeploymentStatus `json:"status,omitempty"` // Deprecated: Use ReleaseDeployPhase.DeploymentJobs.Tasks instead. Tasks *[]ReleaseTask `json:"tasks,omitempty"` }
type DeploymentAuthorizationInfo ¶
type DeploymentAuthorizationInfo struct { // Authorization header type, typically either RevalidateApproverIdentity or OnBehalfOf. AuthorizationHeaderFor *AuthorizationHeaderFor `json:"authorizationHeaderFor,omitempty"` // List of resources. Resources *[]string `json:"resources,omitempty"` // ID of the tenant. TenantId *string `json:"tenantId,omitempty"` // Access token key. VstsAccessTokenKey *string `json:"vstsAccessTokenKey,omitempty"` }
type DeploymentAuthorizationOwner ¶
type DeploymentAuthorizationOwner string
type DeploymentCompletedEvent ¶
type DeploymentCompletedEvent struct { Id *int `json:"id,omitempty"` Url *string `json:"url,omitempty"` AttemptId *int `json:"attemptId,omitempty"` StageName *string `json:"stageName,omitempty"` Comment *string `json:"comment,omitempty"` Data *map[string]interface{} `json:"data,omitempty"` Deployment *Deployment `json:"deployment,omitempty"` Environment *ReleaseEnvironment `json:"environment,omitempty"` Project *ProjectReference `json:"project,omitempty"` }
type DeploymentEvent ¶
type DeploymentInput ¶
type DeploymentInput struct { // Gets or sets the job condition. Condition *string `json:"condition,omitempty"` // Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment. JobCancelTimeoutInMinutes *int `json:"jobCancelTimeoutInMinutes,omitempty"` // Gets or sets the override inputs. OverrideInputs *map[string]string `json:"overrideInputs,omitempty"` // Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` // Artifacts that downloaded during job execution. ArtifactsDownloadInput *ArtifactsDownloadInput `json:"artifactsDownloadInput,omitempty"` // List demands that needs to meet to execute the job. Demands *[]interface{} `json:"demands,omitempty"` // Indicates whether to include access token in deployment job or not. EnableAccessToken *bool `json:"enableAccessToken,omitempty"` // Id of the pool on which job get executed. QueueId *int `json:"queueId,omitempty"` // Indicates whether artifacts downloaded while job execution or not. SkipArtifactsDownload *bool `json:"skipArtifactsDownload,omitempty"` }
type DeploymentJob ¶
type DeploymentJob struct { // Parent task of all executed tasks. Job *ReleaseTask `json:"job,omitempty"` // List of executed tasks with in job. Tasks *[]ReleaseTask `json:"tasks,omitempty"` }
type DeploymentManualInterventionPendingEvent ¶
type DeploymentManualInterventionPendingEvent struct { Deployment *Deployment `json:"deployment,omitempty"` EmailRecipients *[]uuid.UUID `json:"emailRecipients,omitempty"` EnvironmentOwner *webapi.IdentityRef `json:"environmentOwner,omitempty"` ManualIntervention *ManualIntervention `json:"manualIntervention,omitempty"` Project *ProjectReference `json:"project,omitempty"` Release *Release `json:"release,omitempty"` }
type DeploymentQueryParameters ¶
type DeploymentQueryParameters struct { // Query deployments based specified artifact source id. ArtifactSourceId *string `json:"artifactSourceId,omitempty"` // Query deployments based specified artifact type id. ArtifactTypeId *string `json:"artifactTypeId,omitempty"` // Query deployments based specified artifact versions. ArtifactVersions *[]string `json:"artifactVersions,omitempty"` // Query deployments number of deployments per environment. DeploymentsPerEnvironment *int `json:"deploymentsPerEnvironment,omitempty"` // Query deployment based on deployment status. DeploymentStatus *DeploymentStatus `json:"deploymentStatus,omitempty"` // Query deployments of specified environments. Environments *[]DefinitionEnvironmentReference `json:"environments,omitempty"` // Query deployments based specified expands. Expands *DeploymentExpands `json:"expands,omitempty"` // Specify deleted deployments should return or not. IsDeleted *bool `json:"isDeleted,omitempty"` // Deprecated: LatestDeploymentsOnly *bool `json:"latestDeploymentsOnly,omitempty"` // Deprecated: MaxDeploymentsPerEnvironment *int `json:"maxDeploymentsPerEnvironment,omitempty"` // Deprecated: MaxModifiedTime *azuredevops.Time `json:"maxModifiedTime,omitempty"` // Deprecated: MinModifiedTime *azuredevops.Time `json:"minModifiedTime,omitempty"` // Query deployment based on deployment operation status. OperationStatus *DeploymentOperationStatus `json:"operationStatus,omitempty"` // Deprecated: QueryOrder *ReleaseQueryOrder `json:"queryOrder,omitempty"` // Query deployments based query type. QueryType *DeploymentsQueryType `json:"queryType,omitempty"` // Query deployments based specified source branch. SourceBranch *string `json:"sourceBranch,omitempty"` }
type DeploymentStartedEvent ¶
type DeploymentStartedEvent struct { Id *int `json:"id,omitempty"` Url *string `json:"url,omitempty"` AttemptId *int `json:"attemptId,omitempty"` StageName *string `json:"stageName,omitempty"` Environment *ReleaseEnvironment `json:"environment,omitempty"` Project *ProjectReference `json:"project,omitempty"` Release *Release `json:"release,omitempty"` }
type DeploymentsQueryType ¶
type DeploymentsQueryType string
type EmailRecipients ¶
type EnvironmentExecutionPolicy ¶
type EnvironmentExecutionPolicy struct { // This policy decides, how many environments would be with Environment Runner. ConcurrencyCount *int `json:"concurrencyCount,omitempty"` // Queue depth in the EnvironmentQueue table, this table keeps the environment entries till Environment Runner is free [as per it's policy] to take another environment for running. QueueDepthCount *int `json:"queueDepthCount,omitempty"` }
Defines policy on environment queuing at Release Management side queue. We will send to Environment Runner [creating pre-deploy and other steps] only when the policies mentioned are satisfied.
type EnvironmentOptions ¶
type EnvironmentOptions struct { // Gets and sets as the auto link workitems or not. AutoLinkWorkItems *bool `json:"autoLinkWorkItems,omitempty"` // Gets and sets as the badge enabled or not. BadgeEnabled *bool `json:"badgeEnabled,omitempty"` // Deprecated: Use Notifications instead. EmailNotificationType *string `json:"emailNotificationType,omitempty"` // Deprecated: Use Notifications instead. EmailRecipients *string `json:"emailRecipients,omitempty"` // Deprecated: Use DeploymentInput.EnableAccessToken instead. EnableAccessToken *bool `json:"enableAccessToken,omitempty"` // Gets and sets as the publish deployment status or not. PublishDeploymentStatus *bool `json:"publishDeploymentStatus,omitempty"` // Gets and sets as the.pull request deployment enabled or not. PullRequestDeploymentEnabled *bool `json:"pullRequestDeploymentEnabled,omitempty"` // Deprecated: Use DeploymentInput.SkipArtifactsDownload instead. SkipArtifactsDownload *bool `json:"skipArtifactsDownload,omitempty"` // Deprecated: Use DeploymentInput.TimeoutInMinutes instead. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` }
type EnvironmentRetentionPolicy ¶
type EnvironmentRetentionPolicy struct { // Gets and sets the number of days to keep environment. DaysToKeep *int `json:"daysToKeep,omitempty"` // Gets and sets the number of releases to keep. ReleasesToKeep *int `json:"releasesToKeep,omitempty"` // Gets and sets as the build to be retained or not. RetainBuild *bool `json:"retainBuild,omitempty"` }
type EnvironmentTrigger ¶
type EnvironmentTrigger struct { // Definition environment ID on which this trigger applicable. DefinitionEnvironmentId *int `json:"definitionEnvironmentId,omitempty"` // ReleaseDefinition ID on which this trigger applicable. ReleaseDefinitionId *int `json:"releaseDefinitionId,omitempty"` // Gets or sets the trigger content. TriggerContent *string `json:"triggerContent,omitempty"` // Gets or sets the trigger type. TriggerType *EnvironmentTriggerType `json:"triggerType,omitempty"` }
type EnvironmentTriggerType ¶
type EnvironmentTriggerType string
type ExecutionInput ¶
type ExecutionInput struct { // Parallel execution type, for example MultiConfiguration or MultiMachine. ParallelExecutionType *ParallelExecutionTypes `json:"parallelExecutionType,omitempty"` }
type FavoriteItem ¶
type FavoriteItem struct { // Application specific data for the entry. Data *string `json:"data,omitempty"` // Unique Id of the entry. Id *uuid.UUID `json:"id,omitempty"` // Display text for favorite entry. Name *string `json:"name,omitempty"` // Application specific favorite entry type. Empty or Null represents that Favorite item is a Folder. Type *string `json:"type,omitempty"` }
Class to represent favorite entry.
type Folder ¶
type Folder struct { // Identity who created this folder. CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"` // Time when this folder created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Description of the folder. Description *string `json:"description,omitempty"` // Identity who last changed this folder. LastChangedBy *webapi.IdentityRef `json:"lastChangedBy,omitempty"` // Time when this folder last changed. LastChangedDate *azuredevops.Time `json:"lastChangedDate,omitempty"` // path of the folder. Path *string `json:"path,omitempty"` }
type FolderPathQueryOrder ¶
type FolderPathQueryOrder string
type GateUpdateMetadata ¶
type GatesDeployPhase ¶
type GatesDeployPhase struct { // Gets and sets the name of deploy phase. Name *string `json:"name,omitempty"` // Indicates the deploy phase type. PhaseType *DeployPhaseTypes `json:"phaseType,omitempty"` // Gets and sets the rank of deploy phase. Rank *int `json:"rank,omitempty"` // Gets and sets the reference name of deploy phase. RefName *string `json:"refName,omitempty"` // Gets and sets the workflow tasks for the deploy phase. WorkflowTasks *[]WorkflowTask `json:"workflowTasks,omitempty"` // Gets and sets the gate job input. DeploymentInput *GatesDeploymentInput `json:"deploymentInput,omitempty"` }
type GatesDeploymentInput ¶
type GatesDeploymentInput struct { // Gets or sets the job condition. Condition *string `json:"condition,omitempty"` // Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment. JobCancelTimeoutInMinutes *int `json:"jobCancelTimeoutInMinutes,omitempty"` // Gets or sets the override inputs. OverrideInputs *map[string]string `json:"overrideInputs,omitempty"` // Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` // Gates minimum success duration. MinimumSuccessDuration *int `json:"minimumSuccessDuration,omitempty"` // Gates sampling interval. SamplingInterval *int `json:"samplingInterval,omitempty"` // Gates stabilization time. StabilizationTime *int `json:"stabilizationTime,omitempty"` }
type GetApprovalsArgs ¶
type GetApprovalsArgs struct { // (required) Project ID or project name Project *string // (optional) Approvals assigned to this user. AssignedToFilter *string // (optional) Approvals with this status. Default is 'pending'. StatusFilter *ApprovalStatus // (optional) Approvals for release id(s) mentioned in the filter. Multiple releases can be mentioned by separating them with ',' e.g. releaseIdsFilter=1,2,3,4. ReleaseIdsFilter *[]int // (optional) Approval with this type. TypeFilter *ApprovalType // (optional) Number of approvals to get. Default is 50. Top *int // (optional) Gets the approvals after the continuation token provided. ContinuationToken *int // (optional) Gets the results in the defined order of created approvals. Default is 'descending'. QueryOrder *ReleaseQueryOrder // (optional) 'true' to include my group approvals. Default is 'false'. IncludeMyGroupApprovals *bool }
Arguments for the GetApprovals function
type GetApprovalsResponseValue ¶
type GetApprovalsResponseValue struct { Value []ReleaseApproval ContinuationToken string }
Return type for the GetApprovals function
type GetDefinitionRevisionArgs ¶
type GetDefinitionRevisionArgs struct { // (required) Project ID or project name Project *string // (required) Id of the definition. DefinitionId *int // (required) Id of the revision. Revision *int }
Arguments for the GetDefinitionRevision function
type GetDeploymentsArgs ¶
type GetDeploymentsArgs struct { // (required) Project ID or project name Project *string // (optional) DefinitionId *int // (optional) DefinitionEnvironmentId *int // (optional) CreatedBy *string // (optional) MinModifiedTime *azuredevops.Time // (optional) MaxModifiedTime *azuredevops.Time // (optional) DeploymentStatus *DeploymentStatus // (optional) OperationStatus *DeploymentOperationStatus // (optional) LatestAttemptsOnly *bool // (optional) QueryOrder *ReleaseQueryOrder // (optional) Top *int // (optional) ContinuationToken *int // (optional) CreatedFor *string // (optional) MinStartedTime *azuredevops.Time // (optional) MaxStartedTime *azuredevops.Time // (optional) SourceBranch *string }
Arguments for the GetDeployments function
type GetDeploymentsResponseValue ¶
type GetDeploymentsResponseValue struct { Value []Deployment ContinuationToken string }
Return type for the GetDeployments function
type GetFoldersArgs ¶
type GetFoldersArgs struct { // (required) Project ID or project name Project *string // (optional) Path of the folder. Path *string // (optional) Gets the results in the defined order. Default is 'None'. QueryOrder *FolderPathQueryOrder }
Arguments for the GetFolders function
type GetLogsArgs ¶
type GetLogsArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int }
Arguments for the GetLogs function
type GetManualInterventionArgs ¶
type GetManualInterventionArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Id of the manual intervention. ManualInterventionId *int }
Arguments for the GetManualIntervention function
type GetManualInterventionsArgs ¶
type GetManualInterventionsArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int }
Arguments for the GetManualInterventions function
type GetReleaseArgs ¶
type GetReleaseArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (optional) A filter which would allow fetching approval steps selectively based on whether it is automated, or manual. This would also decide whether we should fetch pre and post approval snapshots. Assumes All by default ApprovalFilters *ApprovalFilters // (optional) A comma-delimited list of extended properties to be retrieved. If set, the returned Release will contain values for the specified property Ids (if they exist). If not set, properties will not be included. PropertyFilters *[]string // (optional) A property that should be expanded in the release. Expand *SingleReleaseExpands // (optional) Number of release gate records to get. Default is 5. TopGateRecords *int }
Arguments for the GetRelease function
type GetReleaseDefinitionArgs ¶
type GetReleaseDefinitionArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release definition. DefinitionId *int // (optional) A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definition will contain values for the specified property Ids (if they exist). If not set, properties will not be included. PropertyFilters *[]string }
Arguments for the GetReleaseDefinition function
type GetReleaseDefinitionHistoryArgs ¶
type GetReleaseDefinitionHistoryArgs struct { // (required) Project ID or project name Project *string // (required) Id of the definition. DefinitionId *int }
Arguments for the GetReleaseDefinitionHistory function
type GetReleaseDefinitionsArgs ¶
type GetReleaseDefinitionsArgs struct { // (required) Project ID or project name Project *string // (optional) Get release definitions with names containing searchText. SearchText *string // (optional) The properties that should be expanded in the list of Release definitions. Expand *ReleaseDefinitionExpands // (optional) Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild. ArtifactType *string // (optional) Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions. ArtifactSourceId *string // (optional) Number of release definitions to get. Top *int // (optional) Gets the release definitions after the continuation token provided. ContinuationToken *string // (optional) Gets the results in the defined order. Default is 'IdAscending'. QueryOrder *ReleaseDefinitionQueryOrder // (optional) Gets the release definitions under the specified path. Path *string // (optional) 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'. IsExactNameMatch *bool // (optional) A comma-delimited list of tags. Only release definitions with these tags will be returned. TagFilter *[]string // (optional) A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definitions will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release Definition from results irrespective of whether it has property set or not. PropertyFilters *[]string // (optional) A comma-delimited list of release definitions to retrieve. DefinitionIdFilter *[]string // (optional) 'true' to get release definitions that has been deleted. Default is 'false' IsDeleted *bool // (optional) 'true' to get the release definitions under the folder with name as specified in searchText. Default is 'false'. SearchTextContainsFolderName *bool }
Arguments for the GetReleaseDefinitions function
type GetReleaseDefinitionsResponseValue ¶
type GetReleaseDefinitionsResponseValue struct { Value []ReleaseDefinition ContinuationToken string }
Return type for the GetReleaseDefinitions function
type GetReleaseEnvironmentArgs ¶
type GetReleaseEnvironmentArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Id of the release environment. EnvironmentId *int // (optional) A property that should be expanded in the environment. Expand *ReleaseEnvironmentExpands }
Arguments for the GetReleaseEnvironment function
type GetReleaseRevisionArgs ¶
type GetReleaseRevisionArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Definition snapshot revision number. DefinitionSnapshotRevision *int }
Arguments for the GetReleaseRevision function
type GetReleaseTaskAttachmentContentArgs ¶
type GetReleaseTaskAttachmentContentArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Id of the release environment. EnvironmentId *int // (required) Attempt number of deployment. AttemptId *int // (required) Plan Id of the deploy phase. PlanId *uuid.UUID // (required) Timeline Id of the task. TimelineId *uuid.UUID // (required) Record Id of attachment. RecordId *uuid.UUID // (required) Type of the attachment. Type *string // (required) Name of the attachment. Name *string }
Arguments for the GetReleaseTaskAttachmentContent function
type GetReleaseTaskAttachmentsArgs ¶
type GetReleaseTaskAttachmentsArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Id of the release environment. EnvironmentId *int // (required) Attempt number of deployment. AttemptId *int // (required) Plan Id of the deploy phase. PlanId *uuid.UUID // (required) Type of the attachment. Type *string }
Arguments for the GetReleaseTaskAttachments function
type GetReleasesArgs ¶
type GetReleasesArgs struct { // (optional) Project ID or project name Project *string // (optional) Releases from this release definition Id. DefinitionId *int // (optional) DefinitionEnvironmentId *int // (optional) Releases with names containing searchText. SearchText *string // (optional) Releases created by this user. CreatedBy *string // (optional) Releases that have this status. StatusFilter *ReleaseStatus // (optional) EnvironmentStatusFilter *int // (optional) Releases that were created after this time. MinCreatedTime *azuredevops.Time // (optional) Releases that were created before this time. MaxCreatedTime *azuredevops.Time // (optional) Gets the results in the defined order of created date for releases. Default is descending. QueryOrder *ReleaseQueryOrder // (optional) Number of releases to get. Default is 50. Top *int // (optional) Gets the releases after the continuation token provided. ContinuationToken *int // (optional) The property that should be expanded in the list of releases. Expand *ReleaseExpands // (optional) Releases with given artifactTypeId will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild. ArtifactTypeId *string // (optional) Unique identifier of the artifact used. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions. SourceId *string // (optional) Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId. ArtifactVersionId *string // (optional) Releases with given sourceBranchFilter will be returned. SourceBranchFilter *string // (optional) Gets the soft deleted releases, if true. IsDeleted *bool // (optional) A comma-delimited list of tags. Only releases with these tags will be returned. TagFilter *[]string // (optional) A comma-delimited list of extended properties to be retrieved. If set, the returned Releases will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release from results irrespective of whether it has property set or not. PropertyFilters *[]string // (optional) A comma-delimited list of releases Ids. Only releases with these Ids will be returned. ReleaseIdFilter *[]int // (optional) Releases under this folder path will be returned Path *string }
Arguments for the GetReleases function
type GetReleasesResponseValue ¶
Return type for the GetReleases function
type GetTaskLogArgs ¶
type GetTaskLogArgs struct { // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Id of release environment. EnvironmentId *int // (required) Release deploy phase Id. ReleaseDeployPhaseId *int // (required) ReleaseTask Id for the log. TaskId *int // (optional) Starting line number for logs StartLine *uint64 // (optional) Ending line number for logs EndLine *uint64 }
Arguments for the GetTaskLog function
type GitArtifactDownloadInput ¶
type GitArtifactDownloadInput struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'. ArtifactDownloadMode *string `json:"artifactDownloadMode,omitempty"` // Gets or sets the artifact items of the input. ArtifactItems *[]string `json:"artifactItems,omitempty"` // Gets or sets the type of artifact. ArtifactType *string `json:"artifactType,omitempty"` }
type GitHubArtifactDownloadInput ¶
type GitHubArtifactDownloadInput struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'. ArtifactDownloadMode *string `json:"artifactDownloadMode,omitempty"` // Gets or sets the artifact items of the input. ArtifactItems *[]string `json:"artifactItems,omitempty"` // Gets or sets the type of artifact. ArtifactType *string `json:"artifactType,omitempty"` }
type IgnoredGate ¶
type IgnoredGate struct { // Gets the date on which gate is last ignored. LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"` // Name of gate ignored. Name *string `json:"name,omitempty"` }
type IssueSource ¶
type IssueSource string
type JenkinsArtifactDownloadInput ¶
type JenkinsArtifactDownloadInput struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'. ArtifactDownloadMode *string `json:"artifactDownloadMode,omitempty"` // Gets or sets the artifact items of the input. ArtifactItems *[]string `json:"artifactItems,omitempty"` // Gets or sets the type of artifact. ArtifactType *string `json:"artifactType,omitempty"` }
type MachineGroupBasedDeployPhase ¶
type MachineGroupBasedDeployPhase struct { // Gets and sets the name of deploy phase. Name *string `json:"name,omitempty"` // Indicates the deploy phase type. PhaseType *DeployPhaseTypes `json:"phaseType,omitempty"` // Gets and sets the rank of deploy phase. Rank *int `json:"rank,omitempty"` // Gets and sets the reference name of deploy phase. RefName *string `json:"refName,omitempty"` // Gets and sets the workflow tasks for the deploy phase. WorkflowTasks *[]WorkflowTask `json:"workflowTasks,omitempty"` // Gets and sets the deployment group job input DeploymentInput *MachineGroupDeploymentInput `json:"deploymentInput,omitempty"` }
type MachineGroupDeploymentInput ¶
type MachineGroupDeploymentInput struct { // Gets or sets the job condition. Condition *string `json:"condition,omitempty"` // Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment. JobCancelTimeoutInMinutes *int `json:"jobCancelTimeoutInMinutes,omitempty"` // Gets or sets the override inputs. OverrideInputs *map[string]string `json:"overrideInputs,omitempty"` // Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` // Artifacts that downloaded during job execution. ArtifactsDownloadInput *ArtifactsDownloadInput `json:"artifactsDownloadInput,omitempty"` // List demands that needs to meet to execute the job. Demands *[]interface{} `json:"demands,omitempty"` // Indicates whether to include access token in deployment job or not. EnableAccessToken *bool `json:"enableAccessToken,omitempty"` // Id of the pool on which job get executed. QueueId *int `json:"queueId,omitempty"` // Indicates whether artifacts downloaded while job execution or not. SkipArtifactsDownload *bool `json:"skipArtifactsDownload,omitempty"` // Deployment group health option. DeploymentHealthOption *string `json:"deploymentHealthOption,omitempty"` // Minimum percentage of the targets guaranteed to be healthy. HealthPercent *int `json:"healthPercent,omitempty"` // Deployment target tag filter. Tags *[]string `json:"tags,omitempty"` }
type MailMessage ¶
type MailMessage struct { // Body of mail. Body *string `json:"body,omitempty"` // Mail CC recipients. Cc *EmailRecipients `json:"cc,omitempty"` // Reply to. InReplyTo *string `json:"inReplyTo,omitempty"` // Message ID of the mail. MessageId *string `json:"messageId,omitempty"` // Data when should be replied to mail. ReplyBy *azuredevops.Time `json:"replyBy,omitempty"` // Reply to Email recipients. ReplyTo *EmailRecipients `json:"replyTo,omitempty"` // List of mail section types. Sections *[]MailSectionType `json:"sections,omitempty"` // Mail sender type. SenderType *SenderType `json:"senderType,omitempty"` // Subject of the mail. Subject *string `json:"subject,omitempty"` // Mail To recipients. To *EmailRecipients `json:"to,omitempty"` }
type MailSectionType ¶
type MailSectionType string
type ManualIntervention ¶
type ManualIntervention struct { // Gets or sets the identity who should approve. Approver *webapi.IdentityRef `json:"approver,omitempty"` // Gets or sets comments for approval. Comments *string `json:"comments,omitempty"` // Gets date on which it got created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Gets the unique identifier for manual intervention. Id *int `json:"id,omitempty"` // Gets or sets instructions for approval. Instructions *string `json:"instructions,omitempty"` // Gets date on which it got modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Gets or sets the name. Name *string `json:"name,omitempty"` // Gets releaseReference for manual intervention. Release *ReleaseShallowReference `json:"release,omitempty"` // Gets releaseDefinitionReference for manual intervention. ReleaseDefinition *ReleaseDefinitionShallowReference `json:"releaseDefinition,omitempty"` // Gets releaseEnvironmentReference for manual intervention. ReleaseEnvironment *ReleaseEnvironmentShallowReference `json:"releaseEnvironment,omitempty"` // Gets or sets the status of the manual intervention. Status *ManualInterventionStatus `json:"status,omitempty"` // Get task instance identifier. TaskInstanceId *uuid.UUID `json:"taskInstanceId,omitempty"` // Gets url to access the manual intervention. Url *string `json:"url,omitempty"` }
type ManualInterventionStatus ¶
type ManualInterventionStatus string
[Flags] Describes manual intervention status
type ManualInterventionUpdateMetadata ¶
type ManualInterventionUpdateMetadata struct { // Sets the comment for manual intervention update. Comment *string `json:"comment,omitempty"` // Sets the status of the manual intervention. Status *ManualInterventionStatus `json:"status,omitempty"` }
type MappingDetails ¶
type MappingDetails struct {
Mappings *map[string]forminput.InputValue `json:"mappings,omitempty"`
}
type MultiConfigInput ¶
type MultiConfigInput struct { // Parallel execution type, for example MultiConfiguration or MultiMachine. ParallelExecutionType *ParallelExecutionTypes `json:"parallelExecutionType,omitempty"` // Indicate whether continue execution of deployment on error or not. ContinueOnError *bool `json:"continueOnError,omitempty"` // Maximum number of agents used while parallel execution. MaxNumberOfAgents *int `json:"maxNumberOfAgents,omitempty"` // Multipliers for parallel execution of deployment, for example x86,x64. Multipliers *string `json:"multipliers,omitempty"` }
type MultiMachineInput ¶
type MultiMachineInput struct { // Parallel execution type, for example MultiConfiguration or MultiMachine. ParallelExecutionType *ParallelExecutionTypes `json:"parallelExecutionType,omitempty"` // Indicate whether continue execution of deployment on error or not. ContinueOnError *bool `json:"continueOnError,omitempty"` // Maximum number of agents used while parallel execution. MaxNumberOfAgents *int `json:"maxNumberOfAgents,omitempty"` }
type OrgPipelineReleaseSettings ¶
type OrgPipelineReleaseSettings struct { // Defines whether user can manage pipeline settings. HasManagePipelinePoliciesPermission *bool `json:"hasManagePipelinePoliciesPermission,omitempty"` // EnforceJobAuthScope setting at organisaion level. If enabled, scope of access for all release pipelines in the organisation reduces to the current project. OrgEnforceJobAuthScope *bool `json:"orgEnforceJobAuthScope,omitempty"` }
type OrgPipelineReleaseSettingsUpdateParameters ¶
type OrgPipelineReleaseSettingsUpdateParameters struct { // EnforceJobAuthScope setting at organisaion level. If enabled, scope of access for all release pipelines in the organisation reduces to the current project. OrgEnforceJobAuthScope *bool `json:"orgEnforceJobAuthScope,omitempty"` }
type PackageTrigger ¶
type PackageTrigger struct { // Type of release trigger. TriggerType *ReleaseTriggerType `json:"triggerType,omitempty"` // Package trigger alias. Alias *string `json:"alias,omitempty"` }
type ParallelExecutionInputBase ¶
type ParallelExecutionInputBase struct { // Parallel execution type, for example MultiConfiguration or MultiMachine. ParallelExecutionType *ParallelExecutionTypes `json:"parallelExecutionType,omitempty"` // Indicate whether continue execution of deployment on error or not. ContinueOnError *bool `json:"continueOnError,omitempty"` // Maximum number of agents used while parallel execution. MaxNumberOfAgents *int `json:"maxNumberOfAgents,omitempty"` }
type ProjectPipelineReleaseSettings ¶
type ProjectPipelineReleaseSettings struct { // EnforceJobAuthScope setting at project level. If enabled, scope of access for all release pipelines reduces to the current project. EnforceJobAuthScope *bool `json:"enforceJobAuthScope,omitempty"` // Defines whether user can manage pipeline settings. HasManageSettingsPermission *bool `json:"hasManageSettingsPermission,omitempty"` // EnforceJobAuthScope setting at organisaion level. If enabled, scope of access for all release pipelines in the organisation reduces to the current project. OrgEnforceJobAuthScope *bool `json:"orgEnforceJobAuthScope,omitempty"` // Defines whether project is public. PublicProject *bool `json:"publicProject,omitempty"` }
type ProjectPipelineReleaseSettingsUpdateParameters ¶
type ProjectPipelineReleaseSettingsUpdateParameters struct { // EnforceJobAuthScope setting at project level. If enabled, scope of access for all release pipelines reduces to the current project. EnforceJobAuthScope *bool `json:"enforceJobAuthScope,omitempty"` }
type ProjectReference ¶
type PropertySelector ¶
type PropertySelector struct { // List of properties. Properties *[]string `json:"properties,omitempty"` // Property selector type. SelectorType *PropertySelectorType `json:"selectorType,omitempty"` }
type PropertySelectorType ¶
type PropertySelectorType string
type PullRequestConfiguration ¶
type PullRequestConfiguration struct { // Code repository reference. CodeRepositoryReference *CodeRepositoryReference `json:"codeRepositoryReference,omitempty"` // In case of Source based artifacts, Code reference will be present in Artifact details. UseArtifactReference *bool `json:"useArtifactReference,omitempty"` }
type PullRequestFilter ¶
type PullRequestSystemType ¶
type PullRequestSystemType string
type PullRequestTrigger ¶
type PullRequestTrigger struct { // Type of release trigger. TriggerType *ReleaseTriggerType `json:"triggerType,omitempty"` // Artifact alias trigger is linked to. ArtifactAlias *string `json:"artifactAlias,omitempty"` // Code reference details of pull request. PullRequestConfiguration *PullRequestConfiguration `json:"pullRequestConfiguration,omitempty"` // Policy name using which status will be published to pull request. StatusPolicyName *string `json:"statusPolicyName,omitempty"` // List of filters applied while trigger. TriggerConditions *[]PullRequestFilter `json:"triggerConditions,omitempty"` }
type QueuedReleaseData ¶
type RealtimeReleaseEvent ¶
type Release ¶
type Release struct { // Gets links to access the release. Links interface{} `json:"_links,omitempty"` // Gets or sets the list of artifacts. Artifacts *[]Artifact `json:"artifacts,omitempty"` // Gets or sets comment. Comment *string `json:"comment,omitempty"` // Gets or sets the identity who created. CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"` // Gets or sets the identity for whom release was created. CreatedFor *webapi.IdentityRef `json:"createdFor,omitempty"` // Gets date on which it got created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Gets revision number of definition snapshot. DefinitionSnapshotRevision *int `json:"definitionSnapshotRevision,omitempty"` // Gets or sets description of release. Description *string `json:"description,omitempty"` // Gets list of environments. Environments *[]ReleaseEnvironment `json:"environments,omitempty"` // Gets the unique identifier of this field. Id *int `json:"id,omitempty"` // Whether to exclude the release from retention policies. KeepForever *bool `json:"keepForever,omitempty"` // Gets logs container url. LogsContainerUrl *string `json:"logsContainerUrl,omitempty"` // Gets or sets the identity who modified. ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"` // Gets date on which it got modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Gets name. Name *string `json:"name,omitempty"` // Gets pool name. PoolName *string `json:"poolName,omitempty"` // Gets or sets project reference. ProjectReference *ProjectReference `json:"projectReference,omitempty"` Properties interface{} `json:"properties,omitempty"` // Gets reason of release. Reason *ReleaseReason `json:"reason,omitempty"` // Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated. ReleaseDefinition *ReleaseDefinitionShallowReference `json:"releaseDefinition,omitempty"` // Gets or sets the release definition revision. ReleaseDefinitionRevision *int `json:"releaseDefinitionRevision,omitempty"` // Gets release name format. ReleaseNameFormat *string `json:"releaseNameFormat,omitempty"` // Gets status. Status *ReleaseStatus `json:"status,omitempty"` // Gets or sets list of tags. Tags *[]string `json:"tags,omitempty"` TriggeringArtifactAlias *string `json:"triggeringArtifactAlias,omitempty"` // Deprecated: Use Links instead. Url *string `json:"url,omitempty"` // Gets the list of variable groups. VariableGroups *[]VariableGroup `json:"variableGroups,omitempty"` // Gets or sets the dictionary of variables. Variables *map[string]ConfigurationVariableValue `json:"variables,omitempty"` }
type ReleaseAbandonedEvent ¶
type ReleaseAbandonedEvent struct { Id *int `json:"id,omitempty"` Url *string `json:"url,omitempty"` Project *ProjectReference `json:"project,omitempty"` Release *Release `json:"release,omitempty"` }
type ReleaseApproval ¶
type ReleaseApproval struct { // Gets or sets the type of approval. ApprovalType *ApprovalType `json:"approvalType,omitempty"` // Gets the identity who approved. ApprovedBy *webapi.IdentityRef `json:"approvedBy,omitempty"` // Gets or sets the identity who should approve. Approver *webapi.IdentityRef `json:"approver,omitempty"` // Gets or sets attempt which specifies as which deployment attempt it belongs. Attempt *int `json:"attempt,omitempty"` // Gets or sets comments for approval. Comments *string `json:"comments,omitempty"` // Gets date on which it got created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Gets history which specifies all approvals associated with this approval. History *[]ReleaseApprovalHistory `json:"history,omitempty"` // Gets the unique identifier of this field. Id *int `json:"id,omitempty"` // Gets or sets as approval is automated or not. IsAutomated *bool `json:"isAutomated,omitempty"` // Deprecated: Use Notifications instead. IsNotificationOn *bool `json:"isNotificationOn,omitempty"` // Gets date on which it got modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Gets or sets rank which specifies the order of the approval. e.g. Same rank denotes parallel approval. Rank *int `json:"rank,omitempty"` // Gets releaseReference which specifies the reference of the release to which this approval is associated. Release *ReleaseShallowReference `json:"release,omitempty"` // Gets releaseDefinitionReference which specifies the reference of the release definition to which this approval is associated. ReleaseDefinition *ReleaseDefinitionShallowReference `json:"releaseDefinition,omitempty"` // Gets releaseEnvironmentReference which specifies the reference of the release environment to which this approval is associated. ReleaseEnvironment *ReleaseEnvironmentShallowReference `json:"releaseEnvironment,omitempty"` // Gets the revision number. Revision *int `json:"revision,omitempty"` // Gets or sets the status of the approval. Status *ApprovalStatus `json:"status,omitempty"` // Deprecated: Use Attempt instead. TrialNumber *int `json:"trialNumber,omitempty"` // Gets url to access the approval. Url *string `json:"url,omitempty"` }
type ReleaseApprovalHistory ¶
type ReleaseApprovalHistory struct { // Identity of the approver. Approver *webapi.IdentityRef `json:"approver,omitempty"` // Approval history comments. Comments *string `json:"comments,omitempty"` // Time when this approval created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Identity of the object who changed approval. ChangedBy *webapi.IdentityRef `json:"changedBy,omitempty"` // Time when this approval modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Approval history revision. Revision *int `json:"revision,omitempty"` }
type ReleaseApprovalPendingEvent ¶
type ReleaseApprovalPendingEvent struct { Approval *ReleaseApproval `json:"approval,omitempty"` ApprovalOptions *ApprovalOptions `json:"approvalOptions,omitempty"` CompletedApprovals *[]ReleaseApproval `json:"completedApprovals,omitempty"` DefinitionName *string `json:"definitionName,omitempty"` Deployment *Deployment `json:"deployment,omitempty"` EnvironmentId *int `json:"environmentId,omitempty"` EnvironmentName *string `json:"environmentName,omitempty"` Environments *[]ReleaseEnvironment `json:"environments,omitempty"` IsMultipleRankApproval *bool `json:"isMultipleRankApproval,omitempty"` PendingApprovals *[]ReleaseApproval `json:"pendingApprovals,omitempty"` ReleaseCreator *string `json:"releaseCreator,omitempty"` ReleaseName *string `json:"releaseName,omitempty"` Title *string `json:"title,omitempty"` WebAccessUri *string `json:"webAccessUri,omitempty"` }
type ReleaseArtifact ¶
type ReleaseArtifact struct { // Gets or sets the artifact provider of ReleaseArtifact. ArtifactProvider *ArtifactProvider `json:"artifactProvider,omitempty"` // Gets or sets the artifact type of ReleaseArtifact. ArtifactType *string `json:"artifactType,omitempty"` // Gets or sets the definition json of ReleaseArtifact. DefinitionData *string `json:"definitionData,omitempty"` // Gets or sets the definition id of ReleaseArtifact. DefinitionId *int `json:"definitionId,omitempty"` // Gets or sets the description of ReleaseArtifact. Description *string `json:"description,omitempty"` // Gets or sets the id of ReleaseArtifact. Id *int `json:"id,omitempty"` // Gets or sets the name of ReleaseArtifact. Name *string `json:"name,omitempty"` // Gets or sets the release id. ReleaseId *int `json:"releaseId,omitempty"` }
type ReleaseCondition ¶
type ReleaseCondition struct { // Gets or sets the condition type. ConditionType *ConditionType `json:"conditionType,omitempty"` // Gets or sets the name of the condition. e.g. 'ReleaseStarted'. Name *string `json:"name,omitempty"` // Gets or set value of the condition. Value *string `json:"value,omitempty"` // The release condition result. Result *bool `json:"result,omitempty"` }
type ReleaseCreatedEvent ¶
type ReleaseCreatedEvent struct { Id *int `json:"id,omitempty"` Url *string `json:"url,omitempty"` Project *ProjectReference `json:"project,omitempty"` Release *Release `json:"release,omitempty"` }
type ReleaseDefinition ¶
type ReleaseDefinition struct { // Gets the links to related resources, APIs, and views for the release definition. Links interface{} `json:"_links,omitempty"` // Gets the unique identifier of release definition. Id *int `json:"id,omitempty"` // Gets or sets the name of the release definition. Name *string `json:"name,omitempty"` // Gets or sets the path of the release definition. Path *string `json:"path,omitempty"` // Gets or sets project reference. ProjectReference *ProjectReference `json:"projectReference,omitempty"` // Gets the REST API url to access the release definition. Url *string `json:"url,omitempty"` // Gets or sets the list of artifacts. Artifacts *[]Artifact `json:"artifacts,omitempty"` // Gets or sets comment. Comment *string `json:"comment,omitempty"` // Gets or sets the identity who created. CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"` // Gets date on which it got created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Gets or sets the description. Description *string `json:"description,omitempty"` // Gets or sets the list of environments. Environments *[]ReleaseDefinitionEnvironment `json:"environments,omitempty"` // Whether release definition is deleted. IsDeleted *bool `json:"isDeleted,omitempty"` // Gets the reference of last release. LastRelease *ReleaseReference `json:"lastRelease,omitempty"` // Gets or sets the identity who modified. ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"` // Gets date on which it got modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Gets or sets properties. Properties interface{} `json:"properties,omitempty"` // Gets or sets the release name format. ReleaseNameFormat *string `json:"releaseNameFormat,omitempty"` // Deprecated: Retention policy at Release Definition level is deprecated. Use the Retention Policy at environment and API version 3.0-preview.2 or later RetentionPolicy *RetentionPolicy `json:"retentionPolicy,omitempty"` // Gets the revision number. Revision *int `json:"revision,omitempty"` // Gets or sets source of release definition. Source *ReleaseDefinitionSource `json:"source,omitempty"` // Gets or sets list of tags. Tags *[]string `json:"tags,omitempty"` // Gets or sets the list of triggers. Triggers *[]interface{} `json:"triggers,omitempty"` // Gets or sets the list of variable groups. VariableGroups *[]int `json:"variableGroups,omitempty"` // Gets or sets the dictionary of variables. Variables *map[string]ConfigurationVariableValue `json:"variables,omitempty"` }
type ReleaseDefinitionApprovalStep ¶
type ReleaseDefinitionApprovalStep struct { // ID of the approval or deploy step. Id *int `json:"id,omitempty"` // Gets and sets the approver. Approver *webapi.IdentityRef `json:"approver,omitempty"` // Indicates whether the approval automated. IsAutomated *bool `json:"isAutomated,omitempty"` // Indicates whether the approval notification set. IsNotificationOn *bool `json:"isNotificationOn,omitempty"` // Gets or sets the rank of approval step. Rank *int `json:"rank,omitempty"` }
type ReleaseDefinitionApprovals ¶
type ReleaseDefinitionApprovals struct { // Gets or sets the approval options. ApprovalOptions *ApprovalOptions `json:"approvalOptions,omitempty"` // Gets or sets the approvals. Approvals *[]ReleaseDefinitionApprovalStep `json:"approvals,omitempty"` }
type ReleaseDefinitionDeployStep ¶
type ReleaseDefinitionDeployStep struct { // ID of the approval or deploy step. Id *int `json:"id,omitempty"` // The list of steps for this definition. Tasks *[]WorkflowTask `json:"tasks,omitempty"` }
type ReleaseDefinitionEnvironment ¶
type ReleaseDefinitionEnvironment struct { // Gets or sets the BadgeUrl. BadgeUrl will be used when Badge will be enabled in Release Definition Environment. BadgeUrl *string `json:"badgeUrl,omitempty"` // Gets or sets the environment conditions. Conditions *[]Condition `json:"conditions,omitempty"` // Gets or sets the current release reference. CurrentRelease *ReleaseShallowReference `json:"currentRelease,omitempty"` // Gets or sets the demands. Demands *[]interface{} `json:"demands,omitempty"` // Gets or sets the deploy phases of environment. DeployPhases *[]interface{} `json:"deployPhases,omitempty"` // Gets or sets the deploystep. DeployStep *ReleaseDefinitionDeployStep `json:"deployStep,omitempty"` // Gets or sets the environment options. EnvironmentOptions *EnvironmentOptions `json:"environmentOptions,omitempty"` // Gets or sets the triggers on environment. EnvironmentTriggers *[]EnvironmentTrigger `json:"environmentTriggers,omitempty"` // Gets or sets the environment execution policy. ExecutionPolicy *EnvironmentExecutionPolicy `json:"executionPolicy,omitempty"` // Gets and sets the ID of the ReleaseDefinitionEnvironment. Id *int `json:"id,omitempty"` // Gets and sets the name of the ReleaseDefinitionEnvironment. Name *string `json:"name,omitempty"` // Gets and sets the Owner of the ReleaseDefinitionEnvironment. Owner *webapi.IdentityRef `json:"owner,omitempty"` // Gets or sets the post deployment approvals. PostDeployApprovals *ReleaseDefinitionApprovals `json:"postDeployApprovals,omitempty"` // Gets or sets the post deployment gates. PostDeploymentGates *ReleaseDefinitionGatesStep `json:"postDeploymentGates,omitempty"` // Gets or sets the pre deployment approvals. PreDeployApprovals *ReleaseDefinitionApprovals `json:"preDeployApprovals,omitempty"` // Gets or sets the pre deployment gates. PreDeploymentGates *ReleaseDefinitionGatesStep `json:"preDeploymentGates,omitempty"` // Gets or sets the environment process parameters. ProcessParameters *distributedtaskcommon.ProcessParameters `json:"processParameters,omitempty"` // Gets or sets the properties on environment. Properties interface{} `json:"properties,omitempty"` // Gets or sets the queue ID. QueueId *int `json:"queueId,omitempty"` // Gets and sets the rank of the ReleaseDefinitionEnvironment. Rank *int `json:"rank,omitempty"` // Gets or sets the environment retention policy. RetentionPolicy *EnvironmentRetentionPolicy `json:"retentionPolicy,omitempty"` // Deprecated: This property is deprecated, use EnvironmentOptions instead. RunOptions *map[string]string `json:"runOptions,omitempty"` // Gets or sets the schedules Schedules *[]ReleaseSchedule `json:"schedules,omitempty"` // Gets or sets the variable groups. VariableGroups *[]int `json:"variableGroups,omitempty"` // Gets and sets the variables. Variables *map[string]ConfigurationVariableValue `json:"variables,omitempty"` }
type ReleaseDefinitionEnvironmentStep ¶
type ReleaseDefinitionEnvironmentStep struct { // ID of the approval or deploy step. Id *int `json:"id,omitempty"` }
type ReleaseDefinitionEnvironmentSummary ¶
type ReleaseDefinitionEnvironmentSummary struct { // ID of ReleaseDefinition environment summary. Id *int `json:"id,omitempty"` // List of release shallow reference deployed using this ReleaseDefinition. LastReleases *[]ReleaseShallowReference `json:"lastReleases,omitempty"` // Name of ReleaseDefinition environment summary. Name *string `json:"name,omitempty"` }
type ReleaseDefinitionEnvironmentTemplate ¶
type ReleaseDefinitionEnvironmentTemplate struct { // Indicates whether template can be deleted or not. CanDelete *bool `json:"canDelete,omitempty"` // Category of the ReleaseDefinition environment template. Category *string `json:"category,omitempty"` // Description of the ReleaseDefinition environment template. Description *string `json:"description,omitempty"` // ReleaseDefinition environment data which used to create this template. Environment *ReleaseDefinitionEnvironment `json:"environment,omitempty"` // ID of the task which used to display icon used for this template. IconTaskId *uuid.UUID `json:"iconTaskId,omitempty"` // Icon uri of the template. IconUri *string `json:"iconUri,omitempty"` // ID of the ReleaseDefinition environment template. Id *uuid.UUID `json:"id,omitempty"` // Indicates whether template deleted or not. IsDeleted *bool `json:"isDeleted,omitempty"` // Name of the ReleaseDefinition environment template. Name *string `json:"name,omitempty"` }
type ReleaseDefinitionGate ¶
type ReleaseDefinitionGate struct { // Gets or sets the gates workflow. Tasks *[]WorkflowTask `json:"tasks,omitempty"` }
type ReleaseDefinitionGatesOptions ¶
type ReleaseDefinitionGatesOptions struct { // Gets or sets as the gates enabled or not. IsEnabled *bool `json:"isEnabled,omitempty"` // Gets or sets the minimum duration for steady results after a successful gates evaluation. MinimumSuccessDuration *int `json:"minimumSuccessDuration,omitempty"` // Gets or sets the time between re-evaluation of gates. SamplingInterval *int `json:"samplingInterval,omitempty"` // Gets or sets the delay before evaluation. StabilizationTime *int `json:"stabilizationTime,omitempty"` // Gets or sets the timeout after which gates fail. Timeout *int `json:"timeout,omitempty"` }
type ReleaseDefinitionGatesStep ¶
type ReleaseDefinitionGatesStep struct { // Gets or sets the gates. Gates *[]ReleaseDefinitionGate `json:"gates,omitempty"` // Gets or sets the gate options. GatesOptions *ReleaseDefinitionGatesOptions `json:"gatesOptions,omitempty"` // ID of the ReleaseDefinitionGateStep. Id *int `json:"id,omitempty"` }
type ReleaseDefinitionQueryOrder ¶
type ReleaseDefinitionQueryOrder string
type ReleaseDefinitionRevision ¶
type ReleaseDefinitionRevision struct { // Gets api-version for revision object. ApiVersion *string `json:"apiVersion,omitempty"` // Gets comments for revision. Comment *string `json:"comment,omitempty"` // Get id of the definition. DefinitionId *int `json:"definitionId,omitempty"` // Gets definition URL. DefinitionUrl *string `json:"definitionUrl,omitempty"` // Gets the identity who did change. ChangedBy *webapi.IdentityRef `json:"changedBy,omitempty"` // Gets date on which ReleaseDefinition changed. ChangedDate *azuredevops.Time `json:"changedDate,omitempty"` // Gets type of change. ChangeType *AuditAction `json:"changeType,omitempty"` // Get revision number of the definition. Revision *int `json:"revision,omitempty"` }
type ReleaseDefinitionShallowReference ¶
type ReleaseDefinitionShallowReference struct { // Gets the links to related resources, APIs, and views for the release definition. Links interface{} `json:"_links,omitempty"` // Gets the unique identifier of release definition. Id *int `json:"id,omitempty"` // Gets or sets the name of the release definition. Name *string `json:"name,omitempty"` // Gets or sets the path of the release definition. Path *string `json:"path,omitempty"` // Gets or sets project reference. ProjectReference *ProjectReference `json:"projectReference,omitempty"` // Gets the REST API url to access the release definition. Url *string `json:"url,omitempty"` }
type ReleaseDefinitionSummary ¶
type ReleaseDefinitionSummary struct { // List of Release Definition environment summary. Environments *[]ReleaseDefinitionEnvironmentSummary `json:"environments,omitempty"` // Release Definition reference. ReleaseDefinition *ReleaseDefinitionShallowReference `json:"releaseDefinition,omitempty"` // List of releases deployed using this Release Definition. Releases *[]Release `json:"releases,omitempty"` }
type ReleaseDefinitionUndeleteParameter ¶
type ReleaseDefinitionUndeleteParameter struct { // Gets or sets comment. Comment *string `json:"comment,omitempty"` }
type ReleaseDeployPhase ¶
type ReleaseDeployPhase struct { // Deployment jobs of the phase. DeploymentJobs *[]DeploymentJob `json:"deploymentJobs,omitempty"` // Phase execution error logs. ErrorLog *string `json:"errorLog,omitempty"` // Deprecated: Id *int `json:"id,omitempty"` // List of manual intervention tasks execution information in phase. ManualInterventions *[]ManualIntervention `json:"manualInterventions,omitempty"` // Name of the phase. Name *string `json:"name,omitempty"` // ID of the phase. PhaseId *string `json:"phaseId,omitempty"` // Type of the phase. PhaseType *DeployPhaseTypes `json:"phaseType,omitempty"` // Rank of the phase. Rank *int `json:"rank,omitempty"` // Run Plan ID of the phase. RunPlanId *uuid.UUID `json:"runPlanId,omitempty"` // Phase start time. StartedOn *azuredevops.Time `json:"startedOn,omitempty"` // Status of the phase. Status *DeployPhaseStatus `json:"status,omitempty"` }
type ReleaseEnvironment ¶
type ReleaseEnvironment struct { // Gets list of conditions. Conditions *[]ReleaseCondition `json:"conditions,omitempty"` // Gets date on which it got created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Gets definition environment id. DefinitionEnvironmentId *int `json:"definitionEnvironmentId,omitempty"` // Deprecated: Use DeploymentInput.Demands instead. Demands *[]interface{} `json:"demands,omitempty"` // Gets list of deploy phases snapshot. DeployPhasesSnapshot *[]interface{} `json:"deployPhasesSnapshot,omitempty"` // Gets deploy steps. DeploySteps *[]DeploymentAttempt `json:"deploySteps,omitempty"` // Gets environment options. EnvironmentOptions *EnvironmentOptions `json:"environmentOptions,omitempty"` // Gets the unique identifier of this field. Id *int `json:"id,omitempty"` // Gets date on which it got modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Gets name. Name *string `json:"name,omitempty"` // Gets next scheduled UTC time. NextScheduledUtcTime *azuredevops.Time `json:"nextScheduledUtcTime,omitempty"` // Gets the identity who is owner for release environment. Owner *webapi.IdentityRef `json:"owner,omitempty"` // Gets list of post deploy approvals snapshot. PostApprovalsSnapshot *ReleaseDefinitionApprovals `json:"postApprovalsSnapshot,omitempty"` // Gets list of post deploy approvals. PostDeployApprovals *[]ReleaseApproval `json:"postDeployApprovals,omitempty"` // Post deployment gates snapshot data. PostDeploymentGatesSnapshot *ReleaseDefinitionGatesStep `json:"postDeploymentGatesSnapshot,omitempty"` // Gets list of pre deploy approvals snapshot. PreApprovalsSnapshot *ReleaseDefinitionApprovals `json:"preApprovalsSnapshot,omitempty"` // Gets list of pre deploy approvals. PreDeployApprovals *[]ReleaseApproval `json:"preDeployApprovals,omitempty"` // Pre deployment gates snapshot data. PreDeploymentGatesSnapshot *ReleaseDefinitionGatesStep `json:"preDeploymentGatesSnapshot,omitempty"` // Gets process parameters. ProcessParameters *distributedtaskcommon.ProcessParameters `json:"processParameters,omitempty"` // Deprecated: Use DeploymentInput.QueueId instead. QueueId *int `json:"queueId,omitempty"` // Gets rank. Rank *int `json:"rank,omitempty"` // Gets release reference which specifies the reference of the release to which this release environment is associated. Release *ReleaseShallowReference `json:"release,omitempty"` // Gets the identity who created release. ReleaseCreatedBy *webapi.IdentityRef `json:"releaseCreatedBy,omitempty"` // Gets releaseDefinitionReference which specifies the reference of the release definition to which this release environment is associated. ReleaseDefinition *ReleaseDefinitionShallowReference `json:"releaseDefinition,omitempty"` // Deprecated: Use Release object Description instead. ReleaseDescription *string `json:"releaseDescription,omitempty"` // Gets release id. ReleaseId *int `json:"releaseId,omitempty"` // Gets schedule deployment time of release environment. ScheduledDeploymentTime *azuredevops.Time `json:"scheduledDeploymentTime,omitempty"` // Gets list of schedules. Schedules *[]ReleaseSchedule `json:"schedules,omitempty"` // Gets environment status. Status *EnvironmentStatus `json:"status,omitempty"` // Gets time to deploy. TimeToDeploy *float64 `json:"timeToDeploy,omitempty"` // Gets trigger reason. TriggerReason *string `json:"triggerReason,omitempty"` // Gets the list of variable groups. VariableGroups *[]VariableGroup `json:"variableGroups,omitempty"` // Gets the dictionary of variables. Variables *map[string]ConfigurationVariableValue `json:"variables,omitempty"` // Deprecated: Use DeployPhase.WorkflowTasks instead. WorkflowTasks *[]WorkflowTask `json:"workflowTasks,omitempty"` }
type ReleaseEnvironmentCompletedEvent ¶
type ReleaseEnvironmentCompletedEvent struct { CreatedByName *string `json:"createdByName,omitempty"` DefinitionId *int `json:"definitionId,omitempty"` DefinitionName *string `json:"definitionName,omitempty"` Environment *ReleaseEnvironment `json:"environment,omitempty"` EnvironmentId *int `json:"environmentId,omitempty"` ProjectName *string `json:"projectName,omitempty"` Reason *DeploymentReason `json:"reason,omitempty"` ReleaseCreatedBy *webapi.IdentityRef `json:"releaseCreatedBy,omitempty"` ReleaseLogsUri *string `json:"releaseLogsUri,omitempty"` ReleaseName *string `json:"releaseName,omitempty"` Status *string `json:"status,omitempty"` Title *string `json:"title,omitempty"` WebAccessUri *string `json:"webAccessUri,omitempty"` }
type ReleaseEnvironmentShallowReference ¶
type ReleaseEnvironmentShallowReference struct { // Gets the links to related resources, APIs, and views for the release environment. Links interface{} `json:"_links,omitempty"` // Gets the unique identifier of release environment. Id *int `json:"id,omitempty"` // Gets or sets the name of the release environment. Name *string `json:"name,omitempty"` // Gets the REST API url to access the release environment. Url *string `json:"url,omitempty"` }
type ReleaseEnvironmentStatusUpdatedEvent ¶
type ReleaseEnvironmentStatusUpdatedEvent struct { DefinitionId *int `json:"definitionId,omitempty"` ProjectId *uuid.UUID `json:"projectId,omitempty"` EnvironmentId *int `json:"environmentId,omitempty"` EnvironmentStatus *EnvironmentStatus `json:"environmentStatus,omitempty"` LatestDeploymentOperationStatus *DeploymentOperationStatus `json:"latestDeploymentOperationStatus,omitempty"` LatestDeploymentStatus *DeploymentStatus `json:"latestDeploymentStatus,omitempty"` ReleaseId *int `json:"releaseId,omitempty"` }
type ReleaseEnvironmentUpdateMetadata ¶
type ReleaseEnvironmentUpdateMetadata struct { // Gets or sets comment. Comment *string `json:"comment,omitempty"` // Gets or sets scheduled deployment time. ScheduledDeploymentTime *azuredevops.Time `json:"scheduledDeploymentTime,omitempty"` // Gets or sets status of environment. Status *EnvironmentStatus `json:"status,omitempty"` // Sets list of environment variables to be overridden at deployment time. Variables *map[string]ConfigurationVariableValue `json:"variables,omitempty"` }
type ReleaseEvent ¶
type ReleaseGates ¶
type ReleaseGates struct { // Contains the gates job details of each evaluation. DeploymentJobs *[]DeploymentJob `json:"deploymentJobs,omitempty"` // ID of release gates. Id *int `json:"id,omitempty"` // List of ignored gates. IgnoredGates *[]IgnoredGate `json:"ignoredGates,omitempty"` // Gates last modified time. LastModifiedOn *azuredevops.Time `json:"lastModifiedOn,omitempty"` // Run plan ID of the gates. RunPlanId *uuid.UUID `json:"runPlanId,omitempty"` // Gates stabilization completed date and time. StabilizationCompletedOn *azuredevops.Time `json:"stabilizationCompletedOn,omitempty"` // Gates evaluation started time. StartedOn *azuredevops.Time `json:"startedOn,omitempty"` // Status of release gates. Status *GateStatus `json:"status,omitempty"` // Date and time at which all gates executed successfully. SucceedingSince *azuredevops.Time `json:"succeedingSince,omitempty"` }
type ReleaseGatesPhase ¶
type ReleaseGatesPhase struct { // Deployment jobs of the phase. DeploymentJobs *[]DeploymentJob `json:"deploymentJobs,omitempty"` // Phase execution error logs. ErrorLog *string `json:"errorLog,omitempty"` // ID of the phase. Id *int `json:"id,omitempty"` // List of manual intervention tasks execution information in phase. ManualInterventions *[]ManualIntervention `json:"manualInterventions,omitempty"` // Name of the phase. Name *string `json:"name,omitempty"` // ID of the phase. PhaseId *string `json:"phaseId,omitempty"` // Type of the phase. PhaseType *DeployPhaseTypes `json:"phaseType,omitempty"` // Rank of the phase. Rank *int `json:"rank,omitempty"` // Run Plan ID of the phase. RunPlanId *uuid.UUID `json:"runPlanId,omitempty"` // Phase start time. StartedOn *azuredevops.Time `json:"startedOn,omitempty"` // Status of the phase. Status *DeployPhaseStatus `json:"status,omitempty"` // List of ignored gates. IgnoredGates *[]IgnoredGate `json:"ignoredGates,omitempty"` // Date and time at which stabilization of gates completed. StabilizationCompletedOn *azuredevops.Time `json:"stabilizationCompletedOn,omitempty"` // Date and time at which all gates executed successfully. SucceedingSince *azuredevops.Time `json:"succeedingSince,omitempty"` }
type ReleaseNotCreatedEvent ¶
type ReleaseNotCreatedEvent struct { DefinitionReference *ReleaseDefinitionShallowReference `json:"definitionReference,omitempty"` Message *string `json:"message,omitempty"` ReleaseReason *ReleaseReason `json:"releaseReason,omitempty"` RequestedBy *webapi.IdentityRef `json:"requestedBy,omitempty"` }
type ReleaseQueryOrder ¶
type ReleaseQueryOrder string
type ReleaseReason ¶
type ReleaseReason string
type ReleaseReference ¶
type ReleaseReference struct { // Gets links to access the release. Links interface{} `json:"_links,omitempty"` // Gets list of artifacts. Artifacts *[]Artifact `json:"artifacts,omitempty"` // Gets the identity who created release. CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"` // Gets date on when this release created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Gets description. Description *string `json:"description,omitempty"` // ID of the Release. Id *int `json:"id,omitempty"` // Gets the identity who modified release. ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"` // Gets name of release. Name *string `json:"name,omitempty"` // Gets reason for release. Reason *ReleaseReason `json:"reason,omitempty"` // Gets release definition shallow reference. ReleaseDefinition *ReleaseDefinitionShallowReference `json:"releaseDefinition,omitempty"` // Deprecated: Use Links instead Url *string `json:"url,omitempty"` // Deprecated: Use Links instead WebAccessUri *string `json:"webAccessUri,omitempty"` }
type ReleaseRevision ¶
type ReleaseRevision struct { // Comment of the revision. Comment *string `json:"comment,omitempty"` // Release ID of which this revision belongs. DefinitionSnapshotRevision *int `json:"definitionSnapshotRevision,omitempty"` // Gets or sets the identity who changed. ChangedBy *webapi.IdentityRef `json:"changedBy,omitempty"` // Change date of the revision. ChangedDate *azuredevops.Time `json:"changedDate,omitempty"` // Change details of the revision. ChangeDetails *string `json:"changeDetails,omitempty"` // Change details of the revision. Typically ChangeDetails values are Add and Update. ChangeType *string `json:"changeType,omitempty"` // Gets or sets the release ID of which this revision belongs. ReleaseId *int `json:"releaseId,omitempty"` }
type ReleaseSchedule ¶
type ReleaseSchedule struct { // Days of the week to release. DaysToRelease *ScheduleDays `json:"daysToRelease,omitempty"` // Team Foundation Job Definition Job Id. JobId *uuid.UUID `json:"jobId,omitempty"` // Flag to determine if this schedule should only release if the associated artifact has been changed or release definition changed. ScheduleOnlyWithChanges *bool `json:"scheduleOnlyWithChanges,omitempty"` // Local time zone hour to start. StartHours *int `json:"startHours,omitempty"` // Local time zone minute to start. StartMinutes *int `json:"startMinutes,omitempty"` // Time zone Id of release schedule, such as 'UTC'. TimeZoneId *string `json:"timeZoneId,omitempty"` }
type ReleaseSettings ¶
type ReleaseSettings struct { // Release Compliance settings. ComplianceSettings *ComplianceSettings `json:"complianceSettings,omitempty"` // Release retention settings. RetentionSettings *RetentionSettings `json:"retentionSettings,omitempty"` }
type ReleaseShallowReference ¶
type ReleaseShallowReference struct { // Gets the links to related resources, APIs, and views for the release. Links interface{} `json:"_links,omitempty"` // Gets the unique identifier of release. Id *int `json:"id,omitempty"` // Gets or sets the name of the release. Name *string `json:"name,omitempty"` // Gets the REST API url to access the release. Url *string `json:"url,omitempty"` }
type ReleaseStartEnvironmentMetadata ¶
type ReleaseStartEnvironmentMetadata struct { // Sets release definition environment id. DefinitionEnvironmentId *int `json:"definitionEnvironmentId,omitempty"` // Sets list of environments variables to be overridden at deployment time. Variables *map[string]ConfigurationVariableValue `json:"variables,omitempty"` }
type ReleaseStartMetadata ¶
type ReleaseStartMetadata struct { // Sets list of artifact to create a release. Artifacts *[]ArtifactMetadata `json:"artifacts,omitempty"` // Sets definition Id to create a release. DefinitionId *int `json:"definitionId,omitempty"` // Sets description to create a release. Description *string `json:"description,omitempty"` // Sets list of environments meta data. EnvironmentsMetadata *[]ReleaseStartEnvironmentMetadata `json:"environmentsMetadata,omitempty"` // Sets 'true' to create release in draft mode, 'false' otherwise. IsDraft *bool `json:"isDraft,omitempty"` // Sets list of environments to manual as condition. ManualEnvironments *[]string `json:"manualEnvironments,omitempty"` Properties interface{} `json:"properties,omitempty"` // Sets reason to create a release. Reason *ReleaseReason `json:"reason,omitempty"` // Sets list of release variables to be overridden at deployment time. Variables *map[string]ConfigurationVariableValue `json:"variables,omitempty"` }
type ReleaseTask ¶
type ReleaseTask struct { // Agent name on which task executed. AgentName *string `json:"agentName,omitempty"` // Deprecated: Use FinishTime instead DateEnded *azuredevops.Time `json:"dateEnded,omitempty"` // Deprecated: Use StartTime instead. DateStarted *azuredevops.Time `json:"dateStarted,omitempty"` // Finish time of the release task. FinishTime *azuredevops.Time `json:"finishTime,omitempty"` // ID of the release task. Id *int `json:"id,omitempty"` // List of issues occurred while execution of task. Issues *[]Issue `json:"issues,omitempty"` // Number of lines log release task has. LineCount *uint64 `json:"lineCount,omitempty"` // Log URL of the task. LogUrl *string `json:"logUrl,omitempty"` // Name of the task. Name *string `json:"name,omitempty"` // Task execution complete precent. PercentComplete *int `json:"percentComplete,omitempty"` // Rank of the release task. Rank *int `json:"rank,omitempty"` // Result code of the task. ResultCode *string `json:"resultCode,omitempty"` // ID of the release task. StartTime *azuredevops.Time `json:"startTime,omitempty"` // Status of release task. Status *TaskStatus `json:"status,omitempty"` // Workflow task reference. Task *WorkflowTaskReference `json:"task,omitempty"` // Timeline record ID of the release task. TimelineRecordId *uuid.UUID `json:"timelineRecordId,omitempty"` }
type ReleaseTaskAttachment ¶
type ReleaseTaskAttachment struct { // Reference links of task. Links interface{} `json:"_links,omitempty"` // Data and time when it created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Identity who modified. ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"` // Data and time when modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Name of the task attachment. Name *string `json:"name,omitempty"` // Record ID of the task. RecordId *uuid.UUID `json:"recordId,omitempty"` // Timeline ID of the task. TimelineId *uuid.UUID `json:"timelineId,omitempty"` // Type of task attachment. Type *string `json:"type,omitempty"` }
type ReleaseTaskLogUpdatedEvent ¶
type ReleaseTaskLogUpdatedEvent struct { EnvironmentId *int `json:"environmentId,omitempty"` ProjectId *uuid.UUID `json:"projectId,omitempty"` ReleaseId *int `json:"releaseId,omitempty"` Lines *[]string `json:"lines,omitempty"` StepRecordId *uuid.UUID `json:"stepRecordId,omitempty"` TimelineRecordId *uuid.UUID `json:"timelineRecordId,omitempty"` }
type ReleaseTasksUpdatedEvent ¶
type ReleaseTasksUpdatedEvent struct { EnvironmentId *int `json:"environmentId,omitempty"` ProjectId *uuid.UUID `json:"projectId,omitempty"` ReleaseId *int `json:"releaseId,omitempty"` Job *ReleaseTask `json:"job,omitempty"` PlanId *uuid.UUID `json:"planId,omitempty"` // Deprecated: ReleaseDeployPhaseId *int `json:"releaseDeployPhaseId,omitempty"` ReleaseStepId *int `json:"releaseStepId,omitempty"` Tasks *[]ReleaseTask `json:"tasks,omitempty"` }
type ReleaseTriggerBase ¶
type ReleaseTriggerBase struct { // Type of release trigger. TriggerType *ReleaseTriggerType `json:"triggerType,omitempty"` }
type ReleaseTriggerType ¶
type ReleaseTriggerType string
type ReleaseUpdateMetadata ¶
type ReleaseUpdateMetadata struct { // Sets comment for release. Comment *string `json:"comment,omitempty"` // Set 'true' to exclude the release from retention policies. KeepForever *bool `json:"keepForever,omitempty"` // Sets list of manual environments. ManualEnvironments *[]string `json:"manualEnvironments,omitempty"` // Sets name of the release. Name *string `json:"name,omitempty"` // Sets status of the release. Status *ReleaseStatus `json:"status,omitempty"` }
type ReleaseUpdatedEvent ¶
type ReleaseWorkItemRef ¶
type ReleaseWorkItemRef struct { // Deprecated: Assignee *string `json:"assignee,omitempty"` // Gets or sets the ID. Id *string `json:"id,omitempty"` // Gets or sets the provider. Provider *string `json:"provider,omitempty"` // Gets or sets the state. State *string `json:"state,omitempty"` // Gets or sets the title. Title *string `json:"title,omitempty"` // Gets or sets the type. Type *string `json:"type,omitempty"` // Gets or sets the workitem url. Url *string `json:"url,omitempty"` }
type RetentionPolicy ¶
type RetentionPolicy struct { // Indicates the number of days to keep deployment. DaysToKeep *int `json:"daysToKeep,omitempty"` }
type RetentionSettings ¶
type RetentionSettings struct { // Number of days to keep deleted releases. DaysToKeepDeletedReleases *int `json:"daysToKeepDeletedReleases,omitempty"` // Specifies the default environment retention policy. DefaultEnvironmentRetentionPolicy *EnvironmentRetentionPolicy `json:"defaultEnvironmentRetentionPolicy,omitempty"` // Specifies the maximum environment retention policy. MaximumEnvironmentRetentionPolicy *EnvironmentRetentionPolicy `json:"maximumEnvironmentRetentionPolicy,omitempty"` }
type RunOnServerDeployPhase ¶
type RunOnServerDeployPhase struct { // Gets and sets the name of deploy phase. Name *string `json:"name,omitempty"` // Indicates the deploy phase type. PhaseType *DeployPhaseTypes `json:"phaseType,omitempty"` // Gets and sets the rank of deploy phase. Rank *int `json:"rank,omitempty"` // Gets and sets the reference name of deploy phase. RefName *string `json:"refName,omitempty"` // Gets and sets the workflow tasks for the deploy phase. WorkflowTasks *[]WorkflowTask `json:"workflowTasks,omitempty"` // Gets and sets the agentless job input. DeploymentInput *ServerDeploymentInput `json:"deploymentInput,omitempty"` }
type ScheduleDays ¶
type ScheduleDays string
type ScheduledReleaseTrigger ¶
type ScheduledReleaseTrigger struct { // Type of release trigger. TriggerType *ReleaseTriggerType `json:"triggerType,omitempty"` // Release schedule for Scheduled Release trigger type. Schedule *ReleaseSchedule `json:"schedule,omitempty"` }
type SenderType ¶
type SenderType string
type ServerDeploymentInput ¶
type ServerDeploymentInput struct { // Gets or sets the job condition. Condition *string `json:"condition,omitempty"` // Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment. JobCancelTimeoutInMinutes *int `json:"jobCancelTimeoutInMinutes,omitempty"` // Gets or sets the override inputs. OverrideInputs *map[string]string `json:"overrideInputs,omitempty"` // Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` // Gets or sets the parallel execution input. ParallelExecution *ExecutionInput `json:"parallelExecution,omitempty"` }
type SourceIdInput ¶
type SourcePullRequestVersion ¶
type SourcePullRequestVersion struct { // Pull Request Iteration Id for which the release will publish status. IterationId *string `json:"iterationId,omitempty"` // Pull Request Id for which the release will publish status. PullRequestId *string `json:"pullRequestId,omitempty"` // Date and time of the pull request merge creation. It is required to keep timeline record of Releases created by pull request. PullRequestMergedAt *azuredevops.Time `json:"pullRequestMergedAt,omitempty"` // Source branch of the Pull Request. SourceBranch *string `json:"sourceBranch,omitempty"` // Source branch commit Id of the Pull Request for which the release will publish status. SourceBranchCommitId *string `json:"sourceBranchCommitId,omitempty"` // Target branch of the Pull Request. TargetBranch *string `json:"targetBranch,omitempty"` }
type SourceRepoTrigger ¶
type SourceRepoTrigger struct { // Type of release trigger. TriggerType *ReleaseTriggerType `json:"triggerType,omitempty"` // Alias of the source repo trigger. Alias *string `json:"alias,omitempty"` BranchFilters *[]string `json:"branchFilters,omitempty"` }
type SummaryMailSection ¶
type SummaryMailSection struct { // Html content of summary mail. HtmlContent *string `json:"htmlContent,omitempty"` // Rank of the summary mail. Rank *int `json:"rank,omitempty"` // Summary mail section type. MailSectionType has section types. SectionType *MailSectionType `json:"sectionType,omitempty"` // Title of the summary mail. Title *string `json:"title,omitempty"` }
type TagFilter ¶
type TagFilter struct { // Gets or sets the tag filter pattern. Pattern *string `json:"pattern,omitempty"` }
type TaskOrchestrationPlanGroupsStartedEvent ¶
type TaskOrchestrationPlanGroupsStartedEvent struct {
PlanGroups *[]TaskOrchestrationPlanGroupReference `json:"planGroups,omitempty"`
}
type TaskStatus ¶
type TaskStatus string
type TfvcArtifactDownloadInput ¶
type TfvcArtifactDownloadInput struct { // Gets or sets the alias of artifact. Alias *string `json:"alias,omitempty"` // Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'. ArtifactDownloadMode *string `json:"artifactDownloadMode,omitempty"` // Gets or sets the artifact items of the input. ArtifactItems *[]string `json:"artifactItems,omitempty"` // Gets or sets the type of artifact. ArtifactType *string `json:"artifactType,omitempty"` }
type TimeZoneList ¶
type UpdateFolderArgs ¶
type UpdateFolderArgs struct { // (required) folder. Folder *Folder // (required) Project ID or project name Project *string // (required) Path of the folder to update. Path *string }
Arguments for the UpdateFolder function
type UpdateGatesArgs ¶
type UpdateGatesArgs struct { // (required) Metadata to patch the Release Gates. GateUpdateMetadata *GateUpdateMetadata // (required) Project ID or project name Project *string // (required) Gate step Id. GateStepId *int }
Arguments for the UpdateGates function
type UpdateManualInterventionArgs ¶
type UpdateManualInterventionArgs struct { // (required) Meta data to update manual intervention. ManualInterventionUpdateMetadata *ManualInterventionUpdateMetadata // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Id of the manual intervention. ManualInterventionId *int }
Arguments for the UpdateManualIntervention function
type UpdateReleaseApprovalArgs ¶
type UpdateReleaseApprovalArgs struct { // (required) ReleaseApproval object having status, approver and comments. Approval *ReleaseApproval // (required) Project ID or project name Project *string // (required) Id of the approval. ApprovalId *int }
Arguments for the UpdateReleaseApproval function
type UpdateReleaseArgs ¶
type UpdateReleaseArgs struct { // (required) Release object for update. Release *Release // (required) Project ID or project name Project *string // (required) Id of the release to update. ReleaseId *int }
Arguments for the UpdateRelease function
type UpdateReleaseDefinitionArgs ¶
type UpdateReleaseDefinitionArgs struct { // (required) Release definition object to update. ReleaseDefinition *ReleaseDefinition // (required) Project ID or project name Project *string }
Arguments for the UpdateReleaseDefinition function
type UpdateReleaseEnvironmentArgs ¶
type UpdateReleaseEnvironmentArgs struct { // (required) Environment update meta data. EnvironmentUpdateData *ReleaseEnvironmentUpdateMetadata // (required) Project ID or project name Project *string // (required) Id of the release. ReleaseId *int // (required) Id of release environment. EnvironmentId *int }
Arguments for the UpdateReleaseEnvironment function
type UpdateReleaseResourceArgs ¶
type UpdateReleaseResourceArgs struct { // (required) Properties of release to update. ReleaseUpdateMetadata *ReleaseUpdateMetadata // (required) Project ID or project name Project *string // (required) Id of the release to update. ReleaseId *int }
Arguments for the UpdateReleaseResource function
type VariableGroup ¶
type VariableGroup struct { // Gets or sets the identity who created. CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"` // Gets date on which it got created. CreatedOn *azuredevops.Time `json:"createdOn,omitempty"` // Gets or sets description. Description *string `json:"description,omitempty"` // Gets the unique identifier of this field. Id *int `json:"id,omitempty"` IsShared *bool `json:"isShared,omitempty"` // Gets or sets the identity who modified. ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"` // Gets date on which it got modified. ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"` // Gets or sets name. Name *string `json:"name,omitempty"` // Gets or sets provider data. ProviderData interface{} `json:"providerData,omitempty"` // Gets or sets type. Type *string `json:"type,omitempty"` // all project references where the variable group is shared with other projects. VariableGroupProjectReferences *[]VariableGroupProjectReference `json:"variableGroupProjectReferences,omitempty"` // Gets and sets the dictionary of variables. Variables *map[string]interface{} `json:"variables,omitempty"` }
type VariableGroupProjectReference ¶
type VariableGroupProjectReference struct { // Gets or sets description of the variable group. Description *string `json:"description,omitempty"` // Gets or sets name of the variable group. Name *string `json:"name,omitempty"` // Gets or sets project reference of the variable group. ProjectReference *ProjectReference `json:"projectReference,omitempty"` }
A variable group reference is a shallow reference to variable group.
type VariableGroupProviderData ¶
type VariableGroupProviderData struct { }
type VariableValue ¶
type WorkflowTask ¶
type WorkflowTask struct { // Gets or sets as the task always run or not. AlwaysRun *bool `json:"alwaysRun,omitempty"` // Gets or sets the task condition. Condition *string `json:"condition,omitempty"` // Gets or sets as the task continue run on error or not. ContinueOnError *bool `json:"continueOnError,omitempty"` // Gets or sets the task definition type. Example:- 'Agent', DeploymentGroup', 'Server' or 'ServerGate'. DefinitionType *string `json:"definitionType,omitempty"` // Gets or sets as the task enabled or not. Enabled *bool `json:"enabled,omitempty"` // Gets or sets the task environment variables. Environment *map[string]string `json:"environment,omitempty"` // Gets or sets the task inputs. Inputs *map[string]string `json:"inputs,omitempty"` // Gets or sets the name of the task. Name *string `json:"name,omitempty"` // Gets or sets the task override inputs. OverrideInputs *map[string]string `json:"overrideInputs,omitempty"` // Gets or sets the reference name of the task. RefName *string `json:"refName,omitempty"` // Gets or sets the task retryCount. RetryCountOnTaskFailure *int `json:"retryCountOnTaskFailure,omitempty"` // Gets or sets the ID of the task. TaskId *uuid.UUID `json:"taskId,omitempty"` // Gets or sets the task timeout. TimeoutInMinutes *int `json:"timeoutInMinutes,omitempty"` // Gets or sets the version of the task. Version *string `json:"version,omitempty"` }