SourceControlConfigurations interface

Interface representing a SourceControlConfigurations.

Methods

beginDelete(string, string, string, string, string, SourceControlConfigurationsDeleteOptionalParams)

This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo.

beginDeleteAndWait(string, string, string, string, string, SourceControlConfigurationsDeleteOptionalParams)

This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo.

createOrUpdate(string, string, string, string, string, SourceControlConfiguration, SourceControlConfigurationsCreateOrUpdateOptionalParams)

Create a new Kubernetes Source Control Configuration.

get(string, string, string, string, string, SourceControlConfigurationsGetOptionalParams)

Gets details of the Source Control Configuration.

list(string, string, string, string, SourceControlConfigurationsListOptionalParams)

List all Source Control Configurations.

Method Details

beginDelete(string, string, string, string, string, SourceControlConfigurationsDeleteOptionalParams)

This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo.

function beginDelete(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, sourceControlConfigurationName: string, options?: SourceControlConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterRp

string

The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName

string

The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName

string

The name of the kubernetes cluster.

sourceControlConfigurationName

string

Name of the Source Control Configuration.

options
SourceControlConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, string, SourceControlConfigurationsDeleteOptionalParams)

This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo.

function beginDeleteAndWait(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, sourceControlConfigurationName: string, options?: SourceControlConfigurationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterRp

string

The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName

string

The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName

string

The name of the kubernetes cluster.

sourceControlConfigurationName

string

Name of the Source Control Configuration.

options
SourceControlConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, string, string, SourceControlConfiguration, SourceControlConfigurationsCreateOrUpdateOptionalParams)

Create a new Kubernetes Source Control Configuration.

function createOrUpdate(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, sourceControlConfigurationName: string, sourceControlConfiguration: SourceControlConfiguration, options?: SourceControlConfigurationsCreateOrUpdateOptionalParams): Promise<SourceControlConfiguration>

Parameters

resourceGroupName

string

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

clusterRp

string

The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName

string

The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName

string

The name of the kubernetes cluster.

sourceControlConfigurationName

string

Name of the Source Control Configuration.

sourceControlConfiguration
SourceControlConfiguration

Properties necessary to Create KubernetesConfiguration.

Returns

get(string, string, string, string, string, SourceControlConfigurationsGetOptionalParams)

Gets details of the Source Control Configuration.

function get(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, sourceControlConfigurationName: string, options?: SourceControlConfigurationsGetOptionalParams): Promise<SourceControlConfiguration>

Parameters

resourceGroupName

string

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

clusterRp

string

The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName

string

The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName

string

The name of the kubernetes cluster.

sourceControlConfigurationName

string

Name of the Source Control Configuration.

options
SourceControlConfigurationsGetOptionalParams

The options parameters.

Returns

list(string, string, string, string, SourceControlConfigurationsListOptionalParams)

List all Source Control Configurations.

function list(resourceGroupName: string, clusterRp: string, clusterResourceName: string, clusterName: string, options?: SourceControlConfigurationsListOptionalParams): PagedAsyncIterableIterator<SourceControlConfiguration, SourceControlConfiguration[], PageSettings>

Parameters

resourceGroupName

string

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

clusterRp

string

The Kubernetes cluster RP - i.e. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

clusterResourceName

string

The Kubernetes cluster resource name - i.e. managedClusters, connectedClusters, provisionedClusters.

clusterName

string

The name of the kubernetes cluster.

options
SourceControlConfigurationsListOptionalParams

The options parameters.

Returns