VirtualClusters interface
Interface representing a VirtualClusters.
Methods
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
The options parameters.
Returns
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
The options parameters.
Returns
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.
The options parameters.