PrivateClouds interface

Package:

@azure/arm-avs

Interface representing a PrivateClouds.

Methods

beginCreateOrUpdate(string, string, PrivateCloud, PrivateCloudsCreateOrUpdateOptionalParams)	Create a PrivateCloud
beginCreateOrUpdateAndWait(string, string, PrivateCloud, PrivateCloudsCreateOrUpdateOptionalParams)	Create a PrivateCloud
beginDelete(string, string, PrivateCloudsDeleteOptionalParams)	Delete a PrivateCloud
beginDeleteAndWait(string, string, PrivateCloudsDeleteOptionalParams)	Delete a PrivateCloud
beginRotateNsxtPassword(string, string, PrivateCloudsRotateNsxtPasswordOptionalParams)	Rotate the NSX-T Manager password
beginRotateNsxtPasswordAndWait(string, string, PrivateCloudsRotateNsxtPasswordOptionalParams)	Rotate the NSX-T Manager password
beginRotateVcenterPassword(string, string, PrivateCloudsRotateVcenterPasswordOptionalParams)	Rotate the vCenter password
beginRotateVcenterPasswordAndWait(string, string, PrivateCloudsRotateVcenterPasswordOptionalParams)	Rotate the vCenter password
beginUpdate(string, string, PrivateCloudUpdate, PrivateCloudsUpdateOptionalParams)	Update a PrivateCloud
beginUpdateAndWait(string, string, PrivateCloudUpdate, PrivateCloudsUpdateOptionalParams)	Update a PrivateCloud
get(string, string, PrivateCloudsGetOptionalParams)	Get a PrivateCloud
list(string, PrivateCloudsListOptionalParams)	List PrivateCloud resources by resource group
listAdminCredentials(string, string, PrivateCloudsListAdminCredentialsOptionalParams)	List the admin credentials for the private cloud
listInSubscription(PrivateCloudsListInSubscriptionOptionalParams)	List PrivateCloud resources by subscription ID

Method Details

beginCreateOrUpdate(string, string, PrivateCloud, PrivateCloudsCreateOrUpdateOptionalParams)

Create a PrivateCloud

function beginCreateOrUpdate(resourceGroupName: string, privateCloudName: string, privateCloud: PrivateCloud, options?: PrivateCloudsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateCloud>, PrivateCloud>>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

privateCloud

PrivateCloud

Resource create parameters.

options

PrivateCloudsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, PrivateCloud, PrivateCloudsCreateOrUpdateOptionalParams)

Create a PrivateCloud

function beginCreateOrUpdateAndWait(resourceGroupName: string, privateCloudName: string, privateCloud: PrivateCloud, options?: PrivateCloudsCreateOrUpdateOptionalParams): Promise<PrivateCloud>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

privateCloud

PrivateCloud

Resource create parameters.

options

PrivateCloudsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateCloud>

beginDelete(string, string, PrivateCloudsDeleteOptionalParams)

Delete a PrivateCloud

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

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, PrivateCloudsDeleteOptionalParams)

Delete a PrivateCloud

function beginDeleteAndWait(resourceGroupName: string, privateCloudName: string, options?: PrivateCloudsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRotateNsxtPassword(string, string, PrivateCloudsRotateNsxtPasswordOptionalParams)

Rotate the NSX-T Manager password

function beginRotateNsxtPassword(resourceGroupName: string, privateCloudName: string, options?: PrivateCloudsRotateNsxtPasswordOptionalParams): Promise<SimplePollerLike<OperationState<PrivateCloudsRotateNsxtPasswordHeaders>, PrivateCloudsRotateNsxtPasswordHeaders>>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsRotateNsxtPasswordOptionalParams

The options parameters.

Returns

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

beginRotateNsxtPasswordAndWait(string, string, PrivateCloudsRotateNsxtPasswordOptionalParams)

Rotate the NSX-T Manager password

function beginRotateNsxtPasswordAndWait(resourceGroupName: string, privateCloudName: string, options?: PrivateCloudsRotateNsxtPasswordOptionalParams): Promise<PrivateCloudsRotateNsxtPasswordHeaders>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsRotateNsxtPasswordOptionalParams

The options parameters.

Returns

Promise<PrivateCloudsRotateNsxtPasswordHeaders>

beginRotateVcenterPassword(string, string, PrivateCloudsRotateVcenterPasswordOptionalParams)

Rotate the vCenter password

function beginRotateVcenterPassword(resourceGroupName: string, privateCloudName: string, options?: PrivateCloudsRotateVcenterPasswordOptionalParams): Promise<SimplePollerLike<OperationState<PrivateCloudsRotateVcenterPasswordHeaders>, PrivateCloudsRotateVcenterPasswordHeaders>>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsRotateVcenterPasswordOptionalParams

The options parameters.

Returns

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

beginRotateVcenterPasswordAndWait(string, string, PrivateCloudsRotateVcenterPasswordOptionalParams)

Rotate the vCenter password

function beginRotateVcenterPasswordAndWait(resourceGroupName: string, privateCloudName: string, options?: PrivateCloudsRotateVcenterPasswordOptionalParams): Promise<PrivateCloudsRotateVcenterPasswordHeaders>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsRotateVcenterPasswordOptionalParams

The options parameters.

Returns

Promise<PrivateCloudsRotateVcenterPasswordHeaders>

beginUpdate(string, string, PrivateCloudUpdate, PrivateCloudsUpdateOptionalParams)

Update a PrivateCloud

function beginUpdate(resourceGroupName: string, privateCloudName: string, privateCloudUpdate: PrivateCloudUpdate, options?: PrivateCloudsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateCloud>, PrivateCloud>>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

privateCloudUpdate

PrivateCloudUpdate

The private cloud properties to be updated.

options

PrivateCloudsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, PrivateCloudUpdate, PrivateCloudsUpdateOptionalParams)

Update a PrivateCloud

function beginUpdateAndWait(resourceGroupName: string, privateCloudName: string, privateCloudUpdate: PrivateCloudUpdate, options?: PrivateCloudsUpdateOptionalParams): Promise<PrivateCloud>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

privateCloudUpdate

PrivateCloudUpdate

The private cloud properties to be updated.

options

PrivateCloudsUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateCloud>

get(string, string, PrivateCloudsGetOptionalParams)

Get a PrivateCloud

function get(resourceGroupName: string, privateCloudName: string, options?: PrivateCloudsGetOptionalParams): Promise<PrivateCloud>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsGetOptionalParams

The options parameters.

Returns

Promise<PrivateCloud>

list(string, PrivateCloudsListOptionalParams)

List PrivateCloud resources by resource group

function list(resourceGroupName: string, options?: PrivateCloudsListOptionalParams): PagedAsyncIterableIterator<PrivateCloud, PrivateCloud[], PageSettings>

Parameters

resourceGroupName

string

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

options

PrivateCloudsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateCloud, PrivateCloud[], PageSettings>

listAdminCredentials(string, string, PrivateCloudsListAdminCredentialsOptionalParams)

List the admin credentials for the private cloud

function listAdminCredentials(resourceGroupName: string, privateCloudName: string, options?: PrivateCloudsListAdminCredentialsOptionalParams): Promise<AdminCredentials>

Parameters

resourceGroupName

string

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

privateCloudName

string

Name of the private cloud

options

PrivateCloudsListAdminCredentialsOptionalParams

The options parameters.

Returns

Promise<AdminCredentials>

listInSubscription(PrivateCloudsListInSubscriptionOptionalParams)

List PrivateCloud resources by subscription ID

function listInSubscription(options?: PrivateCloudsListInSubscriptionOptionalParams): PagedAsyncIterableIterator<PrivateCloud, PrivateCloud[], PageSettings>

Parameters

options

PrivateCloudsListInSubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateCloud, PrivateCloud[], PageSettings>