Package com.azure.resourcemanager.avs.models

Interface PrivateClouds

public interface PrivateClouds

Resource collection API of PrivateClouds.

Method Summary

Modifier and Type	Method	Description
PrivateCloud.DefinitionStages.Blank	define(String name)	Begins definition for a new PrivateCloud resource.
void	delete(String resourceGroupName, String privateCloudName, com.azure.core.util.Context context)	Delete a private cloud.
void	deleteById(String id)	Delete a private cloud.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a private cloud.
void	deleteByResourceGroup(String resourceGroupName, String privateCloudName)	Delete a private cloud.
PrivateCloud	getById(String id)	Get a private cloud.
com.azure.core.http.rest.Response<PrivateCloud>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a private cloud.
PrivateCloud	getByResourceGroup(String resourceGroupName, String privateCloudName)	Get a private cloud.
com.azure.core.http.rest.Response<PrivateCloud>	getByResourceGroupWithResponse(String resourceGroupName, String privateCloudName, com.azure.core.util.Context context)	Get a private cloud.
com.azure.core.http.rest.PagedIterable<PrivateCloud>	list()	List private clouds in a subscription.
com.azure.core.http.rest.PagedIterable<PrivateCloud>	list(com.azure.core.util.Context context)	List private clouds in a subscription.
AdminCredentials	listAdminCredentials(String resourceGroupName, String privateCloudName)	List the admin credentials for the private cloud.
com.azure.core.http.rest.Response<AdminCredentials>	listAdminCredentialsWithResponse(String resourceGroupName, String privateCloudName, com.azure.core.util.Context context)	List the admin credentials for the private cloud.
com.azure.core.http.rest.PagedIterable<PrivateCloud>	listByResourceGroup(String resourceGroupName)	List private clouds in a resource group.
com.azure.core.http.rest.PagedIterable<PrivateCloud>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	List private clouds in a resource group.
void	rotateNsxtPassword(String resourceGroupName, String privateCloudName)	Rotate the NSX-T Manager password.
void	rotateNsxtPassword(String resourceGroupName, String privateCloudName, com.azure.core.util.Context context)	Rotate the NSX-T Manager password.
void	rotateVcenterPassword(String resourceGroupName, String privateCloudName)	Rotate the vCenter password.
void	rotateVcenterPassword(String resourceGroupName, String privateCloudName, com.azure.core.util.Context context)	Rotate the vCenter password.

Method Detail

listByResourceGroup

com.azure.core.http.rest.PagedIterable<PrivateCloud> listByResourceGroup(String resourceGroupName)

List private clouds in a resource group.

Parameters:

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

Returns:

a paged list of private clouds.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<PrivateCloud> listByResourceGroup(String resourceGroupName,
                                                                         com.azure.core.util.Context context)

List private clouds in a resource group.

Parameters:

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

context - The context to associate with this operation.

Returns:

a paged list of private clouds.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<PrivateCloud> list()

List private clouds in a subscription.

Returns:

a paged list of private clouds.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<PrivateCloud> list(com.azure.core.util.Context context)

List private clouds in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

a paged list of private clouds.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

PrivateCloud getByResourceGroup(String resourceGroupName,
                                String privateCloudName)

Get a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

Returns:

a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<PrivateCloud> getByResourceGroupWithResponse(String resourceGroupName,
                                                                               String privateCloudName,
                                                                               com.azure.core.util.Context context)

Get a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

context - The context to associate with this operation.

Returns:

a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String privateCloudName)

Delete a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String privateCloudName,
            com.azure.core.util.Context context)

Delete a private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

rotateVcenterPassword

void rotateVcenterPassword(String resourceGroupName,
                           String privateCloudName)

Rotate the vCenter password.

Parameters:

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

privateCloudName - Name of the private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

rotateVcenterPassword

void rotateVcenterPassword(String resourceGroupName,
                           String privateCloudName,
                           com.azure.core.util.Context context)

Rotate the vCenter password.

Parameters:

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

privateCloudName - Name of the private cloud.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

rotateNsxtPassword

void rotateNsxtPassword(String resourceGroupName,
                        String privateCloudName)

Rotate the NSX-T Manager password.

Parameters:

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

privateCloudName - Name of the private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

rotateNsxtPassword

void rotateNsxtPassword(String resourceGroupName,
                        String privateCloudName,
                        com.azure.core.util.Context context)

Rotate the NSX-T Manager password.

Parameters:

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

privateCloudName - Name of the private cloud.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAdminCredentials

AdminCredentials listAdminCredentials(String resourceGroupName,
                                      String privateCloudName)

List the admin credentials for the private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

Returns:

administrative credentials for accessing vCenter and NSX-T.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAdminCredentialsWithResponse

com.azure.core.http.rest.Response<AdminCredentials> listAdminCredentialsWithResponse(String resourceGroupName,
                                                                                     String privateCloudName,
                                                                                     com.azure.core.util.Context context)

List the admin credentials for the private cloud.

Parameters:

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

privateCloudName - Name of the private cloud.

context - The context to associate with this operation.

Returns:

administrative credentials for accessing vCenter and NSX-T.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

PrivateCloud getById(String id)

Get a private cloud.

Parameters:

id - the resource ID.

Returns:

a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<PrivateCloud> getByIdWithResponse(String id,
                                                                    com.azure.core.util.Context context)

Get a private cloud.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a private cloud.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteById

void deleteById(String id)

Delete a private cloud.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete a private cloud.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

PrivateCloud.DefinitionStages.Blank define(String name)

Begins definition for a new PrivateCloud resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PrivateCloud definition.