Package com.azure.resourcemanager.purview.models

Interface Accounts

public interface Accounts
Resource collection API of Accounts.

  • Method Details

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Account> listByResourceGroup(String resourceGroupName)
      Gets the accounts resources by resource group.

      List accounts in ResourceGroup.

      Parameters:
      resourceGroupName - The resource group name.
      Returns:
      paged list of account resources as paginated response with PagedIterable.
      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<Account> listByResourceGroup(String resourceGroupName, String skipToken, com.azure.core.util.Context context)
      Gets the accounts resources by resource group.

      List accounts in ResourceGroup.

      Parameters:
      resourceGroupName - The resource group name.
      skipToken - The skip token.
      context - The context to associate with this operation.
      Returns:
      paged list of account resources as paginated response with PagedIterable.
      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<Account> list()
      Gets the accounts resources by subscription.

      List accounts in Subscription.

      Returns:
      paged list of account resources as paginated response with PagedIterable.
      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<Account> list(String skipToken, com.azure.core.util.Context context)
      Gets the accounts resources by subscription.

      List accounts in Subscription.

      Parameters:
      skipToken - The skip token.
      context - The context to associate with this operation.
      Returns:
      paged list of account resources as paginated response with PagedIterable.
      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<Account> getByResourceGroupWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Gets the account resource.

      Get an account.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      context - The context to associate with this operation.
      Returns:
      an account along with Response.
      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

      Account getByResourceGroup(String resourceGroupName, String accountName)
      Gets the account resource.

      Get an account.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      Returns:
      an account.
      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 accountName)
      Deletes the account resource.

      Deletes an account resource.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      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 accountName, com.azure.core.util.Context context)
      Deletes the account resource.

      Deletes an account resource.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      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.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<AccessKeys> listKeysWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Lists the keys asynchronous.

      List the authorization keys associated with this account.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      context - The context to associate with this operation.
      Returns:
      the Account access keys along with Response.
      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.

    • listKeys

      AccessKeys listKeys(String resourceGroupName, String accountName)
      Lists the keys asynchronous.

      List the authorization keys associated with this account.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      Returns:
      the Account access keys.
      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.

    • addRootCollectionAdminWithResponse

      com.azure.core.http.rest.Response<Void> addRootCollectionAdminWithResponse(String resourceGroupName, String accountName, CollectionAdminUpdate collectionAdminUpdate, com.azure.core.util.Context context)
      Add the administrator for root collection.

      Add the administrator for root collection associated with this account.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      collectionAdminUpdate - The collection admin update payload.
      context - The context to associate with this operation.
      Returns:
      the Response.
      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.

    • addRootCollectionAdmin

      void addRootCollectionAdmin(String resourceGroupName, String accountName, CollectionAdminUpdate collectionAdminUpdate)
      Add the administrator for root collection.

      Add the administrator for root collection associated with this account.

      Parameters:
      resourceGroupName - The resource group name.
      accountName - The name of the account.
      collectionAdminUpdate - The collection admin update payload.
      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.

    • checkNameAvailabilityWithResponse

      com.azure.core.http.rest.Response<CheckNameAvailabilityResult> checkNameAvailabilityWithResponse(CheckNameAvailabilityRequest checkNameAvailabilityRequest, com.azure.core.util.Context context)
      Checks the account name availability.

      Checks if account name is available.

      Parameters:
      checkNameAvailabilityRequest - The check name availability request.
      context - The context to associate with this operation.
      Returns:
      the response payload for CheckNameAvailability API along with Response.
      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.

    • checkNameAvailability

      CheckNameAvailabilityResult checkNameAvailability(CheckNameAvailabilityRequest checkNameAvailabilityRequest)
      Checks the account name availability.

      Checks if account name is available.

      Parameters:
      checkNameAvailabilityRequest - The check name availability request.
      Returns:
      the response payload for CheckNameAvailability API.
      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

      Account getById(String id)
      Gets the account resource.

      Get an account.

      Parameters:
      id - the resource ID.
      Returns:
      an account along with Response.
      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<Account> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the account resource.

      Get an account.

      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      an account along with Response.
      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)
      Deletes the account resource.

      Deletes an account resource.

      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)
      Deletes the account resource.

      Deletes an account resource.

      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

      Account.DefinitionStages.Blank define(String name)
      Begins definition for a new Account resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Account definition.