VirtualClustersOperations interface

Package:

@azure/arm-sql

Interface representing a VirtualClusters operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
beginUpdateDnsServers
beginUpdateDnsServersAndWait
createOrUpdate	Creates virtual cluster.
delete	Deletes a virtual cluster.
get	Gets a virtual cluster.
list	Gets a list of all virtualClusters in the subscription.
listByResourceGroup	Gets a list of virtual clusters in a resource group.
update	Updates an existing virtual cluster.
updateDnsServers	Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, virtualClusterName: string, parameters: VirtualCluster, options?: VirtualClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualCluster>, VirtualCluster>>

Property Value

(resourceGroupName: string, virtualClusterName: string, parameters: VirtualCluster, options?: VirtualClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualCluster>, VirtualCluster>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, virtualClusterName: string, parameters: VirtualCluster, options?: VirtualClustersCreateOrUpdateOptionalParams) => Promise<VirtualCluster>

Property Value

(resourceGroupName: string, virtualClusterName: string, parameters: VirtualCluster, options?: VirtualClustersCreateOrUpdateOptionalParams) => Promise<VirtualCluster>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateDnsServers

Warning

This API is now deprecated.

use updateDnsServers instead

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

Property Value

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

beginUpdateDnsServersAndWait

Warning

This API is now deprecated.

use updateDnsServers instead

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

Property Value

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

createOrUpdate

Creates virtual cluster.

createOrUpdate: (resourceGroupName: string, virtualClusterName: string, parameters: VirtualCluster, options?: VirtualClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualCluster>, VirtualCluster>

Property Value

(resourceGroupName: string, virtualClusterName: string, parameters: VirtualCluster, options?: VirtualClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualCluster>, VirtualCluster>

delete

Deletes a virtual cluster.

delete: (resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a virtual cluster.

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

Property Value

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

list

Gets a list of all virtualClusters in the subscription.

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

Property Value

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

listByResourceGroup

Gets a list of virtual clusters in a resource group.

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

Property Value

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

update

Updates an existing virtual cluster.

update: (resourceGroupName: string, virtualClusterName: string, parameters: VirtualClusterUpdate, options?: VirtualClustersUpdateOptionalParams) => PollerLike<OperationState<VirtualCluster>, VirtualCluster>

Property Value

(resourceGroupName: string, virtualClusterName: string, parameters: VirtualClusterUpdate, options?: VirtualClustersUpdateOptionalParams) => PollerLike<OperationState<VirtualCluster>, VirtualCluster>

updateDnsServers

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

updateDnsServers: (resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersUpdateDnsServersOptionalParams) => PollerLike<OperationState<UpdateVirtualClusterDnsServersOperation>, UpdateVirtualClusterDnsServersOperation>

Property Value

(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersUpdateDnsServersOptionalParams) => PollerLike<OperationState<UpdateVirtualClusterDnsServersOperation>, UpdateVirtualClusterDnsServersOperation>