Package com.azure.resourcemanager.cognitiveservices.fluent

Interface AccountsClient

public interface AccountsClient
An instance of this class provides access to all the operations defined in AccountsClient.

  • Method Details

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AccountInner>,AccountInner> beginCreate(String resourceGroupName, String accountName, AccountInner account)
      Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      Returns:
      the SyncPoller for polling of cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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.

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<AccountInner>,AccountInner> beginCreate(String resourceGroupName, String accountName, AccountInner account, com.azure.core.util.Context context)
      Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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.

    • create

      AccountInner create(String resourceGroupName, String accountName, AccountInner account)
      Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      Returns:
      cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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.

    • create

      AccountInner create(String resourceGroupName, String accountName, AccountInner account, com.azure.core.util.Context context)
      Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      context - The context to associate with this operation.
      Returns:
      cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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<AccountInner>,AccountInner> beginUpdate(String resourceGroupName, String accountName, AccountInner account)
      Updates a Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      Returns:
      the SyncPoller for polling of cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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<AccountInner>,AccountInner> beginUpdate(String resourceGroupName, String accountName, AccountInner account, com.azure.core.util.Context context)
      Updates a Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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

      AccountInner update(String resourceGroupName, String accountName, AccountInner account)
      Updates a Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      Returns:
      cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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

      AccountInner update(String resourceGroupName, String accountName, AccountInner account, com.azure.core.util.Context context)
      Updates a Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      account - The parameters to provide for the created account.
      context - The context to associate with this operation.
      Returns:
      cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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 accountName)
      Deletes a Cognitive Services account from the resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      Returns:
      the SyncPoller for polling of long-running 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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Deletes a Cognitive Services account from the resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running 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.

    • delete

      void delete(String resourceGroupName, String accountName)
      Deletes a Cognitive Services account from the resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services 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 a Cognitive Services account from the resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services 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.

    • getByResourceGroup

      AccountInner getByResourceGroup(String resourceGroupName, String accountName)
      Returns a Cognitive Services account specified by the parameters.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      Returns:
      cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
      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<AccountInner> getByResourceGroupWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Returns a Cognitive Services account specified by the parameters.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      context - The context to associate with this operation.
      Returns:
      cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<AccountInner> listByResourceGroup(String resourceGroupName)
      Returns all the resources of a particular type belonging to a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the list of cognitive services accounts operation response 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<AccountInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Returns all the resources of a particular type belonging to 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:
      the list of cognitive services accounts operation response 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<AccountInner> list()
      Returns all the resources of a particular type belonging to a subscription.
      Returns:
      the list of cognitive services accounts operation response 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<AccountInner> list(com.azure.core.util.Context context)
      Returns all the resources of a particular type belonging to a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the list of cognitive services accounts operation response 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.

    • listKeys

      ApiKeysInner listKeys(String resourceGroupName, String accountName)
      Lists the account keys for the specified Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      Returns:
      the access keys for the cognitive services 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.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<ApiKeysInner> listKeysWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Lists the account keys for the specified Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      context - The context to associate with this operation.
      Returns:
      the access keys for the cognitive services 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.

    • regenerateKey

      ApiKeysInner regenerateKey(String resourceGroupName, String accountName, RegenerateKeyParameters parameters)
      Regenerates the specified account key for the specified Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      parameters - regenerate key parameters.
      Returns:
      the access keys for the cognitive services 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.

    • regenerateKeyWithResponse

      com.azure.core.http.rest.Response<ApiKeysInner> regenerateKeyWithResponse(String resourceGroupName, String accountName, RegenerateKeyParameters parameters, com.azure.core.util.Context context)
      Regenerates the specified account key for the specified Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      parameters - regenerate key parameters.
      context - The context to associate with this operation.
      Returns:
      the access keys for the cognitive services 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.

    • listSkus

      AccountSkuListResultInner listSkus(String resourceGroupName, String accountName)
      List available SKUs for the requested Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      Returns:
      the list of cognitive services accounts operation 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.

    • listSkusWithResponse

      com.azure.core.http.rest.Response<AccountSkuListResultInner> listSkusWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      List available SKUs for the requested Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      context - The context to associate with this operation.
      Returns:
      the list of cognitive services accounts operation response 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.

    • listUsages

      UsageListResultInner listUsages(String resourceGroupName, String accountName)
      Get usages for the requested Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      Returns:
      usages for the requested Cognitive Services 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.

    • listUsagesWithResponse

      com.azure.core.http.rest.Response<UsageListResultInner> listUsagesWithResponse(String resourceGroupName, String accountName, String filter, com.azure.core.util.Context context)
      Get usages for the requested Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      filter - An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).
      context - The context to associate with this operation.
      Returns:
      usages for the requested Cognitive Services 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.

    • listModels

      com.azure.core.http.rest.PagedIterable<AccountModelInner> listModels(String resourceGroupName, String accountName)
      List available Models for the requested Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      Returns:
      the list of cognitive services accounts operation response 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.

    • listModels

      com.azure.core.http.rest.PagedIterable<AccountModelInner> listModels(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      List available Models for the requested Cognitive Services account.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      accountName - The name of Cognitive Services account.
      context - The context to associate with this operation.
      Returns:
      the list of cognitive services accounts operation response 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.