GitHubClient Class

Definition

Typed client for github connector.

public class GitHubClient : Azure.Connectors.Sdk.ConnectorClientBase
type GitHubClient = class
    inherit ConnectorClientBase
Public Class GitHubClient
Inherits ConnectorClientBase
Inheritance

Constructors

Name Description
GitHubClient()
GitHubClient(String)

Creates a new GitHubClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.

GitHubClient(Uri, TokenCredential, ConnectorClientOptions)

Creates a new GitHubClient with the specified connection runtime URL and credential.

GitHubClient(Uri, TokenCredential)

Creates a new GitHubClient with the specified connection runtime URL and credential.

GitHubClient(Uri)

Creates a new GitHubClient with the specified connection runtime URL. Uses ManagedIdentityCredential by default.

Properties

Name Description
ConnectorName
Pipeline

Gets the HTTP pipeline for making connector requests.

(Inherited from ConnectorClientBase)

Methods

Name Description
AddSelectedRepoToOrgSecretAsync(String, Int32, String, CancellationToken)

Add selected repository to an organization secret

CallConnectorAsync(HttpMethod, String, Object, CancellationToken)

Sends a connector API request with no response body. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics.

(Inherited from ConnectorClientBase)
CallConnectorAsync<TResponse>(HttpMethod, String, Object, CancellationToken)

Sends a connector API request and deserializes the JSON response. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics.

(Inherited from ConnectorClientBase)
CheckCollaboratorAsync(String, String, String, CancellationToken)

Check if a user is a repository collaborator

CompareRepositoryCommitsAsync(String, String, String, String, CancellationToken)

Compare two commits

CreateIssueAsync(String, String, IssueBasicDetailsModel, CancellationToken)

Create an issue

CreatePullRequestAsync(String, String, PullRequestCreateRequest, CancellationToken)

Create a pull request

CreateReferenceAsync(String, String, CreateReferenceRequest, CancellationToken)

Create a reference

CreateRepositoryDispatchEventAsync(String, String, RepositoryDispatchEvent, CancellationToken)

Create a repository dispatch event

CreateRepositoryUsingTemplateAsync(String, String, CreateRepositoryUsingTemplateRequest, CancellationToken)

Create a repository using a template

CreateUpdateRepositorySecretAsync(String, String, String, CreateRepositorySecretRequest, CancellationToken)

Create or update a repository secret

DeleteWebhookTriggerAsync(String, String, String, CancellationToken)

Deletes a GitHub Webhook

Dispose() (Inherited from ConnectorClientBase)
Dispose(Boolean)

Disposes the connector client resources.

(Inherited from ConnectorClientBase)
GetAssigneesAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists the available assignees for issues in a repository

GetIssueLabelsAsync(String, String, Int32, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all labels for an issue

GetIssueNumAsync(String, String, Int32, CancellationToken)

Get a particular issue of a repository

GetIssuesAsync(String, String, String, String, String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get all issues of a repository

GetLabelsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all labels for a repository

GetMilestonesAsync(String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all milestones of a repository

GetOrgReposAsync(String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all public repositories for an organization

GetPullRequestAsync(String, String, Int32, CancellationToken)

Get a pull request

GetPullRequestFilesAsync(String, String, Int32, CancellationToken)

Get the list of files from a pull request

GetPullRequestsAsync(String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Get all Pull Requests of A Repository

GetReferenceAsync(String, String, String, CancellationToken)

Get a reference

GetReposAsync(String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all public repositories for a user

GetRepositoryByIdAsync(Int32, CancellationToken)

Get a repository by Id

GetRepositoryPublicKeyAsync(String, String, CancellationToken)

Get a repository public key

GetUserAsync(CancellationToken)

Get the authenticated user

GetUserReposAsync(String, String, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all repositories for the authenticated user

InvokeMCPServerAsync(QueryRequest, CancellationToken)

Github MCP Server

ListCollaboratorsAsync(String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

List repository collaborators

MergePullRequestAsync(String, String, Int32, PullRequestMergeRequest, CancellationToken)

Merge a pull request

RemoveReviewersPullRequestAsync(String, String, Int32, RequestReviewersBody, CancellationToken)

Remove requested reviewers from a pull request

RemoveSelectedRepoFromOrgSecretAsync(String, Int32, String, CancellationToken)

Remove selected repository from an organization secret

RequestReviewersPullRequestAsync(String, String, Int32, RequestReviewersBody, CancellationToken)

Request reviewers for a pull request

ResolveUrl(String)

Resolves a relative path or validates an absolute URL against the connection runtime URL. When the NextLink host matches the connection URL, it's used as-is. When it doesn't match (codeless connectors like ARM return nextLink pointing to the backend host e.g. management.azure.com), the path+query is extracted and routed through the APIM proxy. This is safe because the request still goes through the connection runtime URL with API Hub auth.

(Inherited from ConnectorClientBase)
SearchGithubWithQueryAsync(GraphQlQuery, CancellationToken)

Search Github using Query

SearchIssuesAsync(String, String, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Find issues by state and keyword

UpdateIssueNumAsync(String, String, Int32, IssueUpdateModel, CancellationToken)

Update an Issue

UpdateMilestoneAsync(String, String, Int32, MilestoneUpdateModel, CancellationToken)

Update a milestone

UpdatePullRequestAsync(String, String, Int32, PullRequestUpdateRequest, CancellationToken)

Update a pull request

Applies to