VirtualClusters interface

Package:

@azure/arm-sql

Interface representing a VirtualClusters.

Methods

beginDelete(string, string, VirtualClustersDeleteOptionalParams)	Deletes a virtual cluster.
beginDeleteAndWait(string, string, VirtualClustersDeleteOptionalParams)	Deletes a virtual cluster.
beginUpdate(string, string, VirtualClusterUpdate, VirtualClustersUpdateOptionalParams)	Updates an existing virtual cluster.
beginUpdateAndWait(string, string, VirtualClusterUpdate, VirtualClustersUpdateOptionalParams)	Updates an existing virtual cluster.
beginUpdateDnsServers(string, string, VirtualClustersUpdateDnsServersOptionalParams)	Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
beginUpdateDnsServersAndWait(string, string, VirtualClustersUpdateDnsServersOptionalParams)	Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
get(string, string, VirtualClustersGetOptionalParams)	Gets a virtual cluster.
list(VirtualClustersListOptionalParams)	Gets a list of all virtualClusters in the subscription.
listByResourceGroup(string, VirtualClustersListByResourceGroupOptionalParams)	Gets a list of virtual clusters in a resource group.

Method Details

beginDelete(string, string, VirtualClustersDeleteOptionalParams)

Deletes a virtual cluster.

function beginDelete(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

virtualClusterName

string

The name of the virtual cluster.

options

VirtualClustersDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, VirtualClustersDeleteOptionalParams)

Deletes a virtual cluster.

function beginDeleteAndWait(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

virtualClusterName

string

The name of the virtual cluster.

options

VirtualClustersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, VirtualClusterUpdate, VirtualClustersUpdateOptionalParams)

Updates an existing virtual cluster.

function beginUpdate(resourceGroupName: string, virtualClusterName: string, parameters: VirtualClusterUpdate, options?: VirtualClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualCluster>, VirtualCluster>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

virtualClusterName

string

The name of the virtual cluster.

parameters

VirtualClusterUpdate

The requested virtual cluster resource state.

options

VirtualClustersUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<VirtualCluster>, VirtualCluster>>

beginUpdateAndWait(string, string, VirtualClusterUpdate, VirtualClustersUpdateOptionalParams)

Updates an existing virtual cluster.

function beginUpdateAndWait(resourceGroupName: string, virtualClusterName: string, parameters: VirtualClusterUpdate, options?: VirtualClustersUpdateOptionalParams): Promise<VirtualCluster>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

virtualClusterName

string

The name of the virtual cluster.

parameters

VirtualClusterUpdate

The requested virtual cluster resource state.

options

VirtualClustersUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualCluster>

beginUpdateDnsServers(string, string, VirtualClustersUpdateDnsServersOptionalParams)

Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.

function beginUpdateDnsServers(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersUpdateDnsServersOptionalParams): Promise<SimplePollerLike<OperationState<UpdateVirtualClusterDnsServersOperation>, UpdateVirtualClusterDnsServersOperation>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

virtualClusterName

string

The name of the virtual cluster.

options

VirtualClustersUpdateDnsServersOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<UpdateVirtualClusterDnsServersOperation>, UpdateVirtualClusterDnsServersOperation>>

beginUpdateDnsServersAndWait(string, string, VirtualClustersUpdateDnsServersOptionalParams)

Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.

function beginUpdateDnsServersAndWait(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersUpdateDnsServersOptionalParams): Promise<UpdateVirtualClusterDnsServersOperation>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

virtualClusterName

string

The name of the virtual cluster.

options

VirtualClustersUpdateDnsServersOptionalParams

The options parameters.

Returns

Promise<UpdateVirtualClusterDnsServersOperation>

get(string, string, VirtualClustersGetOptionalParams)

Gets a virtual cluster.

function get(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersGetOptionalParams): Promise<VirtualCluster>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

virtualClusterName

string

The name of the virtual cluster.

options

VirtualClustersGetOptionalParams

The options parameters.

Returns

Promise<VirtualCluster>

list(VirtualClustersListOptionalParams)

Gets a list of all virtualClusters in the subscription.

function list(options?: VirtualClustersListOptionalParams): PagedAsyncIterableIterator<VirtualCluster, VirtualCluster[], PageSettings>

Parameters

options

VirtualClustersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualCluster, VirtualCluster[], PageSettings>

listByResourceGroup(string, VirtualClustersListByResourceGroupOptionalParams)

Gets a list of virtual clusters in a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

options

VirtualClustersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualCluster, VirtualCluster[], PageSettings>