Interface PrivateCloudsClient


  • public interface PrivateCloudsClient
    An instance of this class provides access to all the operations defined in PrivateCloudsClient.
    • Method Detail

      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<PrivateCloudInner> 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<PrivateCloudInner> 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<PrivateCloudInner> 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<PrivateCloudInner> 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

        PrivateCloudInner 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<PrivateCloudInner> 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateCloudInner>,​PrivateCloudInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String privateCloudName,
                                                                                                                                                            PrivateCloudInner privateCloud)
        Create or update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloud - The private cloud.
        Returns:
        a private cloud resource.
        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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateCloudInner>,​PrivateCloudInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String privateCloudName,
                                                                                                                                                            PrivateCloudInner privateCloud,
                                                                                                                                                            com.azure.core.util.Context context)
        Create or update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloud - The private cloud.
        context - The context to associate with this operation.
        Returns:
        a private cloud resource.
        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.
      • createOrUpdate

        PrivateCloudInner createOrUpdate​(String resourceGroupName,
                                         String privateCloudName,
                                         PrivateCloudInner privateCloud)
        Create or update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloud - The private cloud.
        Returns:
        a private cloud resource.
        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.
      • createOrUpdate

        PrivateCloudInner createOrUpdate​(String resourceGroupName,
                                         String privateCloudName,
                                         PrivateCloudInner privateCloud,
                                         com.azure.core.util.Context context)
        Create or update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloud - The private cloud.
        context - The context to associate with this operation.
        Returns:
        a private cloud resource.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateCloudInner>,​PrivateCloudInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                    String privateCloudName,
                                                                                                                                                    PrivateCloudUpdate privateCloudUpdate)
        Update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloudUpdate - The private cloud properties to be updated.
        Returns:
        a private cloud resource.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateCloudInner>,​PrivateCloudInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                    String privateCloudName,
                                                                                                                                                    PrivateCloudUpdate privateCloudUpdate,
                                                                                                                                                    com.azure.core.util.Context context)
        Update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloudUpdate - The private cloud properties to be updated.
        context - The context to associate with this operation.
        Returns:
        a private cloud resource.
        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.
      • update

        PrivateCloudInner update​(String resourceGroupName,
                                 String privateCloudName,
                                 PrivateCloudUpdate privateCloudUpdate)
        Update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloudUpdate - The private cloud properties to be updated.
        Returns:
        a private cloud resource.
        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.
      • update

        PrivateCloudInner update​(String resourceGroupName,
                                 String privateCloudName,
                                 PrivateCloudUpdate privateCloudUpdate,
                                 com.azure.core.util.Context context)
        Update a private cloud.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        privateCloudName - Name of the private cloud.
        privateCloudUpdate - The private cloud properties to be updated.
        context - The context to associate with this operation.
        Returns:
        a private cloud resource.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(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.
        Returns:
        the completion.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(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.
        Returns:
        the completion.
        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)
        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.
      • beginRotateVcenterPassword

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRotateVcenterPassword​(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.
        Returns:
        the completion.
        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.
      • beginRotateVcenterPassword

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRotateVcenterPassword​(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.
        Returns:
        the completion.
        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.
      • beginRotateNsxtPassword

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRotateNsxtPassword​(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.
        Returns:
        the completion.
        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.
      • beginRotateNsxtPassword

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRotateNsxtPassword​(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.
        Returns:
        the completion.
        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

        AdminCredentialsInner 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<AdminCredentialsInner> 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.