ProvisionedClusterInstances interface

Package:

@azure/arm-hybridcontainerservice

Interface representing a ProvisionedClusterInstances.

Methods

beginCreateOrUpdate(string, ProvisionedCluster, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)	Creates or updates the provisioned cluster instance
beginCreateOrUpdateAndWait(string, ProvisionedCluster, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)	Creates or updates the provisioned cluster instance
beginDelete(string, ProvisionedClusterInstancesDeleteOptionalParams)	Deletes the provisioned cluster instance
beginDeleteAndWait(string, ProvisionedClusterInstancesDeleteOptionalParams)	Deletes the provisioned cluster instance
beginListAdminKubeconfig(string, ProvisionedClusterInstancesListAdminKubeconfigOptionalParams)	Lists the admin credentials of the provisioned cluster (can only be used within private network)
beginListAdminKubeconfigAndWait(string, ProvisionedClusterInstancesListAdminKubeconfigOptionalParams)	Lists the admin credentials of the provisioned cluster (can only be used within private network)
beginListUserKubeconfig(string, ProvisionedClusterInstancesListUserKubeconfigOptionalParams)	Lists the user credentials of the provisioned cluster (can only be used within private network)
beginListUserKubeconfigAndWait(string, ProvisionedClusterInstancesListUserKubeconfigOptionalParams)	Lists the user credentials of the provisioned cluster (can only be used within private network)
get(string, ProvisionedClusterInstancesGetOptionalParams)	Gets the provisioned cluster instance
getUpgradeProfile(string, ProvisionedClusterInstancesGetUpgradeProfileOptionalParams)	Gets the upgrade profile of a provisioned cluster
list(string, ProvisionedClusterInstancesListOptionalParams)	Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster

Method Details

beginCreateOrUpdate(string, ProvisionedCluster, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)

Creates or updates the provisioned cluster instance

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

Parameters

connectedClusterResourceUri

string

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

provisionedClusterInstance

ProvisionedCluster

Provisioned Cluster resource definition

options

ProvisionedClusterInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, ProvisionedCluster, ProvisionedClusterInstancesCreateOrUpdateOptionalParams)

Creates or updates the provisioned cluster instance

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

Parameters

connectedClusterResourceUri

string

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

provisionedClusterInstance

ProvisionedCluster

Provisioned Cluster resource definition

options

ProvisionedClusterInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProvisionedCluster>

beginDelete(string, ProvisionedClusterInstancesDeleteOptionalParams)

Deletes the 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 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 the provisioned cluster (can only be used within private network)

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 the provisioned cluster (can only be used within private network)

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 user credentials of the provisioned cluster (can only be used within private network)

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 user credentials of the provisioned cluster (can only be used within private network)

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 provisioned cluster instance

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

Parameters

connectedClusterResourceUri

string

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

options

ProvisionedClusterInstancesGetOptionalParams

The options parameters.

Returns

Promise<ProvisionedCluster>

getUpgradeProfile(string, ProvisionedClusterInstancesGetUpgradeProfileOptionalParams)

Gets the upgrade profile of a provisioned cluster

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)

Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster

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

Parameters

connectedClusterResourceUri

string

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

options

ProvisionedClusterInstancesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProvisionedCluster, ProvisionedCluster[], PageSettings>