Package version:

Interface VirtualClusters

Interface representing a VirtualClusters.

Hierarchy

VirtualClusters

Index

Methods

beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait beginUpdateDnsServers beginUpdateDnsServersAndWait get list listByResourceGroup

Methods

beginDelete

beginDelete(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a virtual cluster.
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.
- Optional options: VirtualClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/virtualClusters.ts:64

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersDeleteOptionalParams): Promise<void>
Deletes a virtual cluster.
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.
- Optional options: VirtualClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/virtualClusters.ts:76

beginUpdate

beginUpdate(resourceGroupName: string, virtualClusterName: string, parameters: VirtualClusterUpdate, options?: VirtualClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualCluster>, VirtualCluster>>
Updates an existing virtual cluster.
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.
- Optional options: VirtualClustersUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualCluster>, VirtualCluster>>
- Defined in operationsInterfaces/virtualClusters.ts:89

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, virtualClusterName: string, parameters: VirtualClusterUpdate, options?: VirtualClustersUpdateOptionalParams): Promise<VirtualCluster>
Updates an existing virtual cluster.
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.
- Optional options: VirtualClustersUpdateOptionalParams
  
  The options parameters.
Returns Promise<VirtualCluster>
- Defined in operationsInterfaces/virtualClusters.ts:108

beginUpdateDnsServers

beginUpdateDnsServers(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersUpdateDnsServersOptionalParams): Promise<SimplePollerLike<OperationState<UpdateVirtualClusterDnsServersOperation>, UpdateVirtualClusterDnsServersOperation>>
Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
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.
- Optional options: VirtualClustersUpdateDnsServersOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<UpdateVirtualClusterDnsServersOperation>, UpdateVirtualClusterDnsServersOperation>>
- Defined in operationsInterfaces/virtualClusters.ts:121

beginUpdateDnsServersAndWait

beginUpdateDnsServersAndWait(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersUpdateDnsServersOptionalParams): Promise<UpdateVirtualClusterDnsServersOperation>
Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
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.
- Optional options: VirtualClustersUpdateDnsServersOptionalParams
  
  The options parameters.
Returns Promise<UpdateVirtualClusterDnsServersOperation>
- Defined in operationsInterfaces/virtualClusters.ts:138

get

get(resourceGroupName: string, virtualClusterName: string, options?: VirtualClustersGetOptionalParams): Promise<VirtualCluster>
Gets a virtual cluster.
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.
- Optional options: VirtualClustersGetOptionalParams
  
  The options parameters.
Returns Promise<VirtualCluster>
- Defined in operationsInterfaces/virtualClusters.ts:52

list

list(options?: VirtualClustersListOptionalParams): PagedAsyncIterableIterator<VirtualCluster>
Gets a list of all virtualClusters in the subscription.
Parameters
- Optional options: VirtualClustersListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualCluster>
- Defined in operationsInterfaces/virtualClusters.ts:32

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: VirtualClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VirtualCluster>
Gets a list of virtual clusters in a resource group.
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.
- Optional options: VirtualClustersListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualCluster>
- Defined in operationsInterfaces/virtualClusters.ts:41

Interface VirtualClusters

Hierarchy

Index

Methods

Methods

beginDelete

Parameters

resourceGroupName: string

virtualClusterName: string

Optional options: VirtualClustersDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

virtualClusterName: string

Optional options: VirtualClustersDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

virtualClusterName: string

parameters: VirtualClusterUpdate

Optional options: VirtualClustersUpdateOptionalParams

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

beginUpdateAndWait

Parameters

resourceGroupName: string

virtualClusterName: string

parameters: VirtualClusterUpdate

Optional options: VirtualClustersUpdateOptionalParams

Returns Promise<VirtualCluster>

beginUpdateDnsServers

Parameters

resourceGroupName: string

virtualClusterName: string

Optional options: VirtualClustersUpdateDnsServersOptionalParams

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

beginUpdateDnsServersAndWait

Parameters

resourceGroupName: string

virtualClusterName: string

Optional options: VirtualClustersUpdateDnsServersOptionalParams

Returns Promise<UpdateVirtualClusterDnsServersOperation>

get

Parameters

resourceGroupName: string

virtualClusterName: string

Optional options: VirtualClustersGetOptionalParams

Returns Promise<VirtualCluster>

list

Parameters

Optional options: VirtualClustersListOptionalParams

Returns PagedAsyncIterableIterator<VirtualCluster>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: VirtualClustersListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<VirtualCluster>

Settings

Member Visibility

Theme

`Optional` options: VirtualClustersDeleteOptionalParams

`Optional` options: VirtualClustersDeleteOptionalParams

`Optional` options: VirtualClustersUpdateOptionalParams

`Optional` options: VirtualClustersUpdateOptionalParams

`Optional` options: VirtualClustersUpdateDnsServersOptionalParams

`Optional` options: VirtualClustersUpdateDnsServersOptionalParams

`Optional` options: VirtualClustersGetOptionalParams

`Optional` options: VirtualClustersListOptionalParams

`Optional` options: VirtualClustersListByResourceGroupOptionalParams