GitHubConnectorOperations interface

Package:

@azure/arm-securitydevops

Interface representing a GitHubConnectorOperations.

Methods

beginCreateOrUpdate(string, string, GitHubConnector, GitHubConnectorCreateOrUpdateOptionalParams)	Create or update a monitored GitHub Connector resource.
beginCreateOrUpdateAndWait(string, string, GitHubConnector, GitHubConnectorCreateOrUpdateOptionalParams)	Create or update a monitored GitHub Connector resource.
beginDelete(string, string, GitHubConnectorDeleteOptionalParams)	Delete monitored GitHub Connector details.
beginDeleteAndWait(string, string, GitHubConnectorDeleteOptionalParams)	Delete monitored GitHub Connector details.
beginUpdate(string, string, GitHubConnectorUpdateOptionalParams)	Update monitored GitHub Connector details.
beginUpdateAndWait(string, string, GitHubConnectorUpdateOptionalParams)	Update monitored GitHub Connector details.
get(string, string, GitHubConnectorGetOptionalParams)	Returns a monitored GitHub Connector resource for a given ID.
listByResourceGroup(string, GitHubConnectorListByResourceGroupOptionalParams)
listBySubscription(GitHubConnectorListBySubscriptionOptionalParams)	Returns a list of monitored GitHub Connectors.

Method Details

beginCreateOrUpdate(string, string, GitHubConnector, GitHubConnectorCreateOrUpdateOptionalParams)

Create or update a monitored GitHub Connector resource.

function beginCreateOrUpdate(resourceGroupName: string, gitHubConnectorName: string, gitHubConnector: GitHubConnector, options?: GitHubConnectorCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<GitHubConnector>, GitHubConnector>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

gitHubConnectorName

string

Name of the GitHub Connector.

gitHubConnector

GitHubConnector

Connector resource payload.

options

GitHubConnectorCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<GitHubConnector>, GitHubConnector>>

beginCreateOrUpdateAndWait(string, string, GitHubConnector, GitHubConnectorCreateOrUpdateOptionalParams)

Create or update a monitored GitHub Connector resource.

function beginCreateOrUpdateAndWait(resourceGroupName: string, gitHubConnectorName: string, gitHubConnector: GitHubConnector, options?: GitHubConnectorCreateOrUpdateOptionalParams): Promise<GitHubConnector>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

gitHubConnectorName

string

Name of the GitHub Connector.

gitHubConnector

GitHubConnector

Connector resource payload.

options

GitHubConnectorCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GitHubConnector>

beginDelete(string, string, GitHubConnectorDeleteOptionalParams)

Delete monitored GitHub Connector details.

function beginDelete(resourceGroupName: string, gitHubConnectorName: string, options?: GitHubConnectorDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

gitHubConnectorName

string

Name of the GitHub Connector.

options

GitHubConnectorDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, GitHubConnectorDeleteOptionalParams)

Delete monitored GitHub Connector details.

function beginDeleteAndWait(resourceGroupName: string, gitHubConnectorName: string, options?: GitHubConnectorDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

gitHubConnectorName

string

Name of the GitHub Connector.

options

GitHubConnectorDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, GitHubConnectorUpdateOptionalParams)

Update monitored GitHub Connector details.

function beginUpdate(resourceGroupName: string, gitHubConnectorName: string, options?: GitHubConnectorUpdateOptionalParams): Promise<PollerLike<PollOperationState<GitHubConnector>, GitHubConnector>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

gitHubConnectorName

string

Name of the GitHub Connector.

options

GitHubConnectorUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<GitHubConnector>, GitHubConnector>>

beginUpdateAndWait(string, string, GitHubConnectorUpdateOptionalParams)

Update monitored GitHub Connector details.

function beginUpdateAndWait(resourceGroupName: string, gitHubConnectorName: string, options?: GitHubConnectorUpdateOptionalParams): Promise<GitHubConnector>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

gitHubConnectorName

string

Name of the GitHub Connector.

options

GitHubConnectorUpdateOptionalParams

The options parameters.

Returns

Promise<GitHubConnector>

get(string, string, GitHubConnectorGetOptionalParams)

Returns a monitored GitHub Connector resource for a given ID.

function get(resourceGroupName: string, gitHubConnectorName: string, options?: GitHubConnectorGetOptionalParams): Promise<GitHubConnector>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

gitHubConnectorName

string

Name of the GitHub Connector.

options

GitHubConnectorGetOptionalParams

The options parameters.

Returns

Promise<GitHubConnector>

listByResourceGroup(string, GitHubConnectorListByResourceGroupOptionalParams)

function listByResourceGroup(resourceGroupName: string, options?: GitHubConnectorListByResourceGroupOptionalParams): PagedAsyncIterableIterator<GitHubConnector, GitHubConnector[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

GitHubConnectorListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GitHubConnector, GitHubConnector[], PageSettings>

listBySubscription(GitHubConnectorListBySubscriptionOptionalParams)

Returns a list of monitored GitHub Connectors.

function listBySubscription(options?: GitHubConnectorListBySubscriptionOptionalParams): PagedAsyncIterableIterator<GitHubConnector, GitHubConnector[], PageSettings>

Parameters

options

GitHubConnectorListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GitHubConnector, GitHubConnector[], PageSettings>