CloudVmClusters interface

Package:

@azure/arm-oracledatabase

Interface representing a CloudVmClusters.

Methods

beginAddVms(string, string, AddRemoveDbNode, CloudVmClustersAddVmsOptionalParams)	Add VMs to the VM Cluster
beginAddVmsAndWait(string, string, AddRemoveDbNode, CloudVmClustersAddVmsOptionalParams)	Add VMs to the VM Cluster
beginCreateOrUpdate(string, string, CloudVmCluster, CloudVmClustersCreateOrUpdateOptionalParams)	Create a CloudVmCluster
beginCreateOrUpdateAndWait(string, string, CloudVmCluster, CloudVmClustersCreateOrUpdateOptionalParams)	Create a CloudVmCluster
beginDelete(string, string, CloudVmClustersDeleteOptionalParams)	Delete a CloudVmCluster
beginDeleteAndWait(string, string, CloudVmClustersDeleteOptionalParams)	Delete a CloudVmCluster
beginRemoveVms(string, string, AddRemoveDbNode, CloudVmClustersRemoveVmsOptionalParams)	Remove VMs from the VM Cluster
beginRemoveVmsAndWait(string, string, AddRemoveDbNode, CloudVmClustersRemoveVmsOptionalParams)	Remove VMs from the VM Cluster
beginUpdate(string, string, CloudVmClusterUpdate, CloudVmClustersUpdateOptionalParams)	Update a CloudVmCluster
beginUpdateAndWait(string, string, CloudVmClusterUpdate, CloudVmClustersUpdateOptionalParams)	Update a CloudVmCluster
get(string, string, CloudVmClustersGetOptionalParams)	Get a CloudVmCluster
listByResourceGroup(string, CloudVmClustersListByResourceGroupOptionalParams)	List CloudVmCluster resources by resource group
listBySubscription(CloudVmClustersListBySubscriptionOptionalParams)	List CloudVmCluster resources by subscription ID
listPrivateIpAddresses(string, string, PrivateIpAddressesFilter, CloudVmClustersListPrivateIpAddressesOptionalParams)	List Private IP Addresses by the provided filter

Method Details

beginAddVms(string, string, AddRemoveDbNode, CloudVmClustersAddVmsOptionalParams)

Add VMs to the VM Cluster

function beginAddVms(resourceGroupName: string, cloudvmclustername: string, body: AddRemoveDbNode, options?: CloudVmClustersAddVmsOptionalParams): Promise<SimplePollerLike<OperationState<CloudVmCluster>, CloudVmCluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

body

AddRemoveDbNode

The content of the action request

options

CloudVmClustersAddVmsOptionalParams

The options parameters.

Returns

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

beginAddVmsAndWait(string, string, AddRemoveDbNode, CloudVmClustersAddVmsOptionalParams)

Add VMs to the VM Cluster

function beginAddVmsAndWait(resourceGroupName: string, cloudvmclustername: string, body: AddRemoveDbNode, options?: CloudVmClustersAddVmsOptionalParams): Promise<CloudVmCluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

body

AddRemoveDbNode

The content of the action request

options

CloudVmClustersAddVmsOptionalParams

The options parameters.

Returns

Promise<CloudVmCluster>

beginCreateOrUpdate(string, string, CloudVmCluster, CloudVmClustersCreateOrUpdateOptionalParams)

Create a CloudVmCluster

function beginCreateOrUpdate(resourceGroupName: string, cloudvmclustername: string, resource: CloudVmCluster, options?: CloudVmClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CloudVmCluster>, CloudVmCluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

resource

CloudVmCluster

Resource create parameters.

options

CloudVmClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, CloudVmCluster, CloudVmClustersCreateOrUpdateOptionalParams)

Create a CloudVmCluster

function beginCreateOrUpdateAndWait(resourceGroupName: string, cloudvmclustername: string, resource: CloudVmCluster, options?: CloudVmClustersCreateOrUpdateOptionalParams): Promise<CloudVmCluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

resource

CloudVmCluster

Resource create parameters.

options

CloudVmClustersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CloudVmCluster>

beginDelete(string, string, CloudVmClustersDeleteOptionalParams)

Delete a CloudVmCluster

function beginDelete(resourceGroupName: string, cloudvmclustername: string, options?: CloudVmClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<CloudVmClustersDeleteHeaders>, CloudVmClustersDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

options

CloudVmClustersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, CloudVmClustersDeleteOptionalParams)

Delete a CloudVmCluster

function beginDeleteAndWait(resourceGroupName: string, cloudvmclustername: string, options?: CloudVmClustersDeleteOptionalParams): Promise<CloudVmClustersDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

options

CloudVmClustersDeleteOptionalParams

The options parameters.

Returns

Promise<CloudVmClustersDeleteHeaders>

beginRemoveVms(string, string, AddRemoveDbNode, CloudVmClustersRemoveVmsOptionalParams)

Remove VMs from the VM Cluster

function beginRemoveVms(resourceGroupName: string, cloudvmclustername: string, body: AddRemoveDbNode, options?: CloudVmClustersRemoveVmsOptionalParams): Promise<SimplePollerLike<OperationState<CloudVmCluster>, CloudVmCluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

body

AddRemoveDbNode

The content of the action request

options

CloudVmClustersRemoveVmsOptionalParams

The options parameters.

Returns

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

beginRemoveVmsAndWait(string, string, AddRemoveDbNode, CloudVmClustersRemoveVmsOptionalParams)

Remove VMs from the VM Cluster

function beginRemoveVmsAndWait(resourceGroupName: string, cloudvmclustername: string, body: AddRemoveDbNode, options?: CloudVmClustersRemoveVmsOptionalParams): Promise<CloudVmCluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

body

AddRemoveDbNode

The content of the action request

options

CloudVmClustersRemoveVmsOptionalParams

The options parameters.

Returns

Promise<CloudVmCluster>

beginUpdate(string, string, CloudVmClusterUpdate, CloudVmClustersUpdateOptionalParams)

Update a CloudVmCluster

function beginUpdate(resourceGroupName: string, cloudvmclustername: string, properties: CloudVmClusterUpdate, options?: CloudVmClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CloudVmCluster>, CloudVmCluster>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

properties

CloudVmClusterUpdate

The resource properties to be updated.

options

CloudVmClustersUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, CloudVmClusterUpdate, CloudVmClustersUpdateOptionalParams)

Update a CloudVmCluster

function beginUpdateAndWait(resourceGroupName: string, cloudvmclustername: string, properties: CloudVmClusterUpdate, options?: CloudVmClustersUpdateOptionalParams): Promise<CloudVmCluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

properties

CloudVmClusterUpdate

The resource properties to be updated.

options

CloudVmClustersUpdateOptionalParams

The options parameters.

Returns

Promise<CloudVmCluster>

get(string, string, CloudVmClustersGetOptionalParams)

Get a CloudVmCluster

function get(resourceGroupName: string, cloudvmclustername: string, options?: CloudVmClustersGetOptionalParams): Promise<CloudVmCluster>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

options

CloudVmClustersGetOptionalParams

The options parameters.

Returns

Promise<CloudVmCluster>

listByResourceGroup(string, CloudVmClustersListByResourceGroupOptionalParams)

List CloudVmCluster resources by resource group

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

CloudVmClustersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CloudVmCluster, CloudVmCluster[], PageSettings>

listBySubscription(CloudVmClustersListBySubscriptionOptionalParams)

List CloudVmCluster resources by subscription ID

function listBySubscription(options?: CloudVmClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CloudVmCluster, CloudVmCluster[], PageSettings>

Parameters

options

CloudVmClustersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CloudVmCluster, CloudVmCluster[], PageSettings>

listPrivateIpAddresses(string, string, PrivateIpAddressesFilter, CloudVmClustersListPrivateIpAddressesOptionalParams)

List Private IP Addresses by the provided filter

function listPrivateIpAddresses(resourceGroupName: string, cloudvmclustername: string, body: PrivateIpAddressesFilter, options?: CloudVmClustersListPrivateIpAddressesOptionalParams): Promise<CloudVmClustersListPrivateIpAddressesResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cloudvmclustername

string

CloudVmCluster name

body

PrivateIpAddressesFilter

The content of the action request

options

CloudVmClustersListPrivateIpAddressesOptionalParams

The options parameters.

Returns

Promise<CloudVmClustersListPrivateIpAddressesResponse>