Skip to content

Latest commit

 

History

History
1130 lines (778 loc) · 27.9 KB

examples.md

File metadata and controls

1130 lines (778 loc) · 27.9 KB

Examples

All these examples assume an already created AdoClient, perhaps similar to this:

from ado_wrapper import AdoClient

with open("credentials.txt", "r") as file:
    email, ado_access_token, ado_org_name, ado_project = file.read().split("\n")

ado_client = AdoClient(email, ado_access_token, ado_org_name, ado_project)

AdoUser

# Create
ado_user = AdoUser.create(ado_client, <member_name>, <member_email>)

# Delete
ado_user.delete(ado_client)

# Delete By Id
ado_user.delete_by_id(ado_client, <member_id>)

# Get All
ado_users = AdoUser.get_all(ado_client)

# Get By Descriptor Id
ado_user = AdoUser.get_by_descriptor_id(ado_client, <descriptor_id>)

# Get By Email
ado_user = AdoUser.get_by_email(ado_client, <member_email>)

# Get By Id
ado_user = AdoUser.get_by_id(ado_client, <descriptor_id>)

# Get By Name
ado_user = AdoUser.get_by_name(ado_client, <name>)

# Get By Origin Id
ado_user = AdoUser.get_by_origin_id(ado_client, <origin_id>)

# Search By Query
dictionary: dict[str, str] = AdoUser.search_by_query(ado_client, <query>)

AgentPool

# Create
agent_pool = AgentPool.create(ado_client, <name>, <agent_cloud_id>, <auto_provision>, <auto_size>, <auto_update>, <is_hosted>, <size>, <target_size>)

# Delete
agent_pool.delete(ado_client)

# Delete By Id
agent_pool.delete_by_id(ado_client, <agent_pool_id>)

# Get All
agent_pools = AgentPool.get_all(ado_client)

# Get By Id
agent_pool = AgentPool.get_by_id(ado_client, <agent_pool_id>)

# Get By Name
agent_pool = AgentPool.get_by_name(ado_client, <agent_pool_name>)

AnnotatedTag

# Create
annotated_tag = AnnotatedTag.create(ado_client, <repo_id>, <name>, <message>, <object_id>)

# Delete
annotated_tag.delete(ado_client)

# Delete By Id
annotated_tag.delete_by_id(ado_client, <object_id>, <repo_id>)

# Get All By Repo
annotated_tags = AnnotatedTag.get_all_by_repo(ado_client, <repo_id>)

# Get By Id
annotated_tag = AnnotatedTag.get_by_id(ado_client, <repo_id>, <object_id>)

# Get By Name
annotated_tag = AnnotatedTag.get_by_name(ado_client, <repo_id>, <tag_name>)

Artifact

# Create
build_artifact = Artifact.create(ado_client, <build_id>, <artifact_name>)

# Delete
artifact.delete(ado_client)

# Download Artifact
dictionary: dict[str, str] = Artifact.download_artifact(ado_client, <download_url>)

# Get All By Build Id
build_artifacts = Artifact.get_all_by_build_id(ado_client, <build_id>)

# Get By Name
build_artifact = Artifact.get_by_name(ado_client, <build_id>, <artifact_name>)

AuditLog

# Get All
audit_logs = AuditLog.get_all(ado_client, <start_time>, <end_time>)

# Get All By Area
audit_logs = AuditLog.get_all_by_area(ado_client, <area_type>, <start_time>, <end_time>)

# Get All By Category
audit_logs = AuditLog.get_all_by_category(ado_client, <category>, <start_time>, <end_time>)

# Get All By Scope Type
audit_logs = AuditLog.get_all_by_scope_type(ado_client, <scope_type>, <start_time>, <end_time>)

Branch

# Create
branch = Branch.create(ado_client, <repo_id>, <branch_name>, <default_branch_name>)

# Delete
branch.delete(ado_client)

# Delete By Id
branch.delete_by_id(ado_client, <branch_name>, <repo_id>)

# Delete By Name
branch.delete_by_name(ado_client, <branch_name>, <repo_id>)

# Get All By Repo
branchs = Branch.get_all_by_repo(ado_client, <repo_name_or_id>)

# Get By Id
branch = Branch.get_by_id(ado_client, <repo_id>, <branch_id>)

# Get By Name
branch = Branch.get_by_name(ado_client, <repo_name_or_id>, <branch_name>)

# Get Main Branch
branch = Branch.get_main_branch(ado_client, <repo_id>)

Build

# Allow On Environment
pipeline_authorisation = Build.allow_on_environment(ado_client, <definition_id>, <environment_id>)

# Approve Environment For Pipeline
build.approve_environment_for_pipeline(ado_client, <build_id>, <stage_name>)

# Create
build = Build.create(ado_client, <definition_id>, <source_branch>)

# Create And Wait Until Completion
build = Build.create_and_wait_until_completion(ado_client, <definition_id>, <branch_name>, <max_timeout_seconds>)

# Delete
build.delete(ado_client)

# Delete All Leases
build.delete_all_leases(ado_client, <build_id>)

# Delete By Id
build.delete_by_id(ado_client, <build_id>)

# Get All
builds = Build.get_all(ado_client, <limit>, <status>)

# Get All By Definition
builds = Build.get_all_by_definition(ado_client, <definition_id>)

# Get Build Log Content
string_var = Build.get_build_log_content(ado_client, <build_id>, <stage_name>, <job_name>, <task_name>, <remove_prefixed_timestamp>, <remove_colours>)

# Get By Id
build = Build.get_by_id(ado_client, <build_id>)

# Get Environment Approvals
dictionary: dict[str, str] = Build.get_environment_approvals(ado_client, <build_id>)

# Get Latest
build = Build.get_latest(ado_client, <definition_id>)

# Get Root Stage Names
strs = Build.get_root_stage_names(ado_client, <build_id>)

# Get Stages Jobs Tasks
dictionary = Build.get_stages_jobs_tasks(ado_client, <build_id>)

# Update
build.update(ado_client, <attribute_name>, <attribute_value>)

BuildDefinition

# Allow Variable Group
build_definition.allow_variable_group(ado_client, <variable_group_id>)

# Create
build_definition = BuildDefinition.create(ado_client, <name>, <repo_id>, <path_to_pipeline>, <description>, <agent_pool_id>, <branch_name>)

# Create With Hierarchy
hierarchy_created_build_definition = BuildDefinition.create_with_hierarchy(ado_client, <repo_id>, <repo_name>, <file_path>, <branch_name>, <agent_pool_id>)

# Delete
build_definition.delete(ado_client)

# Delete By Id
build_definition.delete_by_id(ado_client, <resource_id>)

# Get All
build_definitions = BuildDefinition.get_all(ado_client)

# Get All Builds By Definition
builds = BuildDefinition.get_all_builds_by_definition(ado_client)

# Get All By Repo Id
build_definitions = BuildDefinition.get_all_by_repo_id(ado_client, <repo_id>)

# Get All Stages
build_definition_stages = BuildDefinition.get_all_stages(ado_client, <definition_id>, <template_parameters>, <branch_name>)

# Get By Id
build_definition = BuildDefinition.get_by_id(ado_client, <build_definition_id>)

# Get By Name
build_definition = BuildDefinition.get_by_name(ado_client, <name>)

# Get Latest Build By Definition
build = BuildDefinition.get_latest_build_by_definition(ado_client)

# Update
build_definition.update(ado_client, <attribute_name>, <attribute_value>)

BuildTimeline

# Delete
build_timeline.delete(ado_client)

# Delete By Id
build_timeline.delete_by_id(ado_client, <build_id>)

# Get All By Type
build_timeline = BuildTimeline.get_all_by_type(ado_client, <build_id>, <item_type>, <fetch_retries>)

# Get All By Types
dictionary = BuildTimeline.get_all_by_types(ado_client, <build_id>, <item_types>, <fetch_retries>)

# Get Build Timeline
build_timeline = BuildTimeline.get_build_timeline(ado_client, <build_id>, <fetch_retries>)

# Get Build Timeline By Id
build_timeline = BuildTimeline.get_build_timeline_by_id(ado_client, <build_id>, <timeline_id>)

# Get By Build Id
build_timeline = BuildTimeline.get_by_build_id(ado_client, <build_id>, <fetch_retries>)

# Get By Id
build_timeline = BuildTimeline.get_by_id(ado_client, <build_id>, <timeline_id>)

# Get Tasks By Name
build_timeline_generic_items = BuildTimeline.get_tasks_by_name(ado_client, <build_id>, <task_name>)

CodeSearch

# Get By Search String
code_searchs = CodeSearch.get_by_search_string(ado_client, <search_text>, <result_count>, <sort_direction>)

Commit

# Add Git Ignore Template
commit = Commit.add_git_ignore_template(ado_client, <repo_id>, <git_ignore_template>)

# Add Initial Readme
commit = Commit.add_initial_readme(ado_client, <repo_id>)

# Add Readme And Gitignore
commit = Commit.add_readme_and_gitignore(ado_client, <repo_id>, <git_ignore_template>)

# Create
commit = Commit.create(ado_client, <repo_id>, <from_branch_name>, <to_branch_name>, <updates>, <change_type>, <commit_message>)

# Delete
commit.delete(ado_client)

# Delete By Id
commit.delete_by_id(ado_client, <commit_id>)

# Get All By Repo
commits = Commit.get_all_by_repo(ado_client, <repo_id>, <branch_name>)

# Get By Id
commit = Commit.get_by_id(ado_client, <repo_id>, <commit_id>)

# Get Latest By Repo
commit = Commit.get_latest_by_repo(ado_client, <repo_id>, <branch_name>)

Environment

# Add Pipeline Permission
pipeline_authorisation = Environment.add_pipeline_permission(ado_client, <pipeline_id>)

# Create
environment = Environment.create(ado_client, <name>, <description>)

# Delete
environment.delete(ado_client)

# Delete By Id
environment.delete_by_id(ado_client, <environment_id>)

# Get All
environments = Environment.get_all(ado_client)

# Get By Id
environment = Environment.get_by_id(ado_client, <environment_id>)

# Get By Name
environment = Environment.get_by_name(ado_client, <name>)

# Get Pipeline Permissions
pipeline_authorisations = Environment.get_pipeline_permissions(ado_client)

# Remove Pipeline Permissions
environment.remove_pipeline_permissions(ado_client, <pipeline_id>)

# Update
environment.update(ado_client, <attribute_name>, <attribute_value>)

Group

# Create
group = Group.create(ado_client, <name>, <description>)

# Delete
group.delete(ado_client)

# Delete By Id
group.delete_by_id(ado_client, <group_descriptor>)

# Get All
groups = Group.get_all(ado_client)

# Get By Id
group = Group.get_by_id(ado_client, <group_descriptor>)

# Get By Name
group = Group.get_by_name(ado_client, <group_name>)

HierarchyCreatedBuildDefinition

# Create
hierarchy_created_build_definition = HierarchyCreatedBuildDefinition.create(ado_client, <repo_id>, <repo_name>, <file_path>, <branch_name>, <agent_pool_id>)

# Delete
hierarchy_created_build_definition.delete(ado_client)

# Delete By Id
hierarchy_created_build_definition.delete_by_id(ado_client, <build_defintion_id>)

# Get By Id
hierarchy_created_build_definition = HierarchyCreatedBuildDefinition.get_by_id(ado_client, <build_definition_id>)

Member

# Create
member = Member.create(ado_client, <member_name>, <member_email>)

# Delete
member.delete(ado_client)

# Delete By Id
member.delete_by_id(ado_client, <member_id>)

# Get By Id
member = Member.get_by_id(ado_client, <member_id>)

MergeBranchPolicy

# Delete
merge_branch_policy.delete(ado_client)

# Get Branch Policy
merge_branch_policy = MergeBranchPolicy.get_branch_policy(ado_client, <repo_id>, <branch_name>)

# Set Branch Policy
merge_branch_policy.set_branch_policy(ado_client, <repo_id>, <minimum_approver_count>, <creator_vote_counts>, <prohibit_last_pushers_vote>, <allow_completion_with_rejects>, <when_new_changes_are_pushed>, <branch_name>)

MergePolicies

# Add Default Reviewer
merge_policies.add_default_reviewer(ado_client, <repo_id>, <reviewer_origin_id>, <is_required>, <branch_name>)

# Delete
merge_policies.delete(ado_client)

# Get All By Repo Id
merge_policy_default_reviewers = MergePolicies.get_all_by_repo_id(ado_client, <repo_id>, <branch_name>)

# Get All Repo Policies
reviewers, merge_branch_policy, merge_type_restriction_policy = MergePolicies.get_all_repo_policies(ado_client, <repo_id>, <branch_name>)

# Get Allowed Merge Types
merge_type_restriction_policy = MergePolicies.get_allowed_merge_types(ado_client, <repo_id>, <branch_name>)

# Get Branch Policy
merge_branch_policy = MergePolicies.get_branch_policy(ado_client, <repo_id>, <branch_name>)

# Get Default Reviewer Policy By Repo Id
merge_policy_default_reviewers = MergePolicies.get_default_reviewer_policy_by_repo_id(ado_client, <repo_id>, <branch_name>)

# Get Default Reviewers
reviewers = MergePolicies.get_default_reviewers(ado_client, <repo_id>, <branch_name>)

# Remove Default Reviewer
merge_policies.remove_default_reviewer(ado_client, <repo_id>, <reviewer_id>, <branch_name>)

# Set Allowed Merge Types
merge_policies.set_allowed_merge_types(ado_client, <repo_id>, <allow_basic_no_fast_forwards>, <allow_squash>, <allow_rebase_and_fast_forward>, <allow_rebase_with_merge_commit>, <branch_name>)

# Set Branch Policy
merge_policies.set_branch_policy(ado_client, <repo_id>, <minimum_approver_count>, <creator_vote_counts>, <prohibit_last_pushers_vote>, <allow_completion_with_rejects>, <when_new_changes_are_pushed>, <branch_name>)

MergePolicyDefaultReviewer

# Add Default Reviewer
merge_policy_default_reviewer.add_default_reviewer(ado_client, <repo_id>, <reviewer_origin_id>, <is_required>, <branch_name>)

# Delete
merge_policy_default_reviewer.delete(ado_client)

# Get Default Reviewers
reviewers = MergePolicyDefaultReviewer.get_default_reviewers(ado_client, <repo_id>, <branch_name>)

# Remove Default Reviewer
merge_policy_default_reviewer.remove_default_reviewer(ado_client, <repo_id>, <reviewer_id>, <branch_name>)

MergeTypeRestrictionPolicy

# Delete
merge_type_restriction_policy.delete(ado_client)

# Get Allowed Merge Types
merge_type_restriction_policy = MergeTypeRestrictionPolicy.get_allowed_merge_types(ado_client, <repo_id>, <branch_name>)

# Set Allowed Merge Types
merge_type_restriction_policy.set_allowed_merge_types(ado_client, <repo_id>, <allow_basic_no_fast_forwards>, <allow_squash>, <allow_rebase_and_fast_forward>, <allow_rebase_with_merge_commit>, <branch_name>)

Organisation

# Delete
organisation.delete(ado_client)

# Get All
organisations = Organisation.get_all(ado_client)

# Get By Id
organisation = Organisation.get_by_id(ado_client, <organisation_id>)

# Get By Name
organisation = Organisation.get_by_name(ado_client, <organisation_name>)

# Get Organisation Board Process Settings
dictionary: dict[str, int] = Organisation.get_organisation_board_process_settings(ado_client)

# Get Organisation Overview Settings
dictionary = Organisation.get_organisation_overview_settings(ado_client)

# Get Organisation Pipeline Settings
dictionary: dict[str, bool] = Organisation.get_organisation_pipeline_settings(ado_client)

# Get Organisation Repository Advanced Settings
dictionary: dict[str, bool] = Organisation.get_organisation_repository_advanced_settings(ado_client)

# Get Organisation Repository Settings
organisation_repository_settingss = Organisation.get_organisation_repository_settings(ado_client)

# Get Organisation Security Policy Settings
dictionary = Organisation.get_organisation_security_policy_settings(ado_client)

Permission

# Get Project Perms
permissions = Permission.get_project_perms(ado_client)

# Get Project Perms By Group
permissions = Permission.get_project_perms_by_group(ado_client, <group>)

# Print Perms
permission.print_perms(ado_client)

PersonalAccessToken

# Create Personal Access Token
personal_access_token.create_personal_access_token(ado_client, <display_name>)

# Get Access Token By Name
personal_access_token = PersonalAccessToken.get_access_token_by_name(ado_client, <display_name>, <org_id>)

# Get Access Tokens
personal_access_tokens = PersonalAccessToken.get_access_tokens(ado_client, <org_id>, <include_different_orgs>, <include_expired_tokens>)

PipelineAuthorisation

# Create
pipeline_authorisation = PipelineAuthorisation.create(ado_client, <environment_id>, <pipeline_id>, <authorized>)

# Delete By Id
pipeline_authorisation.delete_by_id(ado_client, <environment_id>, <pipeline_authorisation_id>)

# Get All For Environment
pipeline_authorisations = PipelineAuthorisation.get_all_for_environment(ado_client, <environment_id>)

# Update
pipeline_authorisation.update(ado_client, <authorized>)

Project

# Create
project = Project.create(ado_client, <name>, <project_description>, <template_type>)

# Delete
project.delete(ado_client)

# Delete By Id
project.delete_by_id(ado_client, <project_id>)

# Get All
projects = Project.get_all(ado_client)

# Get Artifact Storage Settings
dictionary: dict[str, int = Project.get_artifact_storage_settings(ado_client)

# Get Build Queue Settings
dictionary: dict[str, Any] = Project.get_build_queue_settings(ado_client)

# Get By Id
project = Project.get_by_id(ado_client, <project_id>)

# Get By Name
project = Project.get_by_name(ado_client, <project_name>)

# Get Overview Settings
dictionary: dict[str, Any] = Project.get_overview_settings(ado_client)

# Get Pipeline Settings
dictionary: dict[str, bool] = Project.get_pipeline_settings(ado_client, <project_name>)

# Get Repository Policy Settings
project_repository_policy_settingss = Project.get_repository_policy_settings(ado_client)

# Get Repository Settings
dictionary = Project.get_repository_settings(ado_client, <project_name>)

# Get Retention Policy Settings
dictionary: dict[str, Any] = Project.get_retention_policy_settings(ado_client)

# Get Test Retention Settings
dictionary: dict[str, int] = Project.get_test_retention_settings(ado_client)

# Set Test Retention Settings
project.set_test_retention_settings(ado_client, <automated_result_retention_in_days>, <manual_result_retention_in_days>)

PullRequest

# Add Reviewer
pull_request.add_reviewer(ado_client, <reviewer_id>)

# Add Reviewer Static
pull_request.add_reviewer_static(ado_client, <repo_id>, <pull_request_id>, <reviewer_id>)

# Close
pull_request.close(ado_client)

# Create
pull_request = PullRequest.create(ado_client, <repo_id>, <pull_request_title>, <pull_request_description>, <from_branch_name>, <to_branch_name>, <is_draft>)

# Delete
pull_request.delete(ado_client)

# Delete By Id
pull_request.delete_by_id(ado_client, <pull_request_id>)

# Get All
pull_requests = PullRequest.get_all(ado_client, <status>, <start>, <end>, <limit>)

# Get All By Author
pull_requests = PullRequest.get_all_by_author(ado_client, <author_email>, <status>)

# Get All By Repo Id
pull_requests = PullRequest.get_all_by_repo_id(ado_client, <repo_id>, <status>)

# Get By Id
pull_request = PullRequest.get_by_id(ado_client, <pull_request_id>)

# Get Comment Threads
pull_request_comment_threads = PullRequest.get_comment_threads(ado_client, <ignore_system_messages>)

# Get Comments
pull_request_comments = PullRequest.get_comments(ado_client, <ignore_system_messages>)

# Get My Pull Requests
pull_requests = PullRequest.get_my_pull_requests(ado_client)

# Get Reviewers
members = PullRequest.get_reviewers(ado_client)

# Mark As Draft
pull_request.mark_as_draft(ado_client)

# Post Comment
pull_request_comment = PullRequest.post_comment(ado_client, <content>)

# Set My Pull Requests Included Teams
pull_request.set_my_pull_requests_included_teams(ado_client, <status>, <draft_state>, <created_by>, <assigned_to>, <target_branch>, <created_in_last_x_days>, <updated_in_last_x_days>, <completed_in_last_x_days>)

# Unmark As Draft
pull_request.unmark_as_draft(ado_client)

# Update
pull_request.update(ado_client, <attribute_name>, <attribute_value>)

Release

# Create
release = Release.create(ado_client, <definition_id>, <description>)

# Delete
release.delete(ado_client)

# Delete By Id
release.delete_by_id(ado_client, <release_id>)

# Get All
releases = Release.get_all(ado_client, <definition_id>)

# Get By Id
release = Release.get_by_id(ado_client, <release_id>)

ReleaseDefinition

# Agent Pool Id
release = ReleaseDefinition.agent_pool_id(ado_client, <release_id>)

# Create
release_definition = ReleaseDefinition.create(ado_client, <name>, <variable_group_ids>, <agent_pool_id>)

# Delete
release_definition.delete(ado_client)

# Delete By Id
release_definition.delete_by_id(ado_client, <release_definition_id>)

# Get All
release_definitions = ReleaseDefinition.get_all(ado_client)

# Get All Releases For Definition
releases = ReleaseDefinition.get_all_releases_for_definition(ado_client, <definition_id>)

# Get By Id
release_definition = ReleaseDefinition.get_by_id(ado_client, <release_definition_id>)

# Update
release_definition.update(ado_client, <attribute_name>, <attribute_value>)

Repo

# Create
repo = Repo.create(ado_client, <name>, <include_readme>, <git_ignore_template>)

# Create Pull Request
pull_request = Repo.create_pull_request(ado_client, <branch_name>, <pull_request_title>, <pull_request_description>, <to_branch_name>, <is_draft>)

# Delete
repo.delete(ado_client)

# Delete By Id
repo.delete_by_id(ado_client, <repo_id>)

# Get All
repos = Repo.get_all(ado_client)

# Get All Pull Requests
pull_requests = Repo.get_all_pull_requests(ado_client, <repo_id>, <status>)

# Get All Repos With Required Reviewer
repos = Repo.get_all_repos_with_required_reviewer(ado_client, <reviewer_email>)

# Get And Decode File
dictionary: dict[str, Any] = Repo.get_and_decode_file(ado_client, <file_path>, <branch_name>)

# Get Branch Merge Policy
merge_branch_policy = Repo.get_branch_merge_policy(ado_client, <repo_id>, <branch_name>)

# Get By Id
repo = Repo.get_by_id(ado_client, <repo_id>)

# Get By Name
repo = Repo.get_by_name(ado_client, <repo_name>)

# Get Content Static
dictionary: dict[str, str] = Repo.get_content_static(ado_client, <repo_id>, <file_types>, <branch_name>)

# Get Contents
dictionary: dict[str, str] = Repo.get_contents(ado_client, <file_types>, <branch_name>)

# Get File
string_var = Repo.get_file(ado_client, <file_path>, <branch_name>)

# Set Branch Merge Policy
merge_policies = Repo.set_branch_merge_policy(ado_client, <repo_id>, <minimum_approver_count>, <creator_vote_counts>, <prohibit_last_pushers_vote>, <allow_completion_with_rejects>, <when_new_changes_are_pushed>, <branch_name>)

# Set Default Branch
repo.set_default_branch(ado_client, <new_default_branch_name>)

# Update
repo.update(ado_client, <attribute_name>, <attribute_value>)

RepoUserPermissions

# Delete
repo_user_permissions.delete(ado_client)

# Display Output
string_var = RepoUserPermissions.display_output(<permissions>)

# Display Output For Repo
string_var = RepoUserPermissions.display_output_for_repo(<mapping>)

# Get All By Repo Id
dictionary: user_permission] = RepoUserPermissions.get_all_by_repo_id(ado_client, <repo_id>, <users_only>, <ignore_inherits>, <remove_not_set>)

# Get By Subject Descriptor
user_permissions = RepoUserPermissions.get_by_subject_descriptor(ado_client, <repo_id>, <subject_descriptor>)

# Get By User Email
user_permissions = RepoUserPermissions.get_by_user_email(ado_client, <repo_id>, <subject_email>)

# Remove Perm
repo_user_permissions.remove_perm(ado_client, <repo_id>, <subject_email>, <domain_container_id>)

# Set All Permissions For Repo
repo_user_permissions.set_all_permissions_for_repo(ado_client, <repo_id>, <mapping>)

# Set By Group Descriptor
repo_user_permissions.set_by_group_descriptor(ado_client, <repo_id>, <group_descriptor>, <action>, <permission>)

# Set By User Email
repo_user_permissions.set_by_user_email(ado_client, <repo_id>, <email>, <action>, <permission>, <domain_container_id>)

# Set By User Email Batch
repo_user_permissions.set_by_user_email_batch(ado_client, <repo_id>, <subject_email>, <mapping>, <domain_container_id>)

Reviewer

# Create
member = Reviewer.create(ado_client, <member_name>, <member_email>)

# Delete
reviewer.delete(ado_client)

# Delete By Id
reviewer.delete_by_id(ado_client, <member_id>)

# Get By Id
member = Reviewer.get_by_id(ado_client, <member_id>)

Run

# Create
run = Run.create(ado_client, <definition_id>, <template_parameters>, <run_variables>, <branch_name>, <stages_to_run>)

# Delete
run.delete(ado_client)

# Delete By Id
run.delete_by_id(ado_client, <run_id>)

# Get All By Definition
runs = Run.get_all_by_definition(ado_client, <pipeline_id>)

# Get By Id
run = Run.get_by_id(ado_client, <build_definition_id>, <run_id>)

# Get Latest
run = Run.get_latest(ado_client, <definition_id>)

# Get Root Stage Names
strs = Run.get_root_stage_names(ado_client, <build_id>)

# Get Run Log Content
string_var = Run.get_run_log_content(ado_client, <build_id>, <stage_name>, <job_name>, <task_name>, <remove_prefixed_timestamp>, <remove_colours>)

# Get Run Stage Results
run_stage_results = Run.get_run_stage_results(ado_client, <build_id>)

# Get Stages Jobs Tasks
dictionary = Run.get_stages_jobs_tasks(ado_client, <build_id>)

# Run All And Capture Results Sequentially
runs = Run.run_all_and_capture_results_sequentially(ado_client, <data>, <max_timeout_seconds>, <send_updates_function>)

# Run All And Capture Results Simultaneously
runs = Run.run_all_and_capture_results_simultaneously(ado_client, <data>, <max_timeout_seconds>, <send_updates_function>)

# Run And Wait Until Completion
run = Run.run_and_wait_until_completion(ado_client, <definition_id>, <template_parameters>, <run_variables>, <branch_name>, <stages_to_run>, <max_timeout_seconds>, <send_updates_function>)

# Update
run.update(ado_client, <attribute_name>, <attribute_value>)

ServiceEndpoint

# Create
service_endpoint = ServiceEndpoint.create(ado_client, <name>, <service_endpoint_type>, <url>, <username>, <password>, <access_token>)

# Delete
service_endpoint.delete(ado_client)

# Delete By Id
service_endpoint.delete_by_id(ado_client, <service_endpoint_id>)

# Get All
service_endpoints = ServiceEndpoint.get_all(ado_client)

# Get By Id
service_endpoint = ServiceEndpoint.get_by_id(ado_client, <repo_id>)

# Get By Name
service_endpoint = ServiceEndpoint.get_by_name(ado_client, <name>)

# Update
service_endpoint.update(ado_client, <attribute_name>, <attribute_value>)

# Update Pipeline Perms
dictionary: dict[str, Any] = ServiceEndpoint.update_pipeline_perms(ado_client, <pipeline_id>)

Team

# Create
team = Team.create(ado_client, <name>, <description>)

# Delete
team.delete(ado_client)

# Delete By Id
team.delete_by_id(ado_client, <team_id>)

# Get All
teams = Team.get_all(ado_client)

# Get By Id
team = Team.get_by_id(ado_client, <team_id>)

# Get By Name
team = Team.get_by_name(ado_client, <team_name>)

# Get Members
team_members = Team.get_members(ado_client)

TeamMember

# Create
member = TeamMember.create(ado_client, <member_name>, <member_email>)

# Delete
team_member.delete(ado_client)

# Delete By Id
team_member.delete_by_id(ado_client, <member_id>)

# Get By Id
member = TeamMember.get_by_id(ado_client, <member_id>)

UserPermission

# Get By Subject Descriptor
user_permissions = UserPermission.get_by_subject_descriptor(ado_client, <subject_descriptor>, <repo_id>)

# Remove Perm
user_permission.remove_perm(ado_client, <repo_id>, <subject_email>, <domain_container_id>)

# Set By Group Descriptor
user_permission.set_by_group_descriptor(ado_client, <repo_id>, <group_descriptor>, <action>, <permission>)

# Set By User Email
user_permission.set_by_user_email(ado_client, <repo_id>, <email>, <action>, <permission>, <domain_container_id>)

VariableGroup

# Create
variable_group = VariableGroup.create(ado_client, <name>, <variables>, <variable_group_description>)

# Delete
variable_group.delete(ado_client)

# Delete By Id
variable_group.delete_by_id(ado_client, <variable_group_id>)

# Get All
variable_groups = VariableGroup.get_all(ado_client)

# Get By Id
variable_group = VariableGroup.get_by_id(ado_client, <variable_group_id>)

# Get By Name
variable_group = VariableGroup.get_by_name(ado_client, <name>)

# Get Variable Group Contents
dictionary: dict[str, Any] = VariableGroup.get_variable_group_contents(ado_client, <variable_group_name>)

# Update
variable_group.update(ado_client, <attribute_name>, <attribute_value>)