VisualstudioteamservicesClient

Attributes

CommentFormat module-attribute

CommentFormat = Literal['markdown', 'html']

CommentReactionType module-attribute

CommentReactionType = Literal['like', 'dislike', 'heart', 'hooray', 'smile', 'confused']

RunResult module-attribute

RunResult = Literal['canceled', 'failed', 'succeeded', 'unknown']

RunState module-attribute

RunState = Literal['canceling', 'completed', 'inProgress', 'unknown']

ConfigurationType module-attribute

ConfigurationType = Literal['designerHyphenJson', 'designerJson', 'justInTime', 'unknown', 'yaml']

RepositoryType module-attribute

RepositoryType = Literal['azureReposGit', 'azureReposGitHyphenated', 'gitHub', 'unknown']

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnBuildCompleted': {'operation_id': 'OnBuildCompleted', 'path': '/{connectionId}/buildcompleted_trigger/{project}/_apis/build/builds', 'method': 'get', 'required_parameters': ['account', 'project'], 'callback_payload_type': 'VstsListBuildResult'}, 'OnGitPush': {'operation_id': 'OnGitPush', 'path': '/{connectionId}/gitpushed_trigger/{project}/_apis/git/repositories/{repository}/pushes', 'method': 'get', 'required_parameters': ['account', 'project', 'repository'], 'callback_payload_type': 'VstsListGitPush'}, 'OnGitPullCreated': {'operation_id': 'OnGitPullCreated', 'path': '/{connectionId}/gitpullcreated_trigger/{project}/_apis/git/repositories/{repository}/pullrequests', 'method': 'get', 'required_parameters': ['account', 'project', 'repository'], 'callback_payload_type': 'VstsListGitPullRequest'}, 'OnGitPullClosed': {'operation_id': 'OnGitPullClosed', 'path': '/{connectionId}/gitpullclosed_trigger/{project}/_apis/git/repositories/{repository}/pullrequests', 'method': 'get', 'required_parameters': ['account', 'project', 'repository'], 'callback_payload_type': 'VstsListGitPullRequest'}, 'OnTfvcCheckIn': {'operation_id': 'OnTfvcCheckIn', 'path': '/{connectionId}/tfvccheckin_trigger/_apis/tfvc/changesets', 'method': 'get', 'required_parameters': ['account', 'project'], 'callback_payload_type': 'VstsListTfvcChangeset'}, 'OnWorkItemAssignedV2': {'operation_id': 'OnWorkItemAssignedV2', 'path': '/{connectionId}/v2/workitemassigned_trigger/{project}/_apis/wit/wiql', 'method': 'get', 'required_parameters': ['account', 'project', 'team', 'wiql__System_AssignedTo'], 'callback_payload_type': 'VstsListTriggerWorkItemResponse'}, 'OnWorkItemClosedV2': {'operation_id': 'OnWorkItemClosedV2', 'path': '/{connectionId}/v2/workitemclosed_trigger/{project}/_apis/wit/wiql', 'method': 'get', 'required_parameters': ['account', 'project'], 'callback_payload_type': 'VstsListTriggerWorkItemResponse'}, 'OnWorkItemCreatedV2': {'operation_id': 'OnWorkItemCreatedV2', 'path': '/{connectionId}/v2/workitemcreated_trigger/{project}/_apis/wit/wiql', 'method': 'get', 'required_parameters': ['account', 'project'], 'callback_payload_type': 'VstsListTriggerWorkItemResponse'}, 'OnWorkItemUpdatedV2': {'operation_id': 'OnWorkItemUpdatedV2', 'path': '/{connectionId}/v2/workitemupdated_trigger/{project}/_apis/wit/wiql', 'method': 'get', 'required_parameters': ['account', 'project'], 'callback_payload_type': 'VstsListTriggerWorkItemResponse'}}

Classes

WorkItemSearchResponse dataclass

WorkItemSearchResponse(*, count: Optional[int] = None, results: Optional[List[WorkItemResult | Mapping[str, Any]]] = None, info_code: Optional[int] = None, facets: Optional[Dict[str, List[FacetItem | Mapping[str, Any]]]] = None)

Response for Search for work items

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Total number of matched work items.

results class-attribute instance-attribute

results: Optional[List[WorkItemResult | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of top matched work items.

info_code class-attribute instance-attribute

info_code: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'infoCode'})

Numeric code indicating any additional information.

facets class-attribute instance-attribute

facets: Optional[Dict[str, List[FacetItem | Mapping[str, Any]]]] = dataclass_field(default=None, kw_only=True)

A dictionary storing an array of Filter object against each facet.

BuildResult dataclass

BuildResult(*, id: Optional[int] = None, build_number: Optional[str] = None, source_branch: Optional[str] = None, source_version: Optional[str] = None, status: Optional[str] = None, priority: Optional[str] = None, queue_time: Optional[str] = None, start_time: Optional[str] = None, finish_time: Optional[str] = None, reason: Optional[str] = None, result: Optional[str] = None, requested_for: Optional[BuildRequestUser | Mapping[str, Any]] = None, parameters: Optional[str] = None, definition: Optional[BuildResultDefinition | Mapping[str, Any]] = None, links: Optional[Links | Mapping[str, Any]] = None, tags: Optional[List[str]] = None, template_parameters: Optional[Dict[str, str]] = None)

Response for Get build

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique identifier of the build.

build_number class-attribute instance-attribute

build_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'buildNumber'})

The build number.

source_branch class-attribute instance-attribute

source_branch: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sourceBranch'})

The source control branch the build used.

source_version class-attribute instance-attribute

source_version: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sourceVersion'})

The source control version the build used.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status of the build.

priority class-attribute instance-attribute

priority: Optional[str] = dataclass_field(default=None, kw_only=True)

The priority of the build.

queue_time class-attribute instance-attribute

queue_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'queueTime'})

The time the build was queued.

start_time class-attribute instance-attribute

start_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startTime'})

The time the build started.

finish_time class-attribute instance-attribute

finish_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'finishTime'})

The time the build finished.

reason class-attribute instance-attribute

reason: Optional[str] = dataclass_field(default=None, kw_only=True)

The reason for the build.

result class-attribute instance-attribute

result: Optional[str] = dataclass_field(default=None, kw_only=True)

The result of the build.

parameters class-attribute instance-attribute

parameters: Optional[str] = dataclass_field(default=None, kw_only=True)

Parameters passed to the build, if any.

tags class-attribute instance-attribute

tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

The tags applied to the build.

template_parameters class-attribute instance-attribute

template_parameters: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateParameters'})

The template parameters the run was queued with.

Timeline dataclass

Timeline(*, id: Optional[str] = None, change_id: Optional[int] = None, last_changed_by: Optional[str] = None, last_changed_on: Optional[str] = None, records: Optional[List[TimelineRecord | Mapping[str, Any]]] = None)

Response for Get build timeline

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Timeline identifier.

change_id class-attribute instance-attribute

change_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeId'})

Timeline change identifier.

last_changed_by class-attribute instance-attribute

last_changed_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastChangedBy'})

The process or person that last changed the timeline.

last_changed_on class-attribute instance-attribute

last_changed_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastChangedOn'})

Time the timeline was last changed.

records class-attribute instance-attribute

records: Optional[List[TimelineRecord | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Timeline records.

VstsListAccount dataclass

VstsListAccount(*, value: Optional[List[Account | Mapping[str, Any]]] = None)

Response for List Organizations

Attributes

value class-attribute instance-attribute

value: Optional[List[Account | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

Profile dataclass

Profile(*, display_name: Optional[str] = None, id: Optional[str] = None, public_alias: Optional[str] = None, email_address: Optional[str] = None, time_stamp: Optional[str] = None, revision: Optional[int] = None, core_revision: Optional[int] = None)

Response for Get a User Profile

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display Name of User

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the profile.

public_alias class-attribute instance-attribute

public_alias: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'publicAlias'})

Public Alias.

email_address class-attribute instance-attribute

email_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'emailAddress'})

Email Address of the account.

time_stamp class-attribute instance-attribute

time_stamp: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeStamp'})

The time at which this profile was last changed.

revision class-attribute instance-attribute

revision: Optional[int] = dataclass_field(default=None, kw_only=True)

The maximum revision number of any attribute.

core_revision class-attribute instance-attribute

core_revision: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'coreRevision'})

CoreRevision

VstsListTeamSettingsIteration dataclass

VstsListTeamSettingsIteration(*, value: Optional[List[TeamSettingsIteration | Mapping[str, Any]]] = None)

Response for List iterations

Attributes

value class-attribute instance-attribute

value: Optional[List[TeamSettingsIteration | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListGitRef dataclass

VstsListGitRef(*, value: Optional[List[GitRef | Mapping[str, Any]]] = None)

Response for List Git branches

Attributes

value class-attribute instance-attribute

value: Optional[List[GitRef | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListBuildResult dataclass

VstsListBuildResult(*, value: Optional[List[BuildResult | Mapping[str, Any]]] = None)

Response for List builds

Attributes

value class-attribute instance-attribute

value: Optional[List[BuildResult | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListTeamMember dataclass

VstsListTeamMember(*, value: Optional[List[TeamMember | Mapping[str, Any]]] = None)

Response for List build requesters

Attributes

value class-attribute instance-attribute

value: Optional[List[TeamMember | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListGitRepository dataclass

VstsListGitRepository(*, value: Optional[List[GitRepository | Mapping[str, Any]]] = None)

Response for List Git repositories

Attributes

value class-attribute instance-attribute

value: Optional[List[GitRepository | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListGitPush dataclass

VstsListGitPush(*, value: Optional[List[GitPush | Mapping[str, Any]]] = None)

Response for When code is pushed (Git)

Attributes

value class-attribute instance-attribute

value: Optional[List[GitPush | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListGitPullRequest dataclass

VstsListGitPullRequest(*, value: Optional[List[GitPullRequest | Mapping[str, Any]]] = None)

Response for When a pull request is created (Git)

Attributes

value class-attribute instance-attribute

value: Optional[List[GitPullRequest | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListProject dataclass

VstsListProject(*, value: Optional[List[Project | Mapping[str, Any]]] = None)

Response for List projects

Attributes

value class-attribute instance-attribute

value: Optional[List[Project | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListReleaseDefinition dataclass

VstsListReleaseDefinition(*, value: Optional[List[ReleaseDefinition | Mapping[str, Any]]] = None)

Response for List release definitions

Attributes

value class-attribute instance-attribute

value: Optional[List[ReleaseDefinition | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

Release dataclass

Release(*, comment: Optional[str] = None, created_by: Optional[IdentityRef | Mapping[str, Any]] = None, created_on: Optional[str] = None, description: Optional[str] = None, id: Optional[int] = None, keep_forever: Optional[bool] = None, logs_container_url: Optional[str] = None, modified_by: Optional[IdentityRef | Mapping[str, Any]] = None, modified_on: Optional[str] = None, name: Optional[str] = None, reason: Optional[str] = None, release_definition: Optional[ReleaseDefinitionShallowReference | Mapping[str, Any]] = None, status: Optional[str] = None, url: Optional[str] = None)

Response for Create a new release

Attributes

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comment'})

The comment of the release.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedOn'})

The date on which the release was created.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the release.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique Identifier of the release.

keep_forever class-attribute instance-attribute

keep_forever: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'KeepForever'})

Whether to exclude the release from retention policies.

logs_container_url class-attribute instance-attribute

logs_container_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LogsContainerUrl'})

The logs Container URL of this release.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ModifiedOn'})

Date on which the release was modified.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release.

reason class-attribute instance-attribute

reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reason'})

The reason of the release.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

The status of the release.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL of the release.

VstsListTfvcChangeset dataclass

VstsListTfvcChangeset(*, value: Optional[List[TfvcChangeset | Mapping[str, Any]]] = None)

Response for When code is checked in (TFVC)

Attributes

value class-attribute instance-attribute

value: Optional[List[TfvcChangeset | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

ObjectWithoutType dataclass

ObjectWithoutType(*, additional_properties: Dict[str, Any] = dict())

Response for Send an HTTP request to Azure DevOps

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

VstsListWorkItemField dataclass

VstsListWorkItemField(*, value: Optional[List[WorkItemField | Mapping[str, Any]]] = None)

Response for List work item fields

Attributes

value class-attribute instance-attribute

value: Optional[List[WorkItemField | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListWorkItemType dataclass

VstsListWorkItemType(*, value: Optional[List[WorkItemType | Mapping[str, Any]]] = None)

Response for List work item types

Attributes

value class-attribute instance-attribute

value: Optional[List[WorkItemType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models.

DynamicWorkItemResponse dataclass

DynamicWorkItemResponse(*, id: Optional[int] = None, rev: Optional[int] = None, url: Optional[str] = None, fields: Optional[Dict[str, Any]] = None)

Response for Get work item details

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique id of the work item.

rev class-attribute instance-attribute

rev: Optional[int] = dataclass_field(default=None, kw_only=True)

The revision count of the work item.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URL of the work item.

PatchWorkItemResponse dataclass

PatchWorkItemResponse(*, id: Optional[int] = None, rev: Optional[int] = None, url: Optional[str] = None, fields: Optional[Dict[str, Any]] = None)

Response for Update a work item

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique id of the work item.

rev class-attribute instance-attribute

rev: Optional[int] = dataclass_field(default=None, kw_only=True)

The revision count of the work item.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URL of the work item.

WorkItemDetailsResponse dataclass

WorkItemDetailsResponse(*, id: Optional[int] = None, rev: Optional[int] = None, url: Optional[str] = None, fields: Optional[Dict[str, Any]] = None, relations: Optional[List[Dict[str, Any]]] = None, multiline_fields_format: Optional[Dict[str, str]] = None, links: Optional[Dict[str, Any]] = None)

Response for Get work item details

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique id of the work item.

rev class-attribute instance-attribute

rev: Optional[int] = dataclass_field(default=None, kw_only=True)

The revision count of the work item.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URL of the work item.

relations class-attribute instance-attribute

relations: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

The relations associated with the work item.

multiline_fields_format class-attribute instance-attribute

multiline_fields_format: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'multilineFieldsFormat'})

Specifies formatting for multiline fields such as description.

links class-attribute instance-attribute

links: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_links'})

Hypermedia links related to the work item.

VstsListListWorkItemResponse dataclass

VstsListListWorkItemResponse(*, value: Optional[List[ListWorkItemResponse | Mapping[str, Any]]] = None)

Response for Get work item children

WorkItemAttachmentResponse dataclass

WorkItemAttachmentResponse(*, attachment_id: Optional[str] = None, file_name: Optional[str] = None, content_type: Optional[str] = None, content_length: Optional[int] = None, last_modified: Optional[str] = None, content: Optional[str] = None)

Response for Get work item attachment

Attributes

attachment_id class-attribute instance-attribute

attachment_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'attachmentId'})

Identifier of the attachment.

file_name class-attribute instance-attribute

file_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileName'})

Attachment file name.

content_type class-attribute instance-attribute

content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentType'})

MIME type of the attachment.

content_length class-attribute instance-attribute

content_length: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentLength'})

Size of the attachment in bytes.

last_modified class-attribute instance-attribute

last_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModified'})

Last modified timestamp for the attachment.

content class-attribute instance-attribute

content: Optional[str] = dataclass_field(default=None, kw_only=True)

Attachment content encoded as a Base64 string.

WorkItemCommentsResponse dataclass

WorkItemCommentsResponse(*, count: Optional[int] = None, comments: Optional[List[WorkItemComment | Mapping[str, Any]]] = None)

Response for Get work item comments

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

The total count of comments.

comments class-attribute instance-attribute

comments: Optional[List[WorkItemComment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of comments.

WorkItemComment dataclass

WorkItemComment(*, links: Optional[ReferenceLinks | Mapping[str, Any]] = None, id: Optional[int] = None, work_item_id: Optional[int] = None, version: Optional[int] = None, format: Optional[CommentFormat] = None, text: Optional[str] = None, rendered_text: Optional[str] = None, created_by: Optional[IdentityRef | Mapping[str, Any]] = None, created_date: Optional[str] = None, created_on_behalf_of: Optional[IdentityRef | Mapping[str, Any]] = None, created_on_behalf_date: Optional[str] = None, modified_by: Optional[IdentityRef | Mapping[str, Any]] = None, modified_date: Optional[str] = None, is_deleted: Optional[bool] = None, mentions: Optional[List[CommentMention | Mapping[str, Any]]] = None, reactions: Optional[List[CommentReaction | Mapping[str, Any]]] = None, url: Optional[str] = None)

Response for Create work item comment

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique id of the comment.

work_item_id class-attribute instance-attribute

work_item_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'workItemId'})

The work item id the comment belongs to.

version class-attribute instance-attribute

version: Optional[int] = dataclass_field(default=None, kw_only=True)

The work item revision associated with this comment.

format class-attribute instance-attribute

format: Optional[CommentFormat] = dataclass_field(default=None, kw_only=True)

Format of the comment text.

text class-attribute instance-attribute

text: Optional[str] = dataclass_field(default=None, kw_only=True)

The text of the comment.

rendered_text class-attribute instance-attribute

rendered_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'renderedText'})

The rendered HTML version of the comment text.

created_date class-attribute instance-attribute

created_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDate'})

The date the comment was created.

created_on_behalf_date class-attribute instance-attribute

created_on_behalf_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdOnBehalfDate'})

Effective creation date on behalf of another identity.

modified_date class-attribute instance-attribute

modified_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'modifiedDate'})

The date the comment was last modified.

is_deleted class-attribute instance-attribute

is_deleted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isDeleted'})

Indicates if the comment has been deleted.

mentions class-attribute instance-attribute

mentions: Optional[List[CommentMention | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Mentions included in the comment.

reactions class-attribute instance-attribute

reactions: Optional[List[CommentReaction | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Reactions on the comment.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST API URL of the comment.

VstsListQueryHierarchyItem dataclass

VstsListQueryHierarchyItem(*, value: Optional[List[QueryHierarchyItem | Mapping[str, Any]]] = None)

Response for List root level queries

Attributes

value class-attribute instance-attribute

value: Optional[List[QueryHierarchyItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

Pipeline dataclass

Pipeline(*, count: Optional[int] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List pipelines

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

count

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

Array that has the list of all pipelines

Run dataclass

Run(*, count: Optional[int] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List pipeline runs

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

count

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

Pipeline Run

PipelineRun dataclass

PipelineRun(*, id: Optional[int] = None, name: Optional[str] = None, state: Optional[str] = None, result: Optional[str] = None, created_date: Optional[str] = None, finished_date: Optional[str] = None, url: Optional[str] = None, template_parameters: Optional[Dict[str, Any]] = None, variables: Optional[Dict[str, Any]] = None, resources: Optional[Dict[str, Any]] = None, pipeline: Optional[Dict[str, Any]] = None)

Response for Run a pipeline

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The identifier of the run.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the run, which matches the build number.

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

The state of the run.

result class-attribute instance-attribute

result: Optional[str] = dataclass_field(default=None, kw_only=True)

The result of the run once it has completed.

created_date class-attribute instance-attribute

created_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDate'})

The time the run was created.

finished_date class-attribute instance-attribute

finished_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'finishedDate'})

The time the run finished.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST URL of the run.

template_parameters class-attribute instance-attribute

template_parameters: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateParameters'})

The template parameters the run was started with.

variables class-attribute instance-attribute

variables: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The runtime variables the run was started with.

resources class-attribute instance-attribute

resources: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The resource versions the run used.

pipeline class-attribute instance-attribute

pipeline: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The pipeline the run belongs to.

GitItem dataclass

GitItem(*, object_id: Optional[str] = None, commit_id: Optional[str] = None, git_object_type: Optional[str] = None, path: Optional[str] = None, is_folder: Optional[bool] = None, content: Optional[str] = None, url: Optional[str] = None)

Response for Get file content

Attributes

object_id class-attribute instance-attribute

object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'objectId'})

The object id of the item.

commit_id class-attribute instance-attribute

commit_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commitId'})

The commit the item was read from.

git_object_type class-attribute instance-attribute

git_object_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'gitObjectType'})

The kind of Git object, for example blob or tree.

path class-attribute instance-attribute

path: Optional[str] = dataclass_field(default=None, kw_only=True)

The repository-relative path of the item.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isFolder'})

Indicates whether the item is a folder.

content class-attribute instance-attribute

content: Optional[str] = dataclass_field(default=None, kw_only=True)

The text content of the file. Only returned when Include Content is true.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST URL of the item.

GitRefList dataclass

GitRefList(*, count: Optional[int] = None, value: Optional[List[GitRefItem | Mapping[str, Any]]] = None)

Response for List branches and tags

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

The number of refs returned.

value class-attribute instance-attribute

value: Optional[List[GitRefItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The refs.

GitPushResponse dataclass

GitPushResponse(*, push_id: Optional[int] = None, date: Optional[str] = None, url: Optional[str] = None, pushed_by: Optional[Dict[str, Any]] = None, ref_updates: Optional[List[GitRefItem | Mapping[str, Any]]] = None, commits: Optional[List[Dict[str, Any]]] = None)

Response for Create a push

Attributes

push_id class-attribute instance-attribute

push_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pushId'})

The identifier of the push.

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

The time the push was made.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST URL of the push.

pushed_by class-attribute instance-attribute

pushed_by: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pushedBy'})

The identity that made the push.

ref_updates class-attribute instance-attribute

ref_updates: Optional[List[GitRefItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'refUpdates'})

The refs that were updated.

commits class-attribute instance-attribute

commits: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

The commits that were pushed.

GitPullRequestResponse dataclass

GitPullRequestResponse(*, pull_request_id: Optional[int] = None, code_review_id: Optional[int] = None, status: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, source_ref_name: Optional[str] = None, target_ref_name: Optional[str] = None, merge_status: Optional[str] = None, is_draft: Optional[bool] = None, creation_date: Optional[str] = None, url: Optional[str] = None, created_by: Optional[Dict[str, Any]] = None, repository: Optional[Dict[str, Any]] = None)

Response for Create a pull request

Attributes

pull_request_id class-attribute instance-attribute

pull_request_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pullRequestId'})

The identifier of the pull request.

code_review_id class-attribute instance-attribute

code_review_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'codeReviewId'})

The code review id of the pull request.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status of the pull request.

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

The title of the pull request.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the pull request.

source_ref_name class-attribute instance-attribute

source_ref_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sourceRefName'})

The branch the changes come from.

target_ref_name class-attribute instance-attribute

target_ref_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetRefName'})

The branch the changes are merged into.

merge_status class-attribute instance-attribute

merge_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mergeStatus'})

The merge status of the pull request.

is_draft class-attribute instance-attribute

is_draft: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isDraft'})

Indicates whether the pull request is a draft.

creation_date class-attribute instance-attribute

creation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creationDate'})

The time the pull request was created.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST URL of the pull request.

created_by class-attribute instance-attribute

created_by: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdBy'})

The identity that created the pull request.

repository class-attribute instance-attribute

repository: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The repository the pull request targets.

VstsListQueryResultWorkItemResponse dataclass

VstsListQueryResultWorkItemResponse(*, value: Optional[List[QueryResultWorkItemResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Get query results

Attributes

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

Next page link

VstsListTriggerWorkItemResponse dataclass

VstsListTriggerWorkItemResponse(*, value: Optional[List[TriggerWorkItemResponse | Mapping[str, Any]]] = None)

Response for When a work item is assigned

VstsListTeam dataclass

VstsListTeam(*, value: Optional[List[Team | Mapping[str, Any]]] = None)

Response for List the teams in a project

Attributes

value class-attribute instance-attribute

value: Optional[List[Team | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListBuildDefinition dataclass

VstsListBuildDefinition(*, value: Optional[List[BuildDefinition | Mapping[str, Any]]] = None)

Response for List build definitions

Attributes

value class-attribute instance-attribute

value: Optional[List[BuildDefinition | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

ObjectEntity dataclass

ObjectEntity(*, additional_properties: Dict[str, Any] = dict())

Response for Get work item schema for update work item operation

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Account dataclass

Account(*, account_id: Optional[str] = None, account_uri: Optional[str] = None, account_name: Optional[str] = None, account_owner: Optional[str] = None, organization_name: Optional[str] = None, account_type: Optional[str] = None)

Definition: Account

Attributes

account_id class-attribute instance-attribute

account_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountId'})

The id of the account.

account_uri class-attribute instance-attribute

account_uri: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountUri'})

The URI of the account.

account_name class-attribute instance-attribute

account_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountName'})

The name of the account.

account_owner class-attribute instance-attribute

account_owner: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountOwner'})

The set owner of the account.

organization_name class-attribute instance-attribute

organization_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'organizationName'})

The organization name corresponding to the account.

account_type class-attribute instance-attribute

account_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountType'})

The type of the account.

TeamSettingsIteration dataclass

TeamSettingsIteration(*, attributes: Optional[TeamIterationAttributes | Mapping[str, Any]] = None, id: Optional[str] = None, name: Optional[str] = None, path: Optional[str] = None, links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = None, url: Optional[str] = None)

Definition: TeamSettingsIteration

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

Id of the resource.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

Name of the resource.

path class-attribute instance-attribute

path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

Relative path to the iteration.

links class-attribute instance-attribute

links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_links'})

Collection of links relevant to resource.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

Full HTTP link to the resource.

TeamIterationAttributes dataclass

TeamIterationAttributes(*, finish_date: Optional[str] = None, start_date: Optional[str] = None)

Definition: TeamIterationAttributes

Attributes

finish_date class-attribute instance-attribute

finish_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinishDate'})

The finish date team iteration attribute.

start_date class-attribute instance-attribute

start_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartDate'})

The start date team iteration attribute.

GenericLink dataclass

GenericLink(*, href: Optional[str] = None)

Definition: GenericLink

Attributes

href class-attribute instance-attribute

href: Optional[str] = dataclass_field(default=None, kw_only=True)

The HTML Link.

BuildDefinition dataclass

BuildDefinition(*, id: Optional[int] = None, type_: Optional[str] = None, revision: Optional[int] = None, name: Optional[str] = None, links: Optional[Links | Mapping[str, Any]] = None)

Definition: BuildDefinition

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique identifier of the build definition.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

The type of the build definition.

revision class-attribute instance-attribute

revision: Optional[int] = dataclass_field(default=None, kw_only=True)

The revision number of the build definition.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the build definition.

Links dataclass

Links(*, web: Optional[WebLinks | Mapping[str, Any]] = None)

Definition: Links

WebLinks dataclass

WebLinks(*, href: Optional[str] = None)

Definition: WebLinks

Attributes

href class-attribute instance-attribute

href: Optional[str] = dataclass_field(default=None, kw_only=True)

The web URL of build details

QueueBuildRequest dataclass

QueueBuildRequest(*, source_branch: Optional[str] = None, parameters: Optional[str] = None)

Definition: QueueBuildRequest

Attributes

source_branch class-attribute instance-attribute

source_branch: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sourceBranch'})

The source branch of the build.

parameters class-attribute instance-attribute

parameters: Optional[str] = dataclass_field(default=None, kw_only=True)

A JSON dictionary of optional build parameters.

BuildRequestUser dataclass

BuildRequestUser(*, unique_name: Optional[str] = None)

Definition: BuildRequestUser

Attributes

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the user the build was requested for.

BuildResultDefinition dataclass

BuildResultDefinition(*, id: Optional[int] = None, name: Optional[str] = None)

Definition: BuildResultDefinition

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The identifier of the build definiton.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the build definition.

TimelineRecord dataclass

TimelineRecord(*, id: Optional[str] = None, change_id: Optional[int] = None, parent_id: Optional[str] = None, type_: Optional[str] = None, name: Optional[str] = None, start_time: Optional[str] = None, finish_time: Optional[str] = None, state: Optional[str] = None, result: Optional[str] = None, worker_name: Optional[str] = None, attempt: Optional[int] = None, identifier: Optional[str] = None, issues: Optional[List[TimelineIssue | Mapping[str, Any]]] = None, log: Optional[TimelineLogReference | Mapping[str, Any]] = None, order: Optional[int] = None, details: Optional[TimelineReference | Mapping[str, Any]] = None, task: Optional[TimelineTask | Mapping[str, Any]] = None, previous_attempts: Optional[List[TimelineReference | Mapping[str, Any]]] = None, percent_complete: Optional[int] = None, current_operation: Optional[str] = None, url: Optional[str] = None, result_code: Optional[str] = None, properties: Optional[Dict[str, str]] = None)

Definition: TimelineRecord

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Record identifier.

change_id class-attribute instance-attribute

change_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeId'})

Record change identifier.

parent_id class-attribute instance-attribute

parent_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentId'})

Parent record identifier.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Record type.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Record name.

start_time class-attribute instance-attribute

start_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startTime'})

Record start time.

finish_time class-attribute instance-attribute

finish_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'finishTime'})

Record finish time.

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

Record state.

result class-attribute instance-attribute

result: Optional[str] = dataclass_field(default=None, kw_only=True)

Record result.

worker_name class-attribute instance-attribute

worker_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'workerName'})

Worker processing the record.

attempt class-attribute instance-attribute

attempt: Optional[int] = dataclass_field(default=None, kw_only=True)

Record attempt number.

identifier class-attribute instance-attribute

identifier: Optional[str] = dataclass_field(default=None, kw_only=True)

Record identifier value.

issues class-attribute instance-attribute

issues: Optional[List[TimelineIssue | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Issues encountered by the record.

order class-attribute instance-attribute

order: Optional[int] = dataclass_field(default=None, kw_only=True)

Record execution order.

previous_attempts class-attribute instance-attribute

previous_attempts: Optional[List[TimelineReference | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'previousAttempts'})

Previous record attempts.

percent_complete class-attribute instance-attribute

percent_complete: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'percentComplete'})

Record percent complete.

current_operation class-attribute instance-attribute

current_operation: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'currentOperation'})

Current record operation.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

Record URL.

result_code class-attribute instance-attribute

result_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resultCode'})

Record result code.

properties class-attribute instance-attribute

properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True)

Record properties.

TimelineIssue dataclass

TimelineIssue(*, type_: Optional[str] = None, category: Optional[str] = None, message: Optional[str] = None, data: Optional[Dict[str, str]] = None, error_code: Optional[str] = None, warning_code: Optional[str] = None)

Definition: TimelineIssue

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Issue type.

category class-attribute instance-attribute

category: Optional[str] = dataclass_field(default=None, kw_only=True)

Issue category.

message class-attribute instance-attribute

message: Optional[str] = dataclass_field(default=None, kw_only=True)

Issue message.

data class-attribute instance-attribute

data: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True)

Issue data.

error_code class-attribute instance-attribute

error_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'errorCode'})

Issue error code.

warning_code class-attribute instance-attribute

warning_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'warningCode'})

Issue warning code.

TimelineLogReference dataclass

TimelineLogReference(*, id: Optional[int] = None, type_: Optional[str] = None, line_count: Optional[int] = None, url: Optional[str] = None)

Definition: TimelineLogReference

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

Log identifier.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Log type.

line_count class-attribute instance-attribute

line_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineCount'})

Number of lines in the log.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

Log URL.

TimelineReference dataclass

TimelineReference(*, id: Optional[str] = None, change_id: Optional[int] = None)

Definition: TimelineReference

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Reference identifier.

change_id class-attribute instance-attribute

change_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeId'})

Reference change identifier.

TimelineTask dataclass

TimelineTask(*, id: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None)

Definition: TimelineTask

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Task identifier.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Task name.

version class-attribute instance-attribute

version: Optional[str] = dataclass_field(default=None, kw_only=True)

Task version.

ClientSubscription dataclass

ClientSubscription(notification_url: str, *, dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: ClientSubscription

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'NotificationUrl'})

Callback url to the LA engine. Expected as part of the request and provided by Flow.

WorkItemsClientSubscription dataclass

WorkItemsClientSubscription(notification_url: str, *, dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: WorkItemsClientSubscription

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'NotificationUrl'})

Callback url to the LA engine. Expected as part of the request and provided by Flow.

SubscriptionResponse dataclass

SubscriptionResponse(*, id: Optional[str] = None, resource: Optional[str] = None, notification_type: Optional[str] = None, notification_url: Optional[str] = None)

Definition: SubscriptionResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Id of the subscription.

resource class-attribute instance-attribute

resource: Optional[str] = dataclass_field(default=None, kw_only=True)

Resource of the subscription request.

notification_type class-attribute instance-attribute

notification_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'notificationType'})

Notification type.

notification_url class-attribute instance-attribute

notification_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'notificationUrl'})

Notification Url.

TriggerBatchResponseBuildResult dataclass

TriggerBatchResponseBuildResult(*, value: Optional[List[BuildResult | Mapping[str, Any]]] = None)

Definition: TriggerBatchResponse[BuildResult]

Attributes

value class-attribute instance-attribute

value: Optional[List[BuildResult | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A list of the response objects.

GitRepository dataclass

GitRepository(*, id: Optional[str] = None, name: Optional[str] = None, url: Optional[str] = None, remote_url: Optional[str] = None)

Definition: GitRepository

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique id of the repository.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the repository.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URL is the API endpoint for the repository.

remote_url class-attribute instance-attribute

remote_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'remoteUrl'})

The URL via which git can sync with this repository.

GitRef dataclass

GitRef(*, object_id: Optional[str] = None, name: Optional[str] = None)

Definition: GitRef

Attributes

object_id class-attribute instance-attribute

object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'objectId'})

The unique id of the ref.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the ref.

GitPush dataclass

GitPush(*, repository: Optional[GitRepository | Mapping[str, Any]] = None, pushed_by: Optional[GitPushUser | Mapping[str, Any]] = None, ref_updates: Optional[List[GitRefUpdate | Mapping[str, Any]]] = None, push_id: Optional[int] = None, date: Optional[str] = None)

Definition: GitPush

Attributes

ref_updates class-attribute instance-attribute

ref_updates: Optional[List[GitRefUpdate | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'refUpdates'})

The Refs that were updated as part of this push.

push_id class-attribute instance-attribute

push_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pushId'})

The unique id of the push.

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

The date the push was created.

GitPushUser dataclass

GitPushUser(*, id: Optional[str] = None, display_name: Optional[str] = None, unique_name: Optional[str] = None, image_url: Optional[str] = None)

Definition: GitPushUser

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the user who created the push.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The name of the user who created the push.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the user who created the push.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

The url to the image for this user.

GitPullRequest dataclass

GitPullRequest(*, repository: Optional[GitRepository | Mapping[str, Any]] = None, pull_request_id: Optional[int] = None, created_by: Optional[PullRequestCreatedBy | Mapping[str, Any]] = None, creation_date: Optional[str] = None, closed_date: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, source_ref_name: Optional[str] = None, target_ref_name: Optional[str] = None, is_draft: Optional[bool] = None, reviewers: Optional[List[PullRequestReviewer | Mapping[str, Any]]] = None, reviewer_list: Optional[str] = None, required_reviewer_list: Optional[str] = None, commits: Optional[List[GitCommitRef | Mapping[str, Any]]] = None, completion_options: Optional[PullRequestCompletionOptions | Mapping[str, Any]] = None, merge_options: Optional[PullRequestMergeOptions | Mapping[str, Any]] = None, merge_failure_message: Optional[str] = None, closed_by: Optional[PullRequestClosedBy | Mapping[str, Any]] = None, auto_complete_set_by: Optional[PullRequestAutoCompleteSetBy | Mapping[str, Any]] = None, url: Optional[str] = None, remote_url: Optional[str] = None, artifact_id: Optional[str] = None, merge_id: Optional[str] = None, code_review_id: Optional[int] = None, completion_queue_time: Optional[str] = None, supports_iterations: Optional[bool] = None)

Definition: GitPullRequest

Attributes

pull_request_id class-attribute instance-attribute

pull_request_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pullRequestId'})

The unique id of the pull request.

creation_date class-attribute instance-attribute

creation_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creationDate'})

The date the pull request was created

closed_date class-attribute instance-attribute

closed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'closedDate'})

The date when the pull request was closed (completed, abandoned, or merged externally)

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

The title of the pull request

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the pull request

source_ref_name class-attribute instance-attribute

source_ref_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sourceRefName'})

The name of the source branch of the pull request

target_ref_name class-attribute instance-attribute

target_ref_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetRefName'})

The name of the target branch of the pull request

is_draft class-attribute instance-attribute

is_draft: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isDraft'})

Draft / WIP pull request

reviewers class-attribute instance-attribute

reviewers: Optional[List[PullRequestReviewer | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Groups or teams that that this reviewer contributed to.

reviewer_list class-attribute instance-attribute

reviewer_list: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reviewerList'})

A semicolon separated list of reviewer unique names which are valid email addresses

required_reviewer_list class-attribute instance-attribute

required_reviewer_list: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredReviewerList'})

A semicolon separated list of required reviewer unique names which are valid email addresses

commits class-attribute instance-attribute

commits: Optional[List[GitCommitRef | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The commits contained in the pull request.

merge_failure_message class-attribute instance-attribute

merge_failure_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mergeFailureMessage'})

If set, pull request merge failed for this reason.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The url of the pull request.

remote_url class-attribute instance-attribute

remote_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'remoteUrl'})

The remote url to the pull request.

artifact_id class-attribute instance-attribute

artifact_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'artifactId'})

A string which uniquely identifies this pull request.

merge_id class-attribute instance-attribute

merge_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mergeId'})

The merge id of the pull request.

code_review_id class-attribute instance-attribute

code_review_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'codeReviewId'})

The code review id of the pull request.

completion_queue_time class-attribute instance-attribute

completion_queue_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completionQueueTime'})

The most recent date at which the pull request entered the queue to be completed.

supports_iterations class-attribute instance-attribute

supports_iterations: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'supportsIterations'})

If true, this pull request supports multiple iterations.

PullRequestCreatedBy dataclass

PullRequestCreatedBy(*, display_name: Optional[str] = None, unique_name: Optional[str] = None, id: Optional[str] = None, image_url: Optional[str] = None, url: Optional[str] = None)

Definition: PullRequestCreatedBy

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The display name of the pull request creator.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the pull request creator.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The Id of the pull request creator.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

The url to the image of the pull request creator.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The url of the pull request creator.

PullRequestClosedBy dataclass

PullRequestClosedBy(*, display_name: Optional[str] = None, unique_name: Optional[str] = None, id: Optional[str] = None, image_url: Optional[str] = None, url: Optional[str] = None)

Definition: PullRequestClosedBy

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The display name of the pull request closer.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the pull request closer.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The Id of the pull request closer.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

The url to the image of the pull request closer.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The url of the pull request closer.

PullRequestAutoCompleteSetBy dataclass

PullRequestAutoCompleteSetBy(*, display_name: Optional[str] = None, unique_name: Optional[str] = None, id: Optional[str] = None, image_url: Optional[str] = None, url: Optional[str] = None)

Definition: PullRequestAutoCompleteSetBy

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The display name of the user who enabled auto complete.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the user who enabled auto complete.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The Id of the user who enabled auto complete.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

The url to the image of the user who enabled auto complete.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The url of the user who enabled auto complete.

PullRequestReviewer dataclass

PullRequestReviewer(*, display_name: Optional[str] = None, unique_name: Optional[str] = None, id: Optional[str] = None, url: Optional[str] = None, has_declined: Optional[bool] = None, is_flagged: Optional[bool] = None, is_required: Optional[bool] = None, vote: Optional[int] = None, voted_for: Optional[List[PullRequestReviewer | Mapping[str, Any]]] = None)

Definition: PullRequestReviewer

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The display name of the pull request reviewer.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the pull request reviewer.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The Id of the pull request reviewer.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The url of the pull request reviewer.

has_declined class-attribute instance-attribute

has_declined: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasDeclined'})

Indicates if this reviewer has declined to review this pull request.

is_flagged class-attribute instance-attribute

is_flagged: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isFlagged'})

Indicates if this reviewer is flagged for attention on this pull request.

is_required class-attribute instance-attribute

is_required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isRequired'})

Indicates if this is a required reviewer for this pull request.

vote class-attribute instance-attribute

vote: Optional[int] = dataclass_field(default=None, kw_only=True)

Vote on a pull request: approved(10), approved with suggestions(5), no vote(0), waiting for author(-5), rejected(-10).

voted_for class-attribute instance-attribute

voted_for: Optional[List[PullRequestReviewer | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'votedFor'})

Groups or teams that that this reviewer contributed to.

LastMergeCommitGitUserDate dataclass

LastMergeCommitGitUserDate(*, date: Optional[str] = None, email: Optional[str] = None, image_url: Optional[str] = None, name: Optional[str] = None)

Definition: LastMergeCommitGitUserDate

Attributes

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

Date of the Git operation.

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

Email address of the user performing the Git operation.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

Url for the user's avatar.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the user performing the Git operation.

LastMergeSourceCommitGitUserDate dataclass

LastMergeSourceCommitGitUserDate(*, date: Optional[str] = None, email: Optional[str] = None, image_url: Optional[str] = None, name: Optional[str] = None)

Definition: LastMergeSourceCommitGitUserDate

Attributes

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

Date of the Git operation.

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

Email address of the user performing the Git operation.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

Url for the user's avatar.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the user performing the Git operation.

LastMergeTargetCommitGitUserDate dataclass

LastMergeTargetCommitGitUserDate(*, date: Optional[str] = None, email: Optional[str] = None, image_url: Optional[str] = None, name: Optional[str] = None)

Definition: LastMergeTargetCommitGitUserDate

Attributes

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

Date of the Git operation.

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

Email address of the user performing the Git operation.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

Url for the user's avatar.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the user performing the Git operation.

PullRequestLastMergeCommitRef dataclass

PullRequestLastMergeCommitRef(*, author: Optional[LastMergeCommitGitUserDate | Mapping[str, Any]] = None, comment: Optional[str] = None, comment_truncated: Optional[str] = None, commit_id: Optional[str] = None, committer: Optional[LastMergeCommitGitUserDate | Mapping[str, Any]] = None, parents: Optional[List[str]] = None, remote_url: Optional[str] = None, url: Optional[str] = None)

Definition: PullRequestLastMergeCommitRef

Attributes

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True)

Comment or message of the last merge commit.

comment_truncated class-attribute instance-attribute

comment_truncated: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentTruncated'})

Indicates if the comment is truncated from the full Git commit comment message.

commit_id class-attribute instance-attribute

commit_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commitId'})

Id of the last merge commit.

parents class-attribute instance-attribute

parents: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

An enumeration of the parent commit IDs for the last merge commit.

remote_url class-attribute instance-attribute

remote_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'remoteUrl'})

Remote URL path to the last merge commit.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

REST URL for the last merge commit.

PullRequestLastMergeSourceCommitRef dataclass

PullRequestLastMergeSourceCommitRef(*, author: Optional[LastMergeSourceCommitGitUserDate | Mapping[str, Any]] = None, comment: Optional[str] = None, comment_truncated: Optional[str] = None, commit_id: Optional[str] = None, committer: Optional[LastMergeSourceCommitGitUserDate | Mapping[str, Any]] = None, parents: Optional[List[str]] = None, remote_url: Optional[str] = None, url: Optional[str] = None)

Definition: PullRequestLastMergeSourceCommitRef

Attributes

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True)

Comment or message of the commit.

comment_truncated class-attribute instance-attribute

comment_truncated: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentTruncated'})

Indicates if the comment is truncated from the full Git commit comment message.

commit_id class-attribute instance-attribute

commit_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commitId'})

Id of the commit.

parents class-attribute instance-attribute

parents: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

An enumeration of the parent commit IDs for this commit.

remote_url class-attribute instance-attribute

remote_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'remoteUrl'})

Remote URL path to the commit.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

REST URL for this resource.

PullRequestLastMergeTargetCommitRef dataclass

PullRequestLastMergeTargetCommitRef(*, author: Optional[LastMergeTargetCommitGitUserDate | Mapping[str, Any]] = None, comment: Optional[str] = None, comment_truncated: Optional[str] = None, commit_id: Optional[str] = None, committer: Optional[LastMergeTargetCommitGitUserDate | Mapping[str, Any]] = None, parents: Optional[List[str]] = None, remote_url: Optional[str] = None, url: Optional[str] = None)

Definition: PullRequestLastMergeTargetCommitRef

Attributes

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True)

Comment or message of the commit.

comment_truncated class-attribute instance-attribute

comment_truncated: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentTruncated'})

Indicates if the comment is truncated from the full Git commit comment message.

commit_id class-attribute instance-attribute

commit_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commitId'})

Id of the commit.

parents class-attribute instance-attribute

parents: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

An enumeration of the parent commit IDs for this commit.

remote_url class-attribute instance-attribute

remote_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'remoteUrl'})

Remote URL path to the commit.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

REST URL for this resource.

PullRequestMergeOptions dataclass

PullRequestMergeOptions(*, no_fast_forward: Optional[str] = None, rebase: Optional[str] = None, rebase_merge: Optional[str] = None, squash: Optional[str] = None)

Definition: PullRequestMergeOptions

Attributes

no_fast_forward class-attribute instance-attribute

no_fast_forward: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'noFastForward'})

A two-parent, no-fast-forward merge. The source branch is unchanged. This is the default behavior.

rebase class-attribute instance-attribute

rebase: Optional[str] = dataclass_field(default=None, kw_only=True)

Rebase the source branch on top of the target branch HEAD commit, and fast-forward the target branch.

rebase_merge class-attribute instance-attribute

rebase_merge: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'rebaseMerge'})

Rebase the source branch on top of the target branch HEAD commit, and create a two-parent, no-fast-forward merge.

squash class-attribute instance-attribute

squash: Optional[str] = dataclass_field(default=None, kw_only=True)

Put all changes from the pull request into a single-parent commit.

PullRequestMergeStrategy dataclass

PullRequestMergeStrategy(*, conflict_authorship_commits: Optional[bool] = None, detect_rename_false_positives: Optional[bool] = None, disable_renames: Optional[bool] = None)

Definition: PullRequestMergeStrategy

Attributes

conflict_authorship_commits class-attribute instance-attribute

conflict_authorship_commits: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'conflictAuthorshipCommits'})

If true, conflict resolutions applied during the merge will be put in separate commits to preserve authorship info for git blame.

detect_rename_false_positives class-attribute instance-attribute

detect_rename_false_positives: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'detectRenameFalsePositives'})

If true, detects rename false positives.

disable_renames class-attribute instance-attribute

disable_renames: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'disableRenames'})

If true, rename detection will not be performed during the merge.

PullRequestCompletionOptions dataclass

PullRequestCompletionOptions(*, auto_complete_ignore_config_ids: Optional[List[int]] = None, bypass_policy: Optional[bool] = None, bypass_reason: Optional[str] = None, delete_source_branch: Optional[bool] = None, merge_commit_message: Optional[str] = None, merge_strategy: Optional[PullRequestMergeStrategy | Mapping[str, Any]] = None, squash_merge: Optional[bool] = None, transition_work_items: Optional[bool] = None)

Definition: PullRequestCompletionOptions

Attributes

auto_complete_ignore_config_ids class-attribute instance-attribute

auto_complete_ignore_config_ids: Optional[List[int]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'autoCompleteIgnoreConfigIds'})

List of any policy configuration Id's which auto-complete should not wait for

bypass_policy class-attribute instance-attribute

bypass_policy: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bypassPolicy'})

If true, policies will be explicitly bypassed while the pull request is completed.

bypass_reason class-attribute instance-attribute

bypass_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bypassReason'})

If policies are bypassed, this reason is stored as to why bypass was used.

delete_source_branch class-attribute instance-attribute

delete_source_branch: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'deleteSourceBranch'})

If true, the source branch of the pull request will be deleted after completion.

merge_commit_message class-attribute instance-attribute

merge_commit_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mergeCommitMessage'})

If set, this will be used as the commit message of the merge commit.

squash_merge class-attribute instance-attribute

squash_merge: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'squashMerge'})

If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.

transition_work_items class-attribute instance-attribute

transition_work_items: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'transitionWorkItems'})

If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved).

CommitGitUserDate dataclass

CommitGitUserDate(*, date: Optional[str] = None, email: Optional[str] = None, image_url: Optional[str] = None, name: Optional[str] = None)

Definition: CommitGitUserDate

Attributes

date class-attribute instance-attribute

date: Optional[str] = dataclass_field(default=None, kw_only=True)

Date of the Git operation.

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

Email address of the user performing the Git operation.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

Url for the user's avatar.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the user performing the Git operation.

GitCommitRef dataclass

GitCommitRef(*, author: Optional[CommitGitUserDate | Mapping[str, Any]] = None, comment: Optional[str] = None, comment_truncated: Optional[str] = None, commit_id: Optional[str] = None, committer: Optional[CommitGitUserDate | Mapping[str, Any]] = None, parents: Optional[List[str]] = None, remote_url: Optional[str] = None, url: Optional[str] = None)

Definition: GitCommitRef

Attributes

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True)

Comment or message of the commit.

comment_truncated class-attribute instance-attribute

comment_truncated: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentTruncated'})

Indicates if the comment is truncated from the full Git commit comment message.

commit_id class-attribute instance-attribute

commit_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commitId'})

Id of the commit.

parents class-attribute instance-attribute

parents: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

An enumeration of the parent commit IDs for this commit.

remote_url class-attribute instance-attribute

remote_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'remoteUrl'})

Remote URL path to the commit.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

REST URL for this resource.

GitRefUpdate dataclass

GitRefUpdate(*, name: Optional[str] = None, repository_id: Optional[str] = None, old_object_id: Optional[str] = None, new_object_id: Optional[str] = None)

Definition: GitRefUpdate

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the Git Ref that was updated.

repository_id class-attribute instance-attribute

repository_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'repositoryId'})

The unique id of the repository.

old_object_id class-attribute instance-attribute

old_object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldObjectId'})

The id of the previous commit this Ref pointed to before the update.

new_object_id class-attribute instance-attribute

new_object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newObjectId'})

The id of the new commit this Ref pointed to before the update.

Project dataclass

Project(*, id: Optional[str] = None, name: Optional[str] = None, url: Optional[str] = None)

Definition: Project

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the project.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the project.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The API URL of the project.

Team dataclass

Team(*, id: Optional[str] = None, name: Optional[str] = None, url: Optional[str] = None, description: Optional[str] = None, identity_url: Optional[str] = None)

Definition: Team

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique id of the team.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The name of the team.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URI of the team.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the team.

identity_url class-attribute instance-attribute

identity_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'identityUrl'})

The URI of the team's identity.

TeamMember dataclass

TeamMember(*, id: Optional[str] = None, display_name: Optional[str] = None, unique_name: Optional[str] = None, url: Optional[str] = None, image_url: Optional[str] = None)

Definition: TeamMember

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique id of the team member.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The display name of the team member.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The username of the team member.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URI of the team member.

image_url class-attribute instance-attribute

image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imageUrl'})

The image URI of the team member.

ReleaseDefinition dataclass

ReleaseDefinition(*, comment: Optional[str] = None, created_on: Optional[str] = None, description: Optional[str] = None, id: Optional[int] = None, modified_by: Optional[IdentityRef | Mapping[str, Any]] = None, modified_on: Optional[str] = None, name: Optional[str] = None, path: Optional[str] = None, release_name_format: Optional[str] = None, revision: Optional[int] = None, source: Optional[str] = None, tags: Optional[List[str]] = None, url: Optional[str] = None)

Definition: ReleaseDefinition

Attributes

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comment'})

The comment of the release definition.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedOn'})

The date on which the release definition was created.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the release definition.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the release definition.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ModifiedOn'})

The date on which the release definition was modified.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release definition.

path class-attribute instance-attribute

path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The path of the release definition.

release_name_format class-attribute instance-attribute

release_name_format: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReleaseNameFormat'})

The release name format of the release definition.

revision class-attribute instance-attribute

revision: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Revision'})

The revision number of the release definition.

source class-attribute instance-attribute

source: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Source'})

The source of the release definition.

tags class-attribute instance-attribute

tags: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Tags'})

The list of tags of the release definition.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL to access the release definition.

ReleaseReference dataclass

ReleaseReference(*, links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = None, artifacts: Optional[List[Artifact | Mapping[str, Any]]] = None, created_by: Optional[IdentityRef | Mapping[str, Any]] = None, created_on: Optional[str] = None, description: Optional[str] = None, id: Optional[int] = None, modified_by: Optional[IdentityRef | Mapping[str, Any]] = None, name: Optional[str] = None, reason: Optional[str] = None, release_definition: Optional[ReleaseDefinitionShallowReference | Mapping[str, Any]] = None, url: Optional[str] = None, web_access_url: Optional[str] = None)

Definition: ReleaseReference

Attributes

links class-attribute instance-attribute

links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_links'})

Links to access the release.

artifacts class-attribute instance-attribute

artifacts: Optional[List[Artifact | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Artifacts'})

The list of artifacts.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedOn'})

The date on which the release was created.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the release.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the release.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release.

reason class-attribute instance-attribute

reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reason'})

The reason for the release.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL of the release reference.

web_access_url class-attribute instance-attribute

web_access_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WebAccessUrl'})

The web access URL of the release reference.

IdentityRef dataclass

IdentityRef(*, directory_alias: Optional[str] = None, display_name: Optional[str] = None, unique_name: Optional[str] = None, url: Optional[str] = None, id: Optional[str] = None)

Definition: IdentityRef

Attributes

directory_alias class-attribute instance-attribute

directory_alias: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DirectoryAlias'})

The directory alias of the identity reference.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})

The display name of the identity reference.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UniqueName'})

The unique name of the identity reference.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL of the identity reference.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The Id of the identity reference.

PropertiesCollection dataclass

PropertiesCollection(*, count: Optional[int] = None, item: Optional[ObjectEntity | Mapping[str, Any]] = None, keys: Optional[List[str]] = None, values: Optional[List[str]] = None)

Definition: PropertiesCollection

Attributes

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Count'})

The count of properties in the collection.

keys class-attribute instance-attribute

keys: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Keys'})

The list of keys of the properties collection.

values class-attribute instance-attribute

values: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Values'})

The list of values of the properties collection.

RetentionPolicy dataclass

RetentionPolicy(*, days_to_keep: Optional[int] = None)

Definition: RetentionPolicy

Attributes

days_to_keep class-attribute instance-attribute

days_to_keep: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DaysToKeep'})

The number of days to retain the release for.

ReleaseTriggerBase dataclass

ReleaseTriggerBase(*, trigger_type: Optional[str] = None)

Definition: ReleaseTriggerBase

Attributes

trigger_type class-attribute instance-attribute

trigger_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TriggerType'})

The type of release trigger.

ConfigurationVariableValue dataclass

ConfigurationVariableValue(*, is_secret: Optional[bool] = None, value: Optional[str] = None)

Definition: ConfigurationVariableValue

Attributes

is_secret class-attribute instance-attribute

is_secret: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsSecret'})

Specifies whether the configuration variable is secret or not.

value class-attribute instance-attribute

value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Value'})

The value of the configuration variable.

Artifact dataclass

Artifact(*, alias: Optional[str] = None, is_primary: Optional[bool] = None, source_id: Optional[str] = None, type_: Optional[str] = None, definition_reference: Optional[Dict[str, ArtifactSourceReference | Mapping[str, Any]]] = None)

Definition: Artifact

Attributes

alias class-attribute instance-attribute

alias: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Alias'})

The alias of the artifact.

is_primary class-attribute instance-attribute

is_primary: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsPrimary'})

Specfies whether the artifact is primary or not.

source_id class-attribute instance-attribute

source_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SourceId'})

The unique identifier of the source of the artifact.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Type'})

The type of the artifact.

definition_reference class-attribute instance-attribute

definition_reference: Optional[Dict[str, ArtifactSourceReference | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DefinitionReference'})

The dictionary of definition references associated with the artifact.

ReleaseDefinitionShallowReference dataclass

ReleaseDefinitionShallowReference(*, id: Optional[int] = None, name: Optional[str] = None, url: Optional[str] = None)

Definition: ReleaseDefinitionShallowReference

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the release definition.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release definition.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The REST API URL to access the release definition.

ArtifactSourceReference dataclass

ArtifactSourceReference(*, id: Optional[str] = None, name: Optional[str] = None)

Definition: ArtifactSourceReference

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the artifact source reference.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the artifact source reference.

ReleaseStartMetadata dataclass

ReleaseStartMetadata(*, description: Optional[str] = None, is_draft: Optional[bool] = None, reason: Optional[str] = None, variables: Optional[List[ConfigurationVariable | Mapping[str, Any]]] = None)

Definition: ReleaseStartMetadata

Attributes

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the release start metadata.

is_draft class-attribute instance-attribute

is_draft: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsDraft'})

Specifies whether the release is a draft.

reason class-attribute instance-attribute

reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reason'})

The reason for the release start metadata.

variables class-attribute instance-attribute

variables: Optional[List[ConfigurationVariable | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Variables'})

Release variables.

ArtifactMetadata dataclass

ArtifactMetadata(*, alias: Optional[str] = None, instance_reference: Optional[BuildVersion | Mapping[str, Any]] = None)

Definition: ArtifactMetadata

Attributes

alias class-attribute instance-attribute

alias: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Alias'})

The alias of the artifact.

ConfigurationVariable dataclass

ConfigurationVariable(name: str, *, value: Optional[str] = None)

Definition: ConfigurationVariable

Attributes

name class-attribute instance-attribute

name: str = dataclass_field(metadata={'wire_name': 'Name'})

The name of the configuration variable.

value class-attribute instance-attribute

value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Value'})

The value of the configuration variable.

BuildVersion dataclass

BuildVersion(*, id: Optional[str] = None, name: Optional[str] = None, source_branch: Optional[str] = None, source_repository_id: Optional[str] = None, source_repository_type: Optional[str] = None, source_version: Optional[str] = None)

Definition: BuildVersion

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the build version.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the build version.

source_branch class-attribute instance-attribute

source_branch: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SourceBranch'})

The source branch of the build version.

source_repository_id class-attribute instance-attribute

source_repository_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SourceRepositoryId'})

The unique identifier of the source repository of the build version.

source_repository_type class-attribute instance-attribute

source_repository_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SourceRepositoryType'})

The source repository type of the build version.

source_version class-attribute instance-attribute

source_version: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SourceVersion'})

The source version of the build version.

ProjectReference dataclass

ProjectReference(*, id: Optional[str] = None, name: Optional[str] = None)

Definition: ProjectReference

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the project reference.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the project reference.

VariableGroup dataclass

VariableGroup(*, created_by: Optional[IdentityRef | Mapping[str, Any]] = None, created_on: Optional[str] = None, description: Optional[str] = None, id: Optional[int] = None, modified_by: Optional[IdentityRef | Mapping[str, Any]] = None, modified_on: Optional[str] = None, name: Optional[str] = None, provider_data: Optional[VariableGroupProviderData | Mapping[str, Any]] = None, type_: Optional[str] = None, variables: Optional[Dict[str, VariableValue | Mapping[str, Any]]] = None)

Definition: VariableGroup

Attributes

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedOn'})

The date on which the variable group was created.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the variable group.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the variable group.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ModifiedOn'})

The date on which the variable group was modified.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the variable group.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Type'})

The type of the variable group.

variables class-attribute instance-attribute

variables: Optional[Dict[str, VariableValue | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Variables'})

The dictionary of variables of the variable group.

ReleaseCondition dataclass

ReleaseCondition(*, result: Optional[bool] = None, condition_type: Optional[str] = None, name: Optional[str] = None, value: Optional[str] = None)

Definition: ReleaseCondition

Attributes

result class-attribute instance-attribute

result: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Result'})

The result of the release condition.

condition_type class-attribute instance-attribute

condition_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConditionType'})

The condition type of the release condition.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release condition.

value class-attribute instance-attribute

value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Value'})

The value of the release condition.

Demand dataclass

Demand(*, name: Optional[str] = None, value: Optional[str] = None)

Definition: Demand

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the demand.

value class-attribute instance-attribute

value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Value'})

The value of the demand.

DeployPhase dataclass

DeployPhase(*, name: Optional[str] = None, phase_type: Optional[str] = None, rank: Optional[int] = None, workflow_tasks: Optional[List[WorkflowTask | Mapping[str, Any]]] = None)

Definition: DeployPhase

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the deploy phase.

phase_type class-attribute instance-attribute

phase_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhaseType'})

The type of the deploy phase.

rank class-attribute instance-attribute

rank: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rank'})

The rank of the deploy phase.

workflow_tasks class-attribute instance-attribute

workflow_tasks: Optional[List[WorkflowTask | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WorkflowTasks'})

The list of workflow tasks of the deploy phase.

DeploymentAttempt dataclass

DeploymentAttempt(*, attempt: Optional[int] = None, deployment_id: Optional[int] = None, error_log: Optional[str] = None, has_started: Optional[bool] = None, id: Optional[int] = None, job: Optional[ReleaseTask | Mapping[str, Any]] = None, last_modified_by: Optional[IdentityRef | Mapping[str, Any]] = None, last_modified_on: Optional[str] = None, operation_status: Optional[str] = None, queued_on: Optional[str] = None, reason: Optional[str] = None, release_deploy_phases: Optional[List[ReleaseDeployPhase | Mapping[str, Any]]] = None, requested_by: Optional[IdentityRef | Mapping[str, Any]] = None, requested_for: Optional[IdentityRef | Mapping[str, Any]] = None, run_plan_id: Optional[str] = None, status: Optional[str] = None, tasks: Optional[List[ReleaseTask | Mapping[str, Any]]] = None)

Definition: DeploymentAttempt

Attributes

attempt class-attribute instance-attribute

attempt: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attempt'})

The attempt count of the deployment attempt.

deployment_id class-attribute instance-attribute

deployment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DeploymentId'})

The unique identifier of the deployment.

error_log class-attribute instance-attribute

error_log: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorLog'})

The error log to show any unexpected errors that occurred during executing the deployment steps.

has_started class-attribute instance-attribute

has_started: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasStarted'})

The time at which the deployment started, and null if it has not been deployed yet.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the deployment attempt.

last_modified_on class-attribute instance-attribute

last_modified_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LastModifiedOn'})

The date at which the deployment attempt was last modified.

operation_status class-attribute instance-attribute

operation_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OperationStatus'})

The operation status of the deployment attempt.

queued_on class-attribute instance-attribute

queued_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'QueuedOn'})

The date on which the deployment attempt was queued.

reason class-attribute instance-attribute

reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reason'})

The reason of the deployment attempt.

release_deploy_phases class-attribute instance-attribute

release_deploy_phases: Optional[List[ReleaseDeployPhase | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReleaseDeployPhases'})

The lsit of release deploy phases of the deployment attempt.

run_plan_id class-attribute instance-attribute

run_plan_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RunPlanId'})

The unique identifier of the run plan for the deployment attempt.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

The status of the deployment attempt.

tasks class-attribute instance-attribute

tasks: Optional[List[ReleaseTask | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Tasks'})

The list of tasks of the deployment attempt.

EnvironmentOptions dataclass

EnvironmentOptions(*, email_notification_type: Optional[str] = None, email_recipients: Optional[str] = None, enable_access_token: Optional[bool] = None, publish_deployment_status: Optional[bool] = None, skip_artifacts_download: Optional[bool] = None, timeout_in_minutes: Optional[int] = None)

Definition: EnvironmentOptions

Attributes

email_notification_type class-attribute instance-attribute

email_notification_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmailNotificationType'})

The email notification type environment option.

email_recipients class-attribute instance-attribute

email_recipients: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EmailRecipients'})

The email recipients environment option.

enable_access_token class-attribute instance-attribute

enable_access_token: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnableAccessToken'})

The enable access token environment option.

publish_deployment_status class-attribute instance-attribute

publish_deployment_status: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PublishDeploymentStatus'})

The publish deployment status environment option.

skip_artifacts_download class-attribute instance-attribute

skip_artifacts_download: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SkipArtifactsDownload'})

The skip artifacts download environment option.

timeout_in_minutes class-attribute instance-attribute

timeout_in_minutes: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeoutInMinutes'})

The timeout in minutes environment option.

ReleaseDefinitionApprovals dataclass

ReleaseDefinitionApprovals(*, approval_options: Optional[ApprovalOptions | Mapping[str, Any]] = None, approvals: Optional[List[ReleaseDefinitionApprovalStep | Mapping[str, Any]]] = None)

Definition: ReleaseDefinitionApprovals

Attributes

approvals class-attribute instance-attribute

approvals: Optional[List[ReleaseDefinitionApprovalStep | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Approvals'})

The list of approvals.

ReleaseApproval dataclass

ReleaseApproval(*, approval_type: Optional[str] = None, approved_by: Optional[IdentityRef | Mapping[str, Any]] = None, approver: Optional[IdentityRef | Mapping[str, Any]] = None, attempt: Optional[int] = None, comments: Optional[str] = None, created_on: Optional[str] = None, history: Optional[List[ReleaseApprovalHistory | Mapping[str, Any]]] = None, id: Optional[int] = None, is_automated: Optional[bool] = None, is_notification_on: Optional[bool] = None, modified_on: Optional[str] = None, rank: Optional[int] = None, release: Optional[ReleaseShallowReference | Mapping[str, Any]] = None, release_definition: Optional[ReleaseDefinitionShallowReference | Mapping[str, Any]] = None, release_environment: Optional[ReleaseEnvironmentShallowReference | Mapping[str, Any]] = None, revision: Optional[int] = None, status: Optional[str] = None, trial_number: Optional[int] = None, url: Optional[str] = None)

Definition: ReleaseApproval

Attributes

approval_type class-attribute instance-attribute

approval_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ApprovalType'})

The type of approval.

attempt class-attribute instance-attribute

attempt: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attempt'})

Specifies at which deployment attempt the approval belongs.

comments class-attribute instance-attribute

comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})

The comments for the approval.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedOn'})

The date at which the approval was created.

history class-attribute instance-attribute

history: Optional[List[ReleaseApprovalHistory | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'History'})

Specifies all approvals associated with the approval.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the approval.

is_automated class-attribute instance-attribute

is_automated: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAutomated'})

Specifies whether the approval is automated.

is_notification_on class-attribute instance-attribute

is_notification_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsNotificationOn'})

Specifies whether notifications are on for the approval.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ModifiedOn'})

The date on which the approval was modified.

rank class-attribute instance-attribute

rank: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rank'})

The order of the approval. e.g. Same rank denotes parallel approval.

revision class-attribute instance-attribute

revision: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Revision'})

The revision number of the approval.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

The status of the approval.

trial_number class-attribute instance-attribute

trial_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TrialNumber'})

The trial number of the approval.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL to access the approval.

ProcessParameters dataclass

ProcessParameters(*, data_source_bindings: Optional[List[DataSourceBindingBase | Mapping[str, Any]]] = None, inputs: Optional[List[TaskInputDefinitionBase | Mapping[str, Any]]] = None, source_definitions: Optional[List[TaskSourceDefinitionBase | Mapping[str, Any]]] = None)

Definition: ProcessParameters

Attributes

data_source_bindings class-attribute instance-attribute

data_source_bindings: Optional[List[DataSourceBindingBase | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DataSourceBindings'})

The list of data source bindings of the process parameters.

inputs class-attribute instance-attribute

inputs: Optional[List[TaskInputDefinitionBase | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Inputs'})

The list of inputs of the process parameters.

source_definitions class-attribute instance-attribute

source_definitions: Optional[List[TaskSourceDefinitionBase | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SourceDefinitions'})

The list of source definitions of the process parameters.

ReleaseShallowReference dataclass

ReleaseShallowReference(*, links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = None, id: Optional[int] = None, name: Optional[str] = None, url: Optional[str] = None)

Definition: ReleaseShallowReference

Attributes

links class-attribute instance-attribute

links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_links'})

Links to related resources, APIs, and views for the release.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the release.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The REST API URL to access the release.

ReleaseSchedule dataclass

ReleaseSchedule(*, days_to_release: Optional[str] = None, job_id: Optional[str] = None, start_hours: Optional[int] = None, start_minutes: Optional[int] = None, time_zone_id: Optional[str] = None)

Definition: ReleaseSchedule

Attributes

days_to_release class-attribute instance-attribute

days_to_release: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DaysToRelease'})

Days of the week to release.

job_id class-attribute instance-attribute

job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobId'})

The unique identifier of the Team Foundation Job Definition.

start_hours class-attribute instance-attribute

start_hours: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartHours'})

Local time zone hour to start.

start_minutes class-attribute instance-attribute

start_minutes: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartMinutes'})

Local time zone minute to start.

time_zone_id class-attribute instance-attribute

time_zone_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeZoneId'})

Time Zone Id of the release schedule, such as 'UTC'.

WorkflowTask dataclass

WorkflowTask(*, always_run: Optional[bool] = None, condition: Optional[str] = None, continue_on_error: Optional[bool] = None, definition_type: Optional[str] = None, enabled: Optional[bool] = None, inputs: Optional[Dict[str, str]] = None, name: Optional[str] = None, override_inputs: Optional[Dict[str, str]] = None, ref_name: Optional[str] = None, task_id: Optional[str] = None, timeout_in_minutes: Optional[int] = None, version: Optional[str] = None)

Definition: WorkflowTask

Attributes

always_run class-attribute instance-attribute

always_run: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AlwaysRun'})

Specifies whether the workflow task will always run.

condition class-attribute instance-attribute

condition: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Condition'})

The condition of the workflow task.

continue_on_error class-attribute instance-attribute

continue_on_error: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContinueOnError'})

Specifies whether the workflow task will continue on error.

definition_type class-attribute instance-attribute

definition_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DefinitionType'})

The definition type of the workflow task.

enabled class-attribute instance-attribute

enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Enabled'})

Specifies whether the workflow task is enabled.

inputs class-attribute instance-attribute

inputs: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Inputs'})

The dictionary of inputs of the workflow task.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the workflow task.

override_inputs class-attribute instance-attribute

override_inputs: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OverrideInputs'})

The dictionary of override inputs of the workflow task.

ref_name class-attribute instance-attribute

ref_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RefName'})

The ref name of the workflow task.

task_id class-attribute instance-attribute

task_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaskId'})

The unique identifier of the task of the workflow task.

timeout_in_minutes class-attribute instance-attribute

timeout_in_minutes: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeoutInMinutes'})

The timeout value, in minutes, of the workflow task.

version class-attribute instance-attribute

version: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Version'})

The version of the workflow task.

VariableGroupProviderData dataclass

VariableGroupProviderData(*, additional_properties: Dict[str, Any] = dict())

Definition: VariableGroupProviderData

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

VariableValue dataclass

VariableValue(*, is_secret: Optional[bool] = None, value: Optional[str] = None)

Definition: VariableValue

Attributes

is_secret class-attribute instance-attribute

is_secret: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsSecret'})

Specifies whether the variable value is secret.

value class-attribute instance-attribute

value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Value'})

The variable value.

ReleaseTask dataclass

ReleaseTask(*, agent_name: Optional[str] = None, date_ended: Optional[str] = None, date_started: Optional[str] = None, finish_time: Optional[str] = None, id: Optional[int] = None, issues: Optional[List[Issue | Mapping[str, Any]]] = None, line_count: Optional[int] = None, log_url: Optional[str] = None, name: Optional[str] = None, percent_complete: Optional[int] = None, rank: Optional[int] = None, start_time: Optional[str] = None, status: Optional[str] = None, task: Optional[WorkflowTaskReference | Mapping[str, Any]] = None, timeline_record_id: Optional[str] = None)

Definition: ReleaseTask

Attributes

agent_name class-attribute instance-attribute

agent_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AgentName'})

The name of the agent associated with the release task.

date_ended class-attribute instance-attribute

date_ended: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateEnded'})

The date on which the release task ended.

date_started class-attribute instance-attribute

date_started: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateStarted'})

The date on which the release task started.

finish_time class-attribute instance-attribute

finish_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FinishTime'})

The finish time of the release task.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the release task.

issues class-attribute instance-attribute

issues: Optional[List[Issue | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Issues'})

The list of issues associated with the release task.

line_count class-attribute instance-attribute

line_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LineCount'})

The line count of the release task.

log_url class-attribute instance-attribute

log_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LogUrl'})

The log URL of the release task.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release task.

percent_complete class-attribute instance-attribute

percent_complete: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PercentComplete'})

The percent of completion of the release task.

rank class-attribute instance-attribute

rank: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rank'})

The rank of the release task.

start_time class-attribute instance-attribute

start_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartTime'})

The start time of the release task.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

The status of the release task.

timeline_record_id class-attribute instance-attribute

timeline_record_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimelineRecordId'})

The unique identifier of the timeline record of the release task.

ReleaseDeployPhase dataclass

ReleaseDeployPhase(*, deployment_jobs: Optional[List[DeploymentJob | Mapping[str, Any]]] = None, error_log: Optional[str] = None, id: Optional[int] = None, manual_interventions: Optional[List[ManualIntervention | Mapping[str, Any]]] = None, phase_type: Optional[str] = None, rank: Optional[int] = None, run_plan_id: Optional[str] = None, status: Optional[str] = None)

Definition: ReleaseDeployPhase

Attributes

deployment_jobs class-attribute instance-attribute

deployment_jobs: Optional[List[DeploymentJob | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DeploymentJobs'})

The list of deployment jobs in the release deploy phase.

error_log class-attribute instance-attribute

error_log: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ErrorLog'})

The error log of the release deploy phase.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier for the release deploy phase.

manual_interventions class-attribute instance-attribute

manual_interventions: Optional[List[ManualIntervention | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ManualInterventions'})

The list of manual interventions of the release deploy phase.

phase_type class-attribute instance-attribute

phase_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'PhaseType'})

The phase type of the release deploy phase.

rank class-attribute instance-attribute

rank: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rank'})

The rank of the release deploy phase.

run_plan_id class-attribute instance-attribute

run_plan_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RunPlanId'})

The unique identifier of the run plan of the release deploy phase.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

The status of the release deploy phase.

ApprovalOptions dataclass

ApprovalOptions(*, auto_triggered_and_previous_environment_approved_can_be_skipped: Optional[bool] = None, enforce_identity_revalidation: Optional[bool] = None, release_creator_can_be_approver: Optional[bool] = None, required_approver_count: Optional[int] = None, timeout_in_minutes: Optional[int] = None)

Definition: ApprovalOptions

Attributes

auto_triggered_and_previous_environment_approved_can_be_skipped class-attribute instance-attribute

auto_triggered_and_previous_environment_approved_can_be_skipped: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AutoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped'})

The 'Auto Triggered And Previous Environment Approved Can Be Skipped' approval option.

enforce_identity_revalidation class-attribute instance-attribute

enforce_identity_revalidation: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EnforceIdentityRevalidation'})

The 'Enforce Identity Revalidation' approval option.

release_creator_can_be_approver class-attribute instance-attribute

release_creator_can_be_approver: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReleaseCreatorCanBeApprover'})

The 'Release Creator Can Be Approver' approval option.

required_approver_count class-attribute instance-attribute

required_approver_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RequiredApproverCount'})

The 'Required Approver Count' approval option.

timeout_in_minutes class-attribute instance-attribute

timeout_in_minutes: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeoutInMinutes'})

The 'Timeout In Minutes' approval option.

ReleaseDefinitionApprovalStep dataclass

ReleaseDefinitionApprovalStep(*, approver: Optional[IdentityRef | Mapping[str, Any]] = None, is_automated: Optional[bool] = None, is_notification_on: Optional[bool] = None, rank: Optional[int] = None, id: Optional[int] = None)

Definition: ReleaseDefinitionApprovalStep

Attributes

is_automated class-attribute instance-attribute

is_automated: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAutomated'})

Indicates whether the approval step is automated.

is_notification_on class-attribute instance-attribute

is_notification_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsNotificationOn'})

Indicates whether notifications are on for the approval step.

rank class-attribute instance-attribute

rank: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Rank'})

The rank.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the approval step.

ReleaseApprovalHistory dataclass

ReleaseApprovalHistory(*, approver: Optional[IdentityRef | Mapping[str, Any]] = None, changed_by: Optional[IdentityRef | Mapping[str, Any]] = None, comments: Optional[str] = None, created_on: Optional[str] = None, modified_on: Optional[str] = None, revision: Optional[int] = None)

Definition: ReleaseApprovalHistory

Attributes

comments class-attribute instance-attribute

comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})

The comments of the release approval history.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedOn'})

The date on which the release approval history was created.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ModifiedOn'})

The date on which the release approval history was modified.

revision class-attribute instance-attribute

revision: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Revision'})

The revision of the release approval history.

ReleaseEnvironmentShallowReference dataclass

ReleaseEnvironmentShallowReference(*, links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = None, id: Optional[int] = None, name: Optional[str] = None, url: Optional[str] = None)

Definition: ReleaseEnvironmentShallowReference

Attributes

links class-attribute instance-attribute

links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_links'})

The links to related resources, APIs, and views for the release environment.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of release environment.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the release environment.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The REST API URL to access the release environment.

DataSourceBindingBase dataclass

DataSourceBindingBase(*, data_source_name: Optional[str] = None, endpoint_id: Optional[str] = None, endpoint_url: Optional[str] = None, parameters: Optional[Dict[str, str]] = None, result_selector: Optional[str] = None, result_template: Optional[str] = None, target: Optional[str] = None)

Definition: DataSourceBindingBase

Attributes

data_source_name class-attribute instance-attribute

data_source_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DataSourceName'})

The data source name of the data source binding.

endpoint_id class-attribute instance-attribute

endpoint_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndpointId'})

The unique identifier of the endpoint of the data source binding.

endpoint_url class-attribute instance-attribute

endpoint_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndpointUrl'})

The endpoint URL of the data source binding.

parameters class-attribute instance-attribute

parameters: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Parameters'})

The dictionary of parameters of the data source binding.

result_selector class-attribute instance-attribute

result_selector: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultSelector'})

The result selector of the data source binding.

result_template class-attribute instance-attribute

result_template: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResultTemplate'})

The result template of the data source binding.

target class-attribute instance-attribute

target: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Target'})

The target of the data source binding.

TaskInputDefinitionBase dataclass

TaskInputDefinitionBase(*, default_value: Optional[str] = None, group_name: Optional[str] = None, help_mark_down: Optional[str] = None, label: Optional[str] = None, name: Optional[str] = None, options: Optional[Dict[str, str]] = None, properties: Optional[Dict[str, str]] = None, required: Optional[bool] = None, type_: Optional[str] = None, visible_rule: Optional[str] = None)

Definition: TaskInputDefinitionBase

Attributes

default_value class-attribute instance-attribute

default_value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DefaultValue'})

The default value of the task input definition.

group_name class-attribute instance-attribute

group_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GroupName'})

The group name of the task input definition.

help_mark_down class-attribute instance-attribute

help_mark_down: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HelpMarkDown'})

The help mark down of the task input definition.

label class-attribute instance-attribute

label: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Label'})

The label of the task input definition.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the task input definition.

options class-attribute instance-attribute

options: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Options'})

The dictionary of options of the task input definition.

properties class-attribute instance-attribute

properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Properties'})

The dictionary of properties of the task input definition.

required class-attribute instance-attribute

required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Required'})

Specifies whether the task input definition is required.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Type'})

The type of the task input definition.

visible_rule class-attribute instance-attribute

visible_rule: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'VisibleRule'})

The visible rule of the task input definition.

TaskSourceDefinitionBase dataclass

TaskSourceDefinitionBase(*, auth_key: Optional[str] = None, endpoint: Optional[str] = None, key_selector: Optional[str] = None, selector: Optional[str] = None, target: Optional[str] = None)

Definition: TaskSourceDefinitionBase

Attributes

auth_key class-attribute instance-attribute

auth_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AuthKey'})

The auth key of the task source definition.

endpoint class-attribute instance-attribute

endpoint: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Endpoint'})

The endpoint of the task source definition.

key_selector class-attribute instance-attribute

key_selector: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'KeySelector'})

The key selector of the task source definition.

selector class-attribute instance-attribute

selector: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Selector'})

The selector of the task source definition.

target class-attribute instance-attribute

target: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Target'})

The target of the task source definition.

Issue dataclass

Issue(*, issue_type: Optional[str] = None, message: Optional[str] = None)

Definition: Issue

Attributes

issue_type class-attribute instance-attribute

issue_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IssueType'})

The type of the issue.

message class-attribute instance-attribute

message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Message'})

The message of the issue.

WorkflowTaskReference dataclass

WorkflowTaskReference(*, id: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None)

Definition: WorkflowTaskReference

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the workflow task reference.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the workflow task reference.

version class-attribute instance-attribute

version: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Version'})

The version of the workflow task reference.

DeploymentJob dataclass

DeploymentJob(*, job: Optional[ReleaseTask | Mapping[str, Any]] = None, tasks: Optional[List[ReleaseTask | Mapping[str, Any]]] = None)

Definition: DeploymentJob

Attributes

tasks class-attribute instance-attribute

tasks: Optional[List[ReleaseTask | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Tasks'})

The list of additional tasks of the deployment job.

ManualIntervention dataclass

ManualIntervention(*, approver: Optional[IdentityRef | Mapping[str, Any]] = None, comments: Optional[str] = None, created_on: Optional[str] = None, id: Optional[int] = None, instructions: Optional[str] = None, modified_on: Optional[str] = None, name: Optional[str] = None, release: Optional[ReleaseShallowReference | Mapping[str, Any]] = None, release_definition: Optional[ReleaseDefinitionShallowReference | Mapping[str, Any]] = None, release_environment: Optional[ReleaseEnvironmentShallowReference | Mapping[str, Any]] = None, status: Optional[str] = None, task_instance_id: Optional[str] = None, url: Optional[str] = None)

Definition: ManualIntervention

Attributes

comments class-attribute instance-attribute

comments: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Comments'})

The comments of the manual intervention.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedOn'})

The date on which the manual intervention was created.

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the manual intervention.

instructions class-attribute instance-attribute

instructions: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Instructions'})

The instructions of the manual intervention.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ModifiedOn'})

The date on which the manual intervention was modified.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the manual intervention.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Status'})

The status of the manual intervention.

task_instance_id class-attribute instance-attribute

task_instance_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TaskInstanceId'})

The unique identifier of the task instance associated with the manual intervention.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL of the manual intervention.

TfvcChangeset dataclass

TfvcChangeset(*, changeset_id: Optional[int] = None, author: Optional[ChangesetAuthor | Mapping[str, Any]] = None, checked_in_by: Optional[ChangesetCheckedInBy | Mapping[str, Any]] = None, created_date: Optional[str] = None, comment: Optional[str] = None)

Definition: TfvcChangeset

Attributes

changeset_id class-attribute instance-attribute

changeset_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changesetId'})

The unique id of the changeset.

created_date class-attribute instance-attribute

created_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDate'})

The datetime the changeset was created.

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True)

The comment describing the changeset.

ChangesetAuthor dataclass

ChangesetAuthor(*, display_name: Optional[str] = None, unique_name: Optional[str] = None)

Definition: ChangesetAuthor

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The name of the user who created the changeset.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the user who created the changeset.

ChangesetCheckedInBy dataclass

ChangesetCheckedInBy(*, display_name: Optional[str] = None, unique_name: Optional[str] = None)

Definition: ChangesetCheckedInBy

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The name of the user who checked in the changeset.

unique_name class-attribute instance-attribute

unique_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'uniqueName'})

The unique name of the user who created the changeset.

VstsHttpRequestBodyParameters dataclass

VstsHttpRequestBodyParameters(method: str, uri: str, *, headers: Optional[Dict[str, str]] = None, body: Optional[str] = None, is_base64: Optional[bool] = None)

Definition: VstsHttpRequestBodyParameters

Attributes

method class-attribute instance-attribute

method: str = dataclass_field(metadata={'wire_name': 'Method'})

The HTTP method.

uri class-attribute instance-attribute

uri: str = dataclass_field(metadata={'wire_name': 'Uri'})

The relative URI. Example: {project}/{team}/_apis/wit/templates?api-version=5.0-preview.1.

headers class-attribute instance-attribute

headers: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Headers'})

The request headers.

body class-attribute instance-attribute

body: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Body'})

The request content. Can be JSON object or binary data encoded as Base64 string.

is_base64 class-attribute instance-attribute

is_base64: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsBase64'})

Must be true if request content is encoded as Base64 string.

WorkItemHit dataclass

WorkItemHit(*, field_reference_name: Optional[str] = None, highlights: Optional[List[str]] = None)

Definition: WorkItemHit

Attributes

field_reference_name class-attribute instance-attribute

field_reference_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fieldReferenceName'})

Reference name of the highlighted field.

highlights class-attribute instance-attribute

highlights: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

Matched/highlighted snippets of the field.

WorkItemResult dataclass

WorkItemResult(*, project: Optional[SearchProject | Mapping[str, Any]] = None, fields: Optional[Dict[str, ObjectWithoutType | Mapping[str, Any]]] = None, hits: Optional[List[WorkItemHit | Mapping[str, Any]]] = None, url: Optional[str] = None)

Definition: WorkItemResult

Attributes

fields class-attribute instance-attribute

fields: Optional[Dict[str, ObjectWithoutType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A standard set of work item fields and their values.

hits class-attribute instance-attribute

hits: Optional[List[WorkItemHit | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Highlighted snippets of fields that match the search request.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

Reference to the work item.

SearchProject dataclass

SearchProject(*, id: Optional[str] = None, name: Optional[str] = None)

Definition: SearchProject

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Id of the project.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the project.

WorkItemSearchRequest dataclass

WorkItemSearchRequest(search_text: str, *, skip: Optional[int] = None, top: Optional[int] = None, filters: Optional[Dict[str, List[str]]] = None, include_facets: Optional[bool] = None, order_by: Optional[List[SortOption | Mapping[str, Any]]] = None)

Definition: WorkItemSearchRequest

Attributes

search_text class-attribute instance-attribute

search_text: str = dataclass_field(metadata={'wire_name': 'searchText'})

The search text.

skip class-attribute instance-attribute

skip: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '$skip'})

Number of results to be skipped. Defaults to 0.

top class-attribute instance-attribute

top: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '$top'})

Number of results to be returned. Defaults to 100.

filters class-attribute instance-attribute

filters: Optional[Dict[str, List[str]]] = dataclass_field(default=None, kw_only=True)

Filters to be applied. Set it to null if there are no filters to be applied.

include_facets class-attribute instance-attribute

include_facets: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'includeFacets'})

Flag to opt for faceting in the result. Default behavior is false.

order_by class-attribute instance-attribute

order_by: Optional[List[SortOption | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '$orderBy'})

Options for sorting search results. If set to null, the results will be returned sorted by relevance. If more than one sort option is provided, the results are sorted in the order specified in the OrderBy.

SortOption dataclass

SortOption(*, field: Optional[str] = None, sort_order: Optional[str] = None)

Definition: SortOption

Attributes

field class-attribute instance-attribute

field: Optional[str] = dataclass_field(default=None, kw_only=True)

Field name on which sorting should be done.

sort_order class-attribute instance-attribute

sort_order: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sortOrder'})

Order (ASC/DESC) in which the results should be sorted.

FacetItem dataclass

FacetItem(*, name: Optional[str] = None, id: Optional[str] = None, result_count: Optional[int] = None)

Definition: FacetItem

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Name of the facet item.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Id of the facet item.

result_count class-attribute instance-attribute

result_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resultCount'})

Number of results for this facet item.

WorkItemType dataclass

WorkItemType(*, description: Optional[str] = None, name: Optional[str] = None, xml_form: Optional[str] = None, field_instances: Optional[List[WorkItemTypeFieldInstance | Mapping[str, Any]]] = None, icon: Optional[Dict[str, Any]] = None, states: Optional[List[WorkItemStateColor | Mapping[str, Any]]] = None)

Definition: WorkItemType

Attributes

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the type.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the type.

xml_form class-attribute instance-attribute

xml_form: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'XmlForm'})

An XML representation of the type.

field_instances class-attribute instance-attribute

field_instances: Optional[List[WorkItemTypeFieldInstance | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FieldInstances'})

A list of field instances associated with the type.

icon class-attribute instance-attribute

icon: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Work Item Icon

states class-attribute instance-attribute

states: Optional[List[WorkItemStateColor | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

States of work item type

WorkItemTypeFieldInstance dataclass

WorkItemTypeFieldInstance(*, always_required: Optional[bool] = None, reference_name: Optional[str] = None, name: Optional[str] = None, url: Optional[str] = None)

Definition: WorkItemTypeFieldInstance

Attributes

always_required class-attribute instance-attribute

always_required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AlwaysRequired'})

Specifies whether the field instance is always required.

reference_name class-attribute instance-attribute

reference_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReferenceName'})

The reference name of the field instance.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the field instance.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

A URL pointing to field instance details.

UpdateWorkItemRequest dataclass

UpdateWorkItemRequest(*, title: Optional[str] = None, description: Optional[str] = None, priority: Optional[int] = None, iteration: Optional[str] = None, area: Optional[str] = None, link_url: Optional[str] = None, link_type: Optional[str] = None, link_comment: Optional[str] = None, dynamic_fields: Optional[Dict[str, Any]] = None, user_entered_fields: Optional[Dict[str, str]] = None)

Definition: UpdateWorkItemRequest

Attributes

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

The title of the work item.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the work item.

priority class-attribute instance-attribute

priority: Optional[int] = dataclass_field(default=None, kw_only=True)

The priority of the work item.

iteration class-attribute instance-attribute

iteration: Optional[str] = dataclass_field(default=None, kw_only=True)

The iteration path of the work item.

area class-attribute instance-attribute

area: Optional[str] = dataclass_field(default=None, kw_only=True)

The area path of the work item.

link_url class-attribute instance-attribute

link_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkUrl'})

The URL of the work item to link with this one.

link_type class-attribute instance-attribute

link_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkType'})

The type of link to between the work items.

link_comment class-attribute instance-attribute

link_comment: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkComment'})

The comment for the link.

user_entered_fields class-attribute instance-attribute

user_entered_fields: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userEnteredFields'})

Other work item fields, including custom fields. 'Key' is field name and 'Value' is field value.

QueryResultWorkItemResponse dataclass

QueryResultWorkItemResponse(*, system_id: Optional[int] = None, system_area_path: Optional[str] = None, system_team_project: Optional[str] = None, system_iteration_path: Optional[str] = None, system_work_item_type: Optional[str] = None, system_state: Optional[str] = None, system_reason: Optional[str] = None, system_created_date: Optional[str] = None, system_created_by: Optional[str] = None, system_changed_date: Optional[str] = None, system_changed_by: Optional[str] = None, system_title: Optional[str] = None, system_description: Optional[str] = None, system_tags: Optional[str] = None, system_assigned_to: Optional[str] = None)

Definition: QueryResultWorkItemResponse

Attributes

system_id class-attribute instance-attribute

system_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Id'})

The unique id of the work item.

system_area_path class-attribute instance-attribute

system_area_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.AreaPath'})

The area path of the work item.

system_team_project class-attribute instance-attribute

system_team_project: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.TeamProject'})

The team project to which the work item belongs.

system_iteration_path class-attribute instance-attribute

system_iteration_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.IterationPath'})

The iteration path of the work item.

system_work_item_type class-attribute instance-attribute

system_work_item_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.WorkItemType'})

The type of the work item.

system_state class-attribute instance-attribute

system_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.State'})

The state of the work item.

system_reason class-attribute instance-attribute

system_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Reason'})

The reason entered for the work item.

system_created_date class-attribute instance-attribute

system_created_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.CreatedDate'})

The datetime the work item was created.

system_created_by class-attribute instance-attribute

system_created_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.CreatedBy'})

The name of the team member who created the work item.

system_changed_date class-attribute instance-attribute

system_changed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.ChangedDate'})

The datetime the work item was changed.

system_changed_by class-attribute instance-attribute

system_changed_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.ChangedBy'})

The name of the team member who changed the work item.

system_title class-attribute instance-attribute

system_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Title'})

The title of the work item.

system_description class-attribute instance-attribute

system_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Description'})

The description of the work item.

system_tags class-attribute instance-attribute

system_tags: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Tags'})

The tags of the work item.

system_assigned_to class-attribute instance-attribute

system_assigned_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.AssignedTo'})

The name of the team member who currently owns the work item.

ListWorkItemResponse dataclass

ListWorkItemResponse(*, system_id: Optional[int] = None, system_area_path: Optional[str] = None, system_team_project: Optional[str] = None, system_iteration_path: Optional[str] = None, system_work_item_type: Optional[str] = None, system_state: Optional[str] = None, system_reason: Optional[str] = None, system_created_date: Optional[str] = None, system_created_by: Optional[str] = None, system_changed_date: Optional[str] = None, system_changed_by: Optional[str] = None, system_title: Optional[str] = None, system_description: Optional[str] = None, system_tags: Optional[str] = None, system_assigned_to: Optional[str] = None)

Definition: ListWorkItemResponse

Attributes

system_id class-attribute instance-attribute

system_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Id'})

The unique id of the work item.

system_area_path class-attribute instance-attribute

system_area_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.AreaPath'})

The area path of the work item.

system_team_project class-attribute instance-attribute

system_team_project: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.TeamProject'})

The team project to which the work item belongs.

system_iteration_path class-attribute instance-attribute

system_iteration_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.IterationPath'})

The iteration path of the work item.

system_work_item_type class-attribute instance-attribute

system_work_item_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.WorkItemType'})

The type of the work item.

system_state class-attribute instance-attribute

system_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.State'})

The state of the work item.

system_reason class-attribute instance-attribute

system_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Reason'})

The reason entered for the work item.

system_created_date class-attribute instance-attribute

system_created_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.CreatedDate'})

The datetime the work item was created.

system_created_by class-attribute instance-attribute

system_created_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.CreatedBy'})

The name of the team member who created the work item.

system_changed_date class-attribute instance-attribute

system_changed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.ChangedDate'})

The datetime the work item was changed.

system_changed_by class-attribute instance-attribute

system_changed_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.ChangedBy'})

The name of the team member who changed the work item.

system_title class-attribute instance-attribute

system_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Title'})

The title of the work item.

system_description class-attribute instance-attribute

system_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Description'})

The description of the work item.

system_tags class-attribute instance-attribute

system_tags: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.Tags'})

The tags of the work item.

system_assigned_to class-attribute instance-attribute

system_assigned_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System.AssignedTo'})

The name of the team member who currently owns the work item.

TriggerWorkItemResponse dataclass

TriggerWorkItemResponse(*, id: Optional[int] = None, rev: Optional[int] = None, url: Optional[str] = None, fields: Optional[Dict[str, Any]] = None)

Definition: TriggerWorkItemResponse

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique id of the work item.

rev class-attribute instance-attribute

rev: Optional[int] = dataclass_field(default=None, kw_only=True)

The revision count of the work item.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URL of the work item.

WebhookTriggerWorkItemResponse dataclass

WebhookTriggerWorkItemResponse(*, additional_properties: Dict[str, Any] = dict())

Definition: WebhookTriggerWorkItemResponse

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

VstsListWebhookTriggerWorkItemResponse dataclass

VstsListWebhookTriggerWorkItemResponse(*, value: Optional[List[WebhookTriggerWorkItemResponse | Mapping[str, Any]]] = None)

Definition: VstsList[WebhookTriggerWorkItemResponse]

CommentMention dataclass

CommentMention(*, links: Optional[ReferenceLinks | Mapping[str, Any]] = None, artifact_id: Optional[str] = None, artifact_type: Optional[str] = None, comment_id: Optional[int] = None, target_id: Optional[str] = None, url: Optional[str] = None)

Definition: CommentMention

Attributes

artifact_id class-attribute instance-attribute

artifact_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'artifactId'})

The artifact portion of the parsed text (for example, the work item id).

artifact_type class-attribute instance-attribute

artifact_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'artifactType'})

The type assigned to the mention (person, work item, etc).

comment_id class-attribute instance-attribute

comment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentId'})

The comment id that contains the mention.

target_id class-attribute instance-attribute

target_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetId'})

The resolved target of the mention.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST API URL of the mention.

CommentReaction dataclass

CommentReaction(*, links: Optional[ReferenceLinks | Mapping[str, Any]] = None, comment_id: Optional[int] = None, count: Optional[int] = None, is_current_user_engaged: Optional[bool] = None, type_: Optional[CommentReactionType] = None, url: Optional[str] = None)

Definition: CommentReaction

Attributes

comment_id class-attribute instance-attribute

comment_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commentId'})

The id of the comment this reaction belongs to.

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True)

Total number of reactions for this reaction type.

is_current_user_engaged class-attribute instance-attribute

is_current_user_engaged: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isCurrentUserEngaged'})

Indicates whether the current user has engaged with this reaction.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST API URL of the reaction.

ReferenceLinks dataclass

ReferenceLinks(*, additional_properties: Dict[str, Any] = dict())

Definition: ReferenceLinks

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

AddWorkItemLinkRequest dataclass

AddWorkItemLinkRequest(link_type: str, target_url: str, *, comment: Optional[str] = None)

Definition: AddWorkItemLinkRequest

Attributes

link_type class-attribute instance-attribute

link_type: str = dataclass_field(metadata={'wire_name': 'linkType'})

Relation type for the link. Defaults to 'System.LinkTypes.Related' when omitted.

target_url class-attribute instance-attribute

target_url: str = dataclass_field(metadata={'wire_name': 'targetUrl'})

Absolute URL of the link target. Must be an absolute URI and match the expectations for the selected Link Type.

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True)

Optional comment stored alongside the link.

DeleteWorkItemLinkRequest dataclass

DeleteWorkItemLinkRequest(*, link_id: Optional[int] = None, work_item_link_to_remove: Optional[str] = None, link_type: Optional[str] = None)

Definition: DeleteWorkItemLinkRequest

Attributes

link_id class-attribute instance-attribute

link_id: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkId'})

Zero-based relation identifier (attributes.relationId) or array position from the work item response.

work_item_link_to_remove class-attribute instance-attribute

work_item_link_to_remove: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'workItemLinkToRemove'})

Absolute URL of the link to delete when a relation identifier is not provided.

link_type class-attribute instance-attribute

link_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkType'})

Relation type (rel) of the link to delete when matching by URL.

CreateWorkItemCommentRequest dataclass

CreateWorkItemCommentRequest(text: str)

Definition: CreateWorkItemCommentRequest

Attributes

text instance-attribute

text: str

The text of the comment.

WorkItemResponse dataclass

WorkItemResponse(*, id: Optional[int] = None, rev: Optional[int] = None, url: Optional[str] = None, fields: Optional[WorkItemFields | Mapping[str, Any]] = None, relations: Optional[List[Dict[str, Any]]] = None, links: Optional[Dict[str, Any]] = None)

Definition: WorkItemResponse

Attributes

id class-attribute instance-attribute

id: Optional[int] = dataclass_field(default=None, kw_only=True)

The unique id of the work item.

rev class-attribute instance-attribute

rev: Optional[int] = dataclass_field(default=None, kw_only=True)

The revision count of the work item.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The URL of the work item.

relations class-attribute instance-attribute

relations: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

The relations associated with the work item.

links class-attribute instance-attribute

links: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_links'})

Hypermedia links related to the work item.

VstsListWorkItemResponse dataclass

VstsListWorkItemResponse(*, value: Optional[List[WorkItemResponse | Mapping[str, Any]]] = None)

Definition: VstsList[WorkItemResponse]

Attributes

value class-attribute instance-attribute

value: Optional[List[WorkItemResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

VstsListJObject dataclass

VstsListJObject(*, value: Optional[List[ObjectEntity | Mapping[str, Any]]] = None)

Definition: VstsList[JObject]

Attributes

value class-attribute instance-attribute

value: Optional[List[ObjectEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The VSTS Models

QueryHierarchyItem dataclass

QueryHierarchyItem(*, children: Optional[List[QueryHierarchyItem | Mapping[str, Any]]] = None, clauses: Optional[WorkItemQueryClause | Mapping[str, Any]] = None, columns: Optional[List[WorkItemFieldReference | Mapping[str, Any]]] = None, filter_options: Optional[str] = None, has_children: Optional[bool] = None, id: Optional[str] = None, is_deleted: Optional[bool] = None, is_folder: Optional[bool] = None, is_invalid_syntax: Optional[bool] = None, is_public: Optional[bool] = None, link_clauses: Optional[WorkItemQueryClause | Mapping[str, Any]] = None, name: Optional[str] = None, path: Optional[str] = None, query_type: Optional[str] = None, sort_columns: Optional[List[WorkItemQuerySortColumn | Mapping[str, Any]]] = None, source_clauses: Optional[WorkItemQueryClause | Mapping[str, Any]] = None, target_clauses: Optional[WorkItemQueryClause | Mapping[str, Any]] = None, wiql: Optional[str] = None, links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = None, url: Optional[str] = None)

Definition: QueryHierarchyItem

Attributes

children class-attribute instance-attribute

children: Optional[List[QueryHierarchyItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Children'})

The list of children items associated with the query hierarchy item.

columns class-attribute instance-attribute

columns: Optional[List[WorkItemFieldReference | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Columns'})

The list of work item field columns associated with the query hierarchy item.

filter_options class-attribute instance-attribute

filter_options: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'FilterOptions'})

The filter options of the query hierarchy item.

has_children class-attribute instance-attribute

has_children: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasChildren'})

Specifies whether the query hierarchy item has children.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Id'})

The unique identifier of the query hierarchy item.

is_deleted class-attribute instance-attribute

is_deleted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsDeleted'})

Specifies whether the query hierarchy item is deleted.

is_folder class-attribute instance-attribute

is_folder: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsFolder'})

Specifies whether the query hierarchy item is a folder.

is_invalid_syntax class-attribute instance-attribute

is_invalid_syntax: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsInvalidSyntax'})

Specifies whether the query hierarchy item has invalid syntax.

is_public class-attribute instance-attribute

is_public: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsPublic'})

Specifies whether the query hierarchy item is public.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the query hierarchy item.

path class-attribute instance-attribute

path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Path'})

The path of the query hierarchy item.

query_type class-attribute instance-attribute

query_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'QueryType'})

The query type of the query hierarchy item.

sort_columns class-attribute instance-attribute

sort_columns: Optional[List[WorkItemQuerySortColumn | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SortColumns'})

The list of sort columns of the query hierarchy item.

wiql class-attribute instance-attribute

wiql: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Wiql'})

The WIQL of the query hierarchy item.

links class-attribute instance-attribute

links: Optional[Dict[str, GenericLink | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '_links'})

The collection of links relevant to the query hierarchy item.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The full HTTP link to the query hierarchy item.

WorkItemStateColor dataclass

WorkItemStateColor(*, category: Optional[str] = None, color: Optional[str] = None, name: Optional[str] = None)

Definition: WorkItemStateColor

Attributes

category class-attribute instance-attribute

category: Optional[str] = dataclass_field(default=None, kw_only=True)

category of state

color class-attribute instance-attribute

color: Optional[str] = dataclass_field(default=None, kw_only=True)

Color value

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Work item type state name

WorkItemQueryClause dataclass

WorkItemQueryClause(*, clauses: Optional[WorkItemQueryClause | Mapping[str, Any]] = None, field: Optional[WorkItemFieldReference | Mapping[str, Any]] = None, field_value: Optional[WorkItemFieldReference | Mapping[str, Any]] = None, is_field_value: Optional[bool] = None, logical_operator: Optional[str] = None, operator: Optional[WorkItemFieldOperation | Mapping[str, Any]] = None, value: Optional[str] = None)

Definition: WorkItemQueryClause

Attributes

is_field_value class-attribute instance-attribute

is_field_value: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsFieldValue'})

Specifies whether the work item query clause is a field value.

logical_operator class-attribute instance-attribute

logical_operator: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LogicalOperator'})

The logical operator of the work item query clause.

value class-attribute instance-attribute

value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Value'})

The value of the work item query clause.

WorkItemFieldReference dataclass

WorkItemFieldReference(*, name: Optional[str] = None, reference_name: Optional[str] = None, url: Optional[str] = None)

Definition: WorkItemFieldReference

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the work item field reference.

reference_name class-attribute instance-attribute

reference_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReferenceName'})

The reference name of the work item field reference.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL of the work item field reference.

WorkItemQuerySortColumn dataclass

WorkItemQuerySortColumn(*, descending: Optional[bool] = None, field: Optional[WorkItemFieldReference | Mapping[str, Any]] = None)

Definition: WorkItemQuerySortColumn

Attributes

descending class-attribute instance-attribute

descending: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Descending'})

Specifies whether the work item query sort column is descending.

WorkItemField dataclass

WorkItemField(*, name: Optional[str] = None, read_only: Optional[bool] = None, is_identity: Optional[bool] = None, is_picklist: Optional[bool] = None, reference_name: Optional[str] = None, description: Optional[str] = None, supported_operations: Optional[List[WorkItemFieldOperation | Mapping[str, Any]]] = None, type_: Optional[str] = None, url: Optional[str] = None)

Definition: WorkItemField

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The display name of the work item field.

read_only class-attribute instance-attribute

read_only: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReadOnly'})

Specifies whether the field is read-only.

is_identity class-attribute instance-attribute

is_identity: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsIdentity'})

Specifies whether the field contains identity information.

is_picklist class-attribute instance-attribute

is_picklist: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsPicklist'})

Specifies whether the field uses a picklist.

reference_name class-attribute instance-attribute

reference_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReferenceName'})

The reference name of the work item field.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Description'})

The description of the work item field.

supported_operations class-attribute instance-attribute

supported_operations: Optional[List[WorkItemFieldOperation | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SupportedOperations'})

The list of operations supported by the field.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Type'})

The data type of the work item field.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Url'})

The URL of the work item field.

WorkItemFieldOperation dataclass

WorkItemFieldOperation(*, name: Optional[str] = None, reference_name: Optional[str] = None)

Definition: WorkItemFieldOperation

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the work item field operation.

reference_name class-attribute instance-attribute

reference_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReferenceName'})

The reference name of the work item field operation.

CreateWorkItemRequest dataclass

CreateWorkItemRequest(title: str, *, description: Optional[str] = None, priority: Optional[int] = None, iteration: Optional[str] = None, area: Optional[str] = None, link_url: Optional[str] = None, link_type: Optional[str] = None, link_comment: Optional[str] = None, dynamic_fields: Optional[Dict[str, Any]] = None, user_entered_fields: Optional[Dict[str, str]] = None)

Definition: CreateWorkItemRequest

Attributes

title instance-attribute

title: str

The title of the work item.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the work item.

priority class-attribute instance-attribute

priority: Optional[int] = dataclass_field(default=None, kw_only=True)

The priority of the work item.

iteration class-attribute instance-attribute

iteration: Optional[str] = dataclass_field(default=None, kw_only=True)

The iteration path of the work item.

area class-attribute instance-attribute

area: Optional[str] = dataclass_field(default=None, kw_only=True)

The area path of the work item.

link_url class-attribute instance-attribute

link_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkUrl'})

The URL of the work item to link with this one.

link_type class-attribute instance-attribute

link_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkType'})

The type of the link to between the work items.

link_comment class-attribute instance-attribute

link_comment: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'linkComment'})

The comment for the link.

user_entered_fields class-attribute instance-attribute

user_entered_fields: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userEnteredFields'})

Other work item fields, including custom fields. 'Key' is field name and 'Value' is field value.

WorkItemFields dataclass

WorkItemFields(*, system_area_path: Optional[str] = None, system_team_project: Optional[str] = None, system_iteration_path: Optional[str] = None, system_work_item_type: Optional[str] = None, system_state: Optional[str] = None, system_reason: Optional[str] = None, system_created_date: Optional[str] = None, system_created_by: Optional[str] = None, system_changed_date: Optional[str] = None, system_changed_by: Optional[str] = None, system_title: Optional[str] = None, microsoft_v_s_t_s_common_state_change_date: Optional[str] = None, microsoft_v_s_t_s_common_priority: Optional[int] = None, microsoft_v_s_t_s_common_severity: Optional[str] = None, microsoft_v_s_t_s_common_value_area: Optional[str] = None, system_description: Optional[str] = None)

Definition: WorkItemFields

Attributes

system_area_path class-attribute instance-attribute

system_area_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_AreaPath'})

The area path of the work item.

system_team_project class-attribute instance-attribute

system_team_project: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_TeamProject'})

The team project to which the work item belongs.

system_iteration_path class-attribute instance-attribute

system_iteration_path: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_IterationPath'})

The iteration path of the work item.

system_work_item_type class-attribute instance-attribute

system_work_item_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_WorkItemType'})

The type of the work item.

system_state class-attribute instance-attribute

system_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_State'})

The state of the work item.

system_reason class-attribute instance-attribute

system_reason: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_Reason'})

The reason entered for the work item.

system_created_date class-attribute instance-attribute

system_created_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_CreatedDate'})

The datetime the work item was created.

system_created_by class-attribute instance-attribute

system_created_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_CreatedBy'})

The name of the team member who created the work item.

system_changed_date class-attribute instance-attribute

system_changed_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_ChangedDate'})

The datetime the work item was changed.

system_changed_by class-attribute instance-attribute

system_changed_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_ChangedBy'})

The name of the team member who changed the work item.

system_title class-attribute instance-attribute

system_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_Title'})

The title of the work item.

microsoft_v_s_t_s_common_state_change_date class-attribute instance-attribute

microsoft_v_s_t_s_common_state_change_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Microsoft_VSTS_Common_StateChangeDate'})

The datetime the work item state was changed.

microsoft_v_s_t_s_common_priority class-attribute instance-attribute

microsoft_v_s_t_s_common_priority: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Microsoft_VSTS_Common_Priority'})

The priority of the work item.

microsoft_v_s_t_s_common_severity class-attribute instance-attribute

microsoft_v_s_t_s_common_severity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Microsoft_VSTS_Common_Severity'})

The severity of the work item.

microsoft_v_s_t_s_common_value_area class-attribute instance-attribute

microsoft_v_s_t_s_common_value_area: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Microsoft_VSTS_Common_ValueArea'})

The value area of the work item.

system_description class-attribute instance-attribute

system_description: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'System_Description'})

The description of the work item.

WiqlQuery dataclass

WiqlQuery(*, query: Optional[str] = None)

Definition: WiqlQuery

Attributes

query class-attribute instance-attribute

query: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Query'})

WIQL (Work item query language) query to run.

TriggerBatchResponseWorkItemResponse dataclass

TriggerBatchResponseWorkItemResponse(*, value: Optional[List[WorkItemResponse | Mapping[str, Any]]] = None)

Definition: TriggerBatchResponse[WorkItemResponse]

Attributes

value class-attribute instance-attribute

value: Optional[List[WorkItemResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

A list of the response objects.

PipelinesList dataclass

PipelinesList(*, value: Optional[List[Pipeline | Mapping[str, Any]]] = None)

Definition: PipelinesList

CodelessVariableValue dataclass

CodelessVariableValue(*, is_secret: Optional[bool] = None, value: Optional[str] = None)

Definition: CodelessVariableValue

Attributes

is_secret class-attribute instance-attribute

is_secret: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsSecret'})

Specifies whether the variable value is secret.

value class-attribute instance-attribute

value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Value'})

The variable value.

RunResourcesParameters dataclass

RunResourcesParameters(*, builds: Optional[Dict[str, Any]] = None, containers: Optional[Dict[str, Any]] = None, packages: Optional[Dict[str, Any]] = None, pipelines: Optional[Dict[str, Any]] = None, repositories: Optional[Dict[str, Any]] = None)

Definition: RunResourcesParameters

Attributes

builds class-attribute instance-attribute

builds: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

builds

containers class-attribute instance-attribute

containers: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

containers

packages class-attribute instance-attribute

packages: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

packages

pipelines class-attribute instance-attribute

pipelines: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

pipelines

repositories class-attribute instance-attribute

repositories: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

repositories

RunPipelineParameters dataclass

RunPipelineParameters(*, resources: Optional[Dict[str, Any]] = None, template_parameters: Optional[Dict[str, str]] = None, variables: Optional[Dict[str, CodelessVariableValue | Mapping[str, Any]]] = None, stages_to_skip: Optional[List[str]] = None, preview_run: Optional[bool] = None)

Definition: RunPipelineParameters

Attributes

resources class-attribute instance-attribute

resources: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The resource versions the run should use. Use repositories/self/refName to choose the branch to run from.

template_parameters class-attribute instance-attribute

template_parameters: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateParameters'})

The template parameters of the pipeline, as a JSON object of name/value pairs.

variables class-attribute instance-attribute

variables: Optional[Dict[str, CodelessVariableValue | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The runtime variables of the pipeline, as a JSON object keyed by variable name.

stages_to_skip class-attribute instance-attribute

stages_to_skip: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'stagesToSkip'})

The names of the stages that should not run.

preview_run class-attribute instance-attribute

preview_run: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'previewRun'})

Set to true to validate the pipeline without queueing a run.

GitRefItem dataclass

GitRefItem(*, name: Optional[str] = None, object_id: Optional[str] = None, peeled_object_id: Optional[str] = None, url: Optional[str] = None, creator: Optional[Dict[str, Any]] = None)

Definition: GitRefItem

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The full name of the ref, for example refs/heads/main.

object_id class-attribute instance-attribute

object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'objectId'})

The object id the ref points at.

peeled_object_id class-attribute instance-attribute

peeled_object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'peeledObjectId'})

The commit id an annotated tag resolves to.

url class-attribute instance-attribute

url: Optional[str] = dataclass_field(default=None, kw_only=True)

The REST URL of the ref.

creator class-attribute instance-attribute

creator: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The identity that created the ref.

GitRefUpdateRequest dataclass

GitRefUpdateRequest(*, name: Optional[str] = None, old_object_id: Optional[str] = None, new_object_id: Optional[str] = None)

Definition: GitRefUpdateRequest

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The full name of the ref to update or create, for example refs/heads/my-branch.

old_object_id class-attribute instance-attribute

old_object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'oldObjectId'})

The object id the ref currently points at. Use the object id of the base branch when creating a branch.

new_object_id class-attribute instance-attribute

new_object_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newObjectId'})

The object id the ref should point at. Only required when deleting or resetting a ref.

GitChange dataclass

GitChange(*, change_type: Optional[str] = None, item: Optional[Dict[str, Any]] = None, new_content: Optional[Dict[str, Any]] = None)

Definition: GitChange

Attributes

change_type class-attribute instance-attribute

change_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeType'})

The kind of change to apply.

item class-attribute instance-attribute

item: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The item the change applies to.

new_content class-attribute instance-attribute

new_content: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newContent'})

The new content of the item. Not required for delete changes.

GitCommitRequest dataclass

GitCommitRequest(*, comment: Optional[str] = None, changes: Optional[List[GitChange | Mapping[str, Any]]] = None)

Definition: GitCommitRequest

Attributes

comment class-attribute instance-attribute

comment: Optional[str] = dataclass_field(default=None, kw_only=True)

The commit message.

changes class-attribute instance-attribute

changes: Optional[List[GitChange | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The file changes contained in the commit.

GitPushRequest dataclass

GitPushRequest(ref_updates: List[GitRefUpdateRequest | Mapping[str, Any]], commits: List[GitCommitRequest | Mapping[str, Any]])

Definition: GitPushRequest

Attributes

ref_updates class-attribute instance-attribute

ref_updates: List[GitRefUpdateRequest | Mapping[str, Any]] = dataclass_field(metadata={'wire_name': 'refUpdates'})

The refs to update or create.

commits instance-attribute

commits: List[GitCommitRequest | Mapping[str, Any]]

The commits to push.

GitPullRequestWorkItemRef dataclass

GitPullRequestWorkItemRef(*, id: Optional[str] = None)

Definition: GitPullRequestWorkItemRef

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The identifier of the work item.

GitPullRequestReviewerRef dataclass

GitPullRequestReviewerRef(*, id: Optional[str] = None, is_required: Optional[bool] = None)

Definition: GitPullRequestReviewerRef

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The identity id of the reviewer.

is_required class-attribute instance-attribute

is_required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isRequired'})

Indicates whether the reviewer is required.

GitPullRequestCreate dataclass

GitPullRequestCreate(source_ref_name: str, target_ref_name: str, title: str, *, description: Optional[str] = None, is_draft: Optional[bool] = None, work_item_refs: Optional[List[GitPullRequestWorkItemRef | Mapping[str, Any]]] = None, reviewers: Optional[List[GitPullRequestReviewerRef | Mapping[str, Any]]] = None, labels: Optional[List[Dict[str, Any]]] = None)

Definition: GitPullRequestCreate

Attributes

source_ref_name class-attribute instance-attribute

source_ref_name: str = dataclass_field(metadata={'wire_name': 'sourceRefName'})

The branch the changes come from, for example refs/heads/my-branch.

target_ref_name class-attribute instance-attribute

target_ref_name: str = dataclass_field(metadata={'wire_name': 'targetRefName'})

The branch the changes are merged into, for example refs/heads/main.

title instance-attribute

title: str

The title of the pull request.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the pull request.

is_draft class-attribute instance-attribute

is_draft: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isDraft'})

Set to true to create the pull request as a draft.

work_item_refs class-attribute instance-attribute

work_item_refs: Optional[List[GitPullRequestWorkItemRef | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'workItemRefs'})

The work items to link to the pull request.

reviewers class-attribute instance-attribute

reviewers: Optional[List[GitPullRequestReviewerRef | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The reviewers to add to the pull request.

labels class-attribute instance-attribute

labels: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

The labels to apply to the pull request.

GitPullRequestUpdate dataclass

GitPullRequestUpdate(*, status: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, target_ref_name: Optional[str] = None, is_draft: Optional[bool] = None, auto_complete_set_by: Optional[Dict[str, Any]] = None, last_merge_source_commit: Optional[Dict[str, Any]] = None, completion_options: Optional[Dict[str, Any]] = None)

Definition: GitPullRequestUpdate

Attributes

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status to set on the pull request.

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

The new title of the pull request.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The new description of the pull request.

target_ref_name class-attribute instance-attribute

target_ref_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetRefName'})

The new target branch of the pull request.

is_draft class-attribute instance-attribute

is_draft: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isDraft'})

Set to false to publish a draft pull request.

auto_complete_set_by class-attribute instance-attribute

auto_complete_set_by: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'autoCompleteSetBy'})

The identity that enables auto-complete. Set the Id to the identity that should complete the pull request.

last_merge_source_commit class-attribute instance-attribute

last_merge_source_commit: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastMergeSourceCommit'})

The source commit to complete. Required when completing a pull request.

completion_options class-attribute instance-attribute

completion_options: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'completionOptions'})

How the pull request should be completed.

VisualstudioteamservicesClient

VisualstudioteamservicesClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for visualstudioteamservices connector.

Initialize a VisualstudioteamservicesClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

search_work_items async

search_work_items(input: WorkItemSearchRequest | Mapping[str, Any], account: str, project: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Search for work items

Provides a set of results for the search text.

Swagger operation ID: SearchWorkItemsAsync.

Parameters:

Name	Type	Description	Default
input	WorkItemSearchRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have \"Third-party application access via OAuth\" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_build async

get_build(project: str, build_id: int, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get build

Retrieves a build by its identifier.

Swagger operation ID: GetBuildAsync.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
build_id	int	The identifier of the build to retrieve.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_build_timeline

list_build_timeline(project: str, build_id: int, account: str, *, timeline_id: Optional[str] = None, change_id: Optional[int] = None, plan_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get build timeline

Retrieves the timeline for a specific build.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetBuildTimelineAsync.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
build_id	int	The identifier of the build to retrieve the timeline for.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeline_id	Optional[str]	Optional timeline identifier when multiple timelines exist.	None
change_id	Optional[int]	Optional change id to retrieve a specific timeline change.	None
plan_id	Optional[str]	Optional plan identifier for the timeline.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_accounts

list_accounts(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List Organizations

Retrieves the list of Organizations the user is a member of.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListAccounts.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_profile async

get_profile(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a User Profile

Gets a user profile.

Swagger operation ID: GetProfile.

Parameters:

Name	Type	Description	Default
id	str	The ID of the profile within the same organization, or 'me' to get the profile of the current authenticated user.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_iterations

list_iterations(project: str, account: str, team: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List iterations

Retrieves the list of iterations for a project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListIterations.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
team	str	The name of the team within the project.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_build_branches

list_build_branches(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List Git branches

Retrieves the list of Git branches available within the project's repositories.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBuildBranchesAsync.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_builds

list_builds(project: str, account: str, *, definitions: Optional[str] = None, build_number: Optional[str] = None, branch_name: Optional[str] = None, result_filter: Optional[str] = None, status_filter: Optional[str] = None, reason_filter: Optional[str] = None, requested_for: Optional[str] = None, min_time: Optional[str] = None, max_time: Optional[str] = None, top: Optional[int] = None, query_order: Optional[str] = None, tag_filters: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List builds

Retrieves builds for the specified project with optional filters.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBuilds.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
definitions	Optional[str]	Comma-separated list of definition identifiers to include.	None
build_number	Optional[str]	Filter by build number.	None
branch_name	Optional[str]	Filter by branch name (for example, refs/heads/main).	None
result_filter	Optional[str]	Filter by build result.	None
status_filter	Optional[str]	Filter by build status.	None
reason_filter	Optional[str]	Filter by build reason.	None
requested_for	Optional[str]	Filter by the identity for whom the build was requested.	None
min_time	Optional[str]	Filter by minimum finish time (inclusive).	None
max_time	Optional[str]	Filter by maximum finish time (inclusive).	None
top	Optional[int]	Maximum number of builds to return.	None
query_order	Optional[str]	The order in which the builds are returned.	None
tag_filters	Optional[str]	Comma-separated list of tags. Only builds carrying all of the tags are returned.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

queue_new_build async

queue_new_build(input: QueueBuildRequest | Mapping[str, Any], project: str, account: str, build_def_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Queue a new build

Create a build, based on an existing build definition, and add it to the build queue.

Swagger operation ID: QueueNewBuild.

Parameters:

Name	Type	Description	Default
input	QueueBuildRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
build_def_id	str	The identifier of the build definition to use.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_build_requesters

list_build_requesters(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List build requesters

Retrieves unique project members who can be used to filter builds by the requested for identity.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBuildRequestersAsync.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_git_repositories

list_git_repositories(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List Git repositories

Retrieves the list of Git repositories in a project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListGitRepositories.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_projects

list_projects(account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List projects

Retrieves the list of projects in an Organization.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListProjects.

Parameters:

Name	Type	Description	Default
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_release_definitions

list_release_definitions(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List release definitions

Retrieves the list of release definitions associated with a project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListReleaseDefinitions.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_release async

create_release(input: ReleaseStartMetadata | Mapping[str, Any], project: str, account: str, release_def_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a new release

Create a release, based on an existing release definition.

Swagger operation ID: CreateRelease.

Parameters:

Name	Type	Description	Default
input	ReleaseStartMetadata | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
release_def_id	str	The identifier of the release definition to use.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

http_request async

http_request(input: VstsHttpRequestBodyParameters | Mapping[str, Any], account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send an HTTP request to Azure DevOps

Construct an Azure DevOps REST API request to invoke. Please refer to the following link for all available endpoints: https://docs.microsoft.com/rest/api/azure/devops

Swagger operation ID: HttpRequest.

Parameters:

Name	Type	Description	Default
input	VstsHttpRequestBodyParameters | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_work_item_fields

list_work_item_fields(account: str, *, project: Optional[str] = None, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List work item fields

Retrieves the work item fields available within the specified Azure DevOps Organization or project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListWorkItemFieldsAsync.

Parameters:

Name	Type	Description	Default
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	Optional[str]	Optional project within the Organization to scope the fields list.	None
expand	Optional[str]	Controls which additional information is returned for each field.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_work_item_types

list_work_item_types(account: str, project: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List work item types

Retrieves the list of Work Item Types accessible in a given Azure DevOps project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListWorkItemTypes.

Parameters:

Name	Type	Description	Default
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_work_item_details async

get_work_item_details(id: str, account: str, project: str, type_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item details

Get the details of a single work item.

Swagger operation ID: GetWorkItemDetails.

Parameters:

Name	Type	Description	Default
id	str	The unique id of the work item to get details for.The work item must be of the type specified in 'Work Item Type'.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
type_name	str	The work item type of the work item.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_work_item async

update_work_item(input: UpdateWorkItemRequest | Mapping[str, Any], id: str, account: str, *, project: Optional[str] = None, type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a work item

Update an existing work item by id.

Swagger operation ID: UpdateWorkItem.

Parameters:

Name	Type	Description	Default
input	UpdateWorkItemRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
id	str	The unique id of the work item to update.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	Optional[str]	The name of the project within the specified Organization.	None
type_	Optional[str]	The work item type to generate schema for.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_work_item_details_v2 async

get_work_item_details_v2(id: str, account: str, project: str, type_name: str, *, as_of: Optional[str] = None, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item details (V2)

Get the details of a single work item with optional field selection and expand options.

Swagger operation ID: GetWorkItemDetailsV2Async.

Parameters:

Name	Type	Description	Default
id	str	The unique id of the work item to get details for.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
type_name	str	The work item type used to validate the returned work item and drive dynamic outputs.	required
as_of	Optional[str]	Retrieve the work item as of this date and time.	None
expand	Optional[str]	Controls which additional data is included in the response.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_work_item_children

list_work_item_children(id: str, account: str, project: str, *, work_item_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get work item children

Get a list of children (max size 1000) of a single work item.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetWorkItemChildren.

Parameters:

Name	Type	Description	Default
id	str	The unique id of the work item to get the children for.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
work_item_type	Optional[str]	The type of the children work item(s).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_work_item_attachment async

get_work_item_attachment(attachment_id: str, account: str, *, project: Optional[str] = None, file_name: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item attachment

Downloads the content of a work item attachment.

Swagger operation ID: GetWorkItemAttachmentAsync.

Parameters:

Name	Type	Description	Default
attachment_id	str	The unique id of the attachment to download.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	Optional[str]	Optional project within the specified Organization to scope the request.	None
file_name	Optional[str]	Optional file name hint passed to Azure DevOps when downloading the attachment.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_work_item_comments async

get_work_item_comments(work_item_id: int, account: str, project: str, *, top: Optional[int] = None, order: Optional[str] = None, include_deleted: Optional[bool] = None, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item comments

Retrieves comments for a work item.

Swagger operation ID: GetWorkItemCommentsAsync.

Parameters:

Name	Type	Description	Default
work_item_id	int	The unique id of the work item to get comments for.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
top	Optional[int]	Maximum number of comments to return.	None
order	Optional[str]	Sort order for comments. Defaults to 'desc'.	None
include_deleted	Optional[bool]	Whether to include comments that have been soft-deleted.	None
expand	Optional[str]	Controls which additional comment data should be returned.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_work_item_comment async

create_work_item_comment(input: CreateWorkItemCommentRequest | Mapping[str, Any], work_item_id: int, account: str, project: str, *, type_: Optional[str] = None, format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create work item comment

Adds a comment to a work item.

Swagger operation ID: CreateWorkItemCommentAsync.

Parameters:

Name	Type	Description	Default
input	CreateWorkItemCommentRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
work_item_id	int	Id of a work item.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	Project ID or project name.	required
type_	Optional[str]	The work item type to generate schema for.	None
format	Optional[str]	Format of a work item comment (Markdown or Html).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_work_item_link async

add_work_item_link(input: AddWorkItemLinkRequest | Mapping[str, Any], work_item_id: int, account: str, project: str, type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add work item link

Adds a link to a work item.

Swagger operation ID: AddWorkItemLinkAsync.

Parameters:

Name	Type	Description	Default
input	AddWorkItemLinkRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
work_item_id	int	Id of a work item.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	Project ID or project name.	required
type_	str	The work item type of the work item.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_work_item_link async

delete_work_item_link(input: DeleteWorkItemLinkRequest | Mapping[str, Any], work_item_id: int, account: str, project: str, type_: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete work item link

Deletes a link from a work item.

Swagger operation ID: DeleteWorkItemLinkAsync.

Parameters:

Name	Type	Description	Default
input	DeleteWorkItemLinkRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
work_item_id	int	Id of a work item.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	Project ID or project name.	required
type_	str	The work item type of the work item.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_work_item_comment async

update_work_item_comment(input: CreateWorkItemCommentRequest | Mapping[str, Any], work_item_id: int, comment_id: int, account: str, project: str, *, format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update work item comment

Updates a comment on a work item.

Swagger operation ID: UpdateWorkItemCommentAsync.

Parameters:

Name	Type	Description	Default
input	CreateWorkItemCommentRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
work_item_id	int	Id of a work item.	required
comment_id	int	Id of the comment to update.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	Project ID or project name.	required
format	Optional[str]	Format of a work item comment (Markdown or Html).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_work_item_comment async

delete_work_item_comment(work_item_id: int, comment_id: int, account: str, project: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete work item comment

Delete a comment on a work item.

Swagger operation ID: DeleteWorkItemCommentAsync.

Parameters:

Name	Type	Description	Default
work_item_id	int	The unique id of the work item.	required
comment_id	int	The id of the comment to delete.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_work_item async

create_work_item(input: CreateWorkItemRequest | Mapping[str, Any], project: str, type_: str, account: str, *, should_return_all_fields: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a work item

Create a new work item with the provided attributes.

Swagger operation ID: CreateWorkItem.

Parameters:

Name	Type	Description	Default
input	CreateWorkItemRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
project	str	The name of the project within the specified Organization.	required
type_	str	Type of this work item.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
should_return_all_fields	Optional[bool]	When setting the value to 'No', only the work item ID will be returned. If the value is 'Yes', all fields of the created Item along with the ID will be returned. The default value is 'Yes'.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_root_query_folders

list_root_query_folders(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List root level queries

Retrieves the list of root-level work item queries in a project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListRootQueryFolders.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_queries_in_folder

list_queries_in_folder(project: str, account: str, folder_path: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List queries within folder

Retrieves the list of work item queries within a folder for a given project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListQueriesInFolder.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
folder_path	str	The folder path under which to look for queries.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_work_items

list_work_items(project: str, account: str, work_item_ids: str, *, work_item_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List work items

Returns a list of work items.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListWorkItems.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
work_item_ids	str	The comma-separated list of requested work item IDs.	required
work_item_type	Optional[str]	The work item type to generate schema for.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_pipelines

list_pipelines(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List pipelines

Retrieves the list of pipelines in a project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListPipelines.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_pipeline_runs

list_pipeline_runs(project: str, pipeline_id: int, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List pipeline runs

Gets top 10000 runs for a particular pipeline

Returns a single-page Azure Core async collection.

Swagger operation ID: ListPipelineRuns.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
pipeline_id	int	The pipeline ID.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

run_pipeline async

run_pipeline(input: RunPipelineParameters | Mapping[str, Any], project: str, pipeline_id: int, account: str, *, pipeline_version: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Run a pipeline

Queues a new run of a YAML pipeline. Supports template parameters, runtime variables, the branch to run from and the stages to skip.

Swagger operation ID: RunPipeline.

Parameters:

Name	Type	Description	Default
input	RunPipelineParameters | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
project	str	The name of the project within the specified Organization.	required
pipeline_id	int	The pipeline ID.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
pipeline_version	Optional[int]	The pipeline version.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_pipeline_run async

get_pipeline_run(project: str, pipeline_id: int, run_id: int, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a pipeline run

Retrieves a single run of a pipeline, including its state, result and template parameters.

Swagger operation ID: GetPipelineRun.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
pipeline_id	int	The pipeline ID.	required
run_id	int	The identifier of the pipeline run.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_git_item async

get_git_item(project: str, repository_id: str, account: str, path: str, *, include_content: Optional[bool] = None, version_descriptor_version: Optional[str] = None, version_descriptor_version_type: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get file content

Retrieves a file (or folder metadata) from a Git repository. The file text is returned in the Content property.

Swagger operation ID: GetGitItem.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
repository_id	str	The name or identifier of the Git repository within the specified project.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
path	str	The repository-relative path of the item, for example /docs/readme.md.	required
include_content	Optional[bool]	Set to true to include the file content in the response.	None
version_descriptor_version	Optional[str]	The branch, tag or commit to read the item from. Defaults to the repository default branch.	None
version_descriptor_version_type	Optional[str]	The kind of version supplied in Version.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_git_refs_with_filter

list_git_refs_with_filter(project: str, repository_id: str, account: str, *, filter: Optional[str] = None, peel_tags: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List branches and tags

Retrieves the refs of a Git repository, optionally filtered by a ref name prefix such as heads/main.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListGitRefsWithFilter.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
repository_id	str	The name or identifier of the Git repository within the specified project.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
filter	Optional[str]	A ref name prefix without the leading refs/, for example heads/main or tags/.	None
peel_tags	Optional[bool]	Set to true to resolve annotated tags to the commit they point at.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_git_push async

create_git_push(input: GitPushRequest | Mapping[str, Any], project: str, repository_id: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a push

Pushes one or more commits to a Git repository. Use this to create a branch and commit file changes in a single call.

Swagger operation ID: CreateGitPush.

Parameters:

Name	Type	Description	Default
input	GitPushRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
project	str	The name of the project within the specified Organization.	required
repository_id	str	The name or identifier of the Git repository within the specified project.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_git_pull_request async

create_git_pull_request(input: GitPullRequestCreate | Mapping[str, Any], project: str, repository_id: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a pull request

Creates a pull request in a Git repository, optionally linking work items and adding reviewers.

Swagger operation ID: CreateGitPullRequest.

Parameters:

Name	Type	Description	Default
input	GitPullRequestCreate | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
project	str	The name of the project within the specified Organization.	required
repository_id	str	The name or identifier of the Git repository within the specified project.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_git_pull_request async

update_git_pull_request(input: GitPullRequestUpdate | Mapping[str, Any], project: str, repository_id: str, pull_request_id: int, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a pull request

Updates an existing pull request. Use this to set auto-complete, abandon or complete a pull request, or change its title, description or target branch.

Swagger operation ID: UpdateGitPullRequest.

Parameters:

Name	Type	Description	Default
input	GitPullRequestUpdate | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
project	str	The name of the project within the specified Organization.	required
repository_id	str	The name or identifier of the Git repository within the specified project.	required
pull_request_id	int	The identifier of the pull request.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_query_results

list_query_results(project: str, query_id: str, account: str, *, work_items_count: Optional[int] = None, throw_if_query_changed: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get query results

Retrieves the result of a work item query.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetQueryResultsV2.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
query_id	str	The Id of the stored query to run.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
work_items_count	Optional[int]	Max work items count to retrieve (1 - 20000).	None
throw_if_query_changed	Optional[bool]	If query results change during flow execution then flow run should fail to avoid inconsistencies.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_teams

list_teams(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List the teams in a project

Retrieves the list of teams in a project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListTeams.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_build_definitions

list_build_definitions(project: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List build definitions

Retrieves the list of build defintions in a project.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListBuildDefinitions.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_git_refs

list_git_refs(project: str, repository: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List Git refs

Retrieves the list of references (branches, tags, etc.) in a Git repo.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListGitRefs.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
repository	str	The name of the repository within the specified project.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_team_members

list_team_members(project: str, team: str, account: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List the users in a team

Retrieves the list of users in a specific team.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListTeamMembers.

Parameters:

Name	Type	Description	Default
project	str	The name of the project within the specified Organization.	required
team	str	The name of the team within the project.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_work_item_schema_for_update async

get_work_item_schema_for_update(account: str, project: str, type_name: str, *, only_required_fields: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item schema for update work item operation

Get work item schema for update work item operation.

Swagger operation ID: GetWorkItemSchemaForUpdate.

Parameters:

Name	Type	Description	Default
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
type_name	str	The work item type to generate schema for.	required
only_required_fields	Optional[bool]	Only required fields should be returned.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_work_item_schema async

get_work_item_schema(type_name: str, account: str, project: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item schema

Get the schema for a work item type.

Swagger operation ID: GetWorkItemSchema.

Parameters:

Name	Type	Description	Default
type_name	str	The work item type to generate schema for.	required
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_response_work_item_schema async

get_response_work_item_schema(*, account: Optional[str] = None, project: Optional[str] = None, type_name: Optional[str] = None, convert_reference_name: Optional[bool] = None, handle_predefined_schema: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item schema for the response of other operations

Get work item schema for the response of other operations.

Swagger operation ID: GetResponseWorkItemSchema.

Parameters:

Name	Type	Description	Default
account	Optional[str]	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	None
project	Optional[str]	The name of the project within the specified Organization.	None
type_name	Optional[str]	The work item type to generate schema for.	None
convert_reference_name	Optional[bool]	convertReferenceName.	None
handle_predefined_schema	Optional[bool]	handlePredefinedSchema.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_query_result_work_item_schema async

get_query_result_work_item_schema(*, account: Optional[str] = None, project: Optional[str] = None, query_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item schema for the response of Get query result operation

Get work item schema for the response of Get query result operation.

Swagger operation ID: GetQueryResultWorkItemSchema.

Parameters:

Name	Type	Description	Default
account	Optional[str]	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	None
project	Optional[str]	The name of the project within the specified Organization.	None
query_id	Optional[str]	queryId.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_work_item_schema_for_create async

get_work_item_schema_for_create(account: str, project: str, type_name: str, *, only_required_fields: Optional[bool] = None, only_dynamic_fields: Optional[bool] = None, mark_required_fields: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get work item schema for create work item operation

Get work item schema for create work item operation.

Swagger operation ID: GetWorkItemSchemaForCreate.

Parameters:

Name	Type	Description	Default
account	str	The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation.	required
project	str	The name of the project within the specified Organization.	required
type_name	str	The work item type to generate schema for.	required
only_required_fields	Optional[bool]	Only required fields should be returned.	None
only_dynamic_fields	Optional[bool]	Only dynamic fields should be returned.	None
mark_required_fields	Optional[bool]	Mark required fields in the schema.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.