ProvisionedClusterInstances interface

Package:

@azure/arm-hybridcontainerservice

Interface representing a ProvisionedClusterInstances.

Methods

beginCreateOrUpdate(string, ProvisionedClusters, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)	Creates the Hybrid AKS provisioned cluster instance
beginCreateOrUpdateAndWait(string, ProvisionedClusters, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)	Creates the Hybrid AKS provisioned cluster instance
beginDelete(string, ProvisionedClusterInstancesDeleteOptionalParams)	Deletes the Hybrid AKS provisioned cluster instance
beginDeleteAndWait(string, ProvisionedClusterInstancesDeleteOptionalParams)	Deletes the Hybrid AKS provisioned cluster instance
beginListAdminKubeconfig(string, ProvisionedClusterInstancesListAdminKubeconfigOptionalParams)	Lists the admin credentials of a provisioned cluster instance used only in direct mode.
beginListAdminKubeconfigAndWait(string, ProvisionedClusterInstancesListAdminKubeconfigOptionalParams)	Lists the admin credentials of a provisioned cluster instance used only in direct mode.
beginListUserKubeconfig(string, ProvisionedClusterInstancesListUserKubeconfigOptionalParams)	Lists the AAD user credentials of a provisioned cluster instance used only in direct mode.
beginListUserKubeconfigAndWait(string, ProvisionedClusterInstancesListUserKubeconfigOptionalParams)	Lists the AAD user credentials of a provisioned cluster instance used only in direct mode.
get(string, ProvisionedClusterInstancesGetOptionalParams)	Gets the Hybrid AKS provisioned cluster instance
getUpgradeProfile(string, ProvisionedClusterInstancesGetUpgradeProfileOptionalParams)	Gets the upgrade profile of a provisioned cluster instance.
list(string, ProvisionedClusterInstancesListOptionalParams)	Gets the Hybrid AKS provisioned cluster instances associated with the connected cluster

Method Details

beginCreateOrUpdate(string, ProvisionedClusters, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)

Creates the Hybrid AKS provisioned cluster instance

function beginCreateOrUpdate(connectedClusterResourceUri: string, provisionedClusterInstance: ProvisionedClusters, options?: ProvisionedClusterInstancesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ProvisionedClusters>, ProvisionedClusters>>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

provisionedClusterInstance

ProvisionedClusters

The provisionedClusterInstances resource definition.

options

ProvisionedClusterInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, ProvisionedClusters, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)

Creates the Hybrid AKS provisioned cluster instance

function beginCreateOrUpdateAndWait(connectedClusterResourceUri: string, provisionedClusterInstance: ProvisionedClusters, options?: ProvisionedClusterInstancesCreateOrUpdateOptionalParams): Promise<ProvisionedClusters>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

provisionedClusterInstance

ProvisionedClusters

The provisionedClusterInstances resource definition.

options

ProvisionedClusterInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProvisionedClusters>

beginDelete(string, ProvisionedClusterInstancesDeleteOptionalParams)

Deletes the Hybrid AKS provisioned cluster instance

function beginDelete(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ProvisionedClusterInstancesDeleteHeaders>, ProvisionedClusterInstancesDeleteHeaders>>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, ProvisionedClusterInstancesDeleteOptionalParams)

Deletes the Hybrid AKS provisioned cluster instance

function beginDeleteAndWait(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesDeleteOptionalParams): Promise<ProvisionedClusterInstancesDeleteHeaders>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesDeleteOptionalParams

The options parameters.

Returns

Promise<ProvisionedClusterInstancesDeleteHeaders>

beginListAdminKubeconfig(string, ProvisionedClusterInstancesListAdminKubeconfigOptionalParams)

Lists the admin credentials of a provisioned cluster instance used only in direct mode.

function beginListAdminKubeconfig(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesListAdminKubeconfigOptionalParams): Promise<SimplePollerLike<OperationState<ListCredentialResponse>, ListCredentialResponse>>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesListAdminKubeconfigOptionalParams

The options parameters.

Returns

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

beginListAdminKubeconfigAndWait(string, ProvisionedClusterInstancesListAdminKubeconfigOptionalParams)

Lists the admin credentials of a provisioned cluster instance used only in direct mode.

function beginListAdminKubeconfigAndWait(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesListAdminKubeconfigOptionalParams): Promise<ListCredentialResponse>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesListAdminKubeconfigOptionalParams

The options parameters.

Returns

Promise<ListCredentialResponse>

beginListUserKubeconfig(string, ProvisionedClusterInstancesListUserKubeconfigOptionalParams)

Lists the AAD user credentials of a provisioned cluster instance used only in direct mode.

function beginListUserKubeconfig(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesListUserKubeconfigOptionalParams): Promise<SimplePollerLike<OperationState<ListCredentialResponse>, ListCredentialResponse>>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesListUserKubeconfigOptionalParams

The options parameters.

Returns

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

beginListUserKubeconfigAndWait(string, ProvisionedClusterInstancesListUserKubeconfigOptionalParams)

Lists the AAD user credentials of a provisioned cluster instance used only in direct mode.

function beginListUserKubeconfigAndWait(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesListUserKubeconfigOptionalParams): Promise<ListCredentialResponse>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesListUserKubeconfigOptionalParams

The options parameters.

Returns

Promise<ListCredentialResponse>

get(string, ProvisionedClusterInstancesGetOptionalParams)

Gets the Hybrid AKS provisioned cluster instance

function get(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesGetOptionalParams): Promise<ProvisionedClusters>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesGetOptionalParams

The options parameters.

Returns

Promise<ProvisionedClusters>

getUpgradeProfile(string, ProvisionedClusterInstancesGetUpgradeProfileOptionalParams)

Gets the upgrade profile of a provisioned cluster instance.

function getUpgradeProfile(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesGetUpgradeProfileOptionalParams): Promise<ProvisionedClusterUpgradeProfile>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesGetUpgradeProfileOptionalParams

The options parameters.

Returns

Promise<ProvisionedClusterUpgradeProfile>

list(string, ProvisionedClusterInstancesListOptionalParams)

Gets the Hybrid AKS provisioned cluster instances associated with the connected cluster

function list(connectedClusterResourceUri: string, options?: ProvisionedClusterInstancesListOptionalParams): PagedAsyncIterableIterator<ProvisionedClusters, ProvisionedClusters[], PageSettings>

Parameters

connectedClusterResourceUri

string

The fully qualified Azure Resource manager identifier of the connected cluster resource.

options

ProvisionedClusterInstancesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProvisionedClusters, ProvisionedClusters[], PageSettings>