Package com.azure.resourcemanager.cognitiveservices.models

Interface Accounts

public interface Accounts

Resource collection API of Accounts.

Method Summary

Modifier and Type	Method	Description
Account.DefinitionStages.Blank	define(String name)	Begins definition for a new Account resource.
void	delete(String resourceGroupName, String accountName, com.azure.core.util.Context context)	Deletes a Cognitive Services account from the resource group.
void	deleteById(String id)	Deletes a Cognitive Services account from the resource group.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a Cognitive Services account from the resource group.
void	deleteByResourceGroup(String resourceGroupName, String accountName)	Deletes a Cognitive Services account from the resource group.
Account	getById(String id)	Returns a Cognitive Services account specified by the parameters.
com.azure.core.http.rest.Response<Account>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Returns a Cognitive Services account specified by the parameters.
Account	getByResourceGroup(String resourceGroupName, String accountName)	Returns a Cognitive Services account specified by the parameters.
com.azure.core.http.rest.Response<Account>	getByResourceGroupWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)	Returns a Cognitive Services account specified by the parameters.
com.azure.core.http.rest.PagedIterable<Account>	list()	Returns all the resources of a particular type belonging to a subscription.
com.azure.core.http.rest.PagedIterable<Account>	list(com.azure.core.util.Context context)	Returns all the resources of a particular type belonging to a subscription.
com.azure.core.http.rest.PagedIterable<Account>	listByResourceGroup(String resourceGroupName)	Returns all the resources of a particular type belonging to a resource group.
com.azure.core.http.rest.PagedIterable<Account>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Returns all the resources of a particular type belonging to a resource group.
ApiKeys	listKeys(String resourceGroupName, String accountName)	Lists the account keys for the specified Cognitive Services account.
com.azure.core.http.rest.Response<ApiKeys>	listKeysWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)	Lists the account keys for the specified Cognitive Services account.
com.azure.core.http.rest.PagedIterable<AccountModel>	listModels(String resourceGroupName, String accountName)	List available Models for the requested Cognitive Services account.
com.azure.core.http.rest.PagedIterable<AccountModel>	listModels(String resourceGroupName, String accountName, com.azure.core.util.Context context)	List available Models for the requested Cognitive Services account.
AccountSkuListResult	listSkus(String resourceGroupName, String accountName)	List available SKUs for the requested Cognitive Services account.
com.azure.core.http.rest.Response<AccountSkuListResult>	listSkusWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)	List available SKUs for the requested Cognitive Services account.
UsageListResult	listUsages(String resourceGroupName, String accountName)	Get usages for the requested Cognitive Services account.
com.azure.core.http.rest.Response<UsageListResult>	listUsagesWithResponse(String resourceGroupName, String accountName, String filter, com.azure.core.util.Context context)	Get usages for the requested Cognitive Services account.
ApiKeys	regenerateKey(String resourceGroupName, String accountName, RegenerateKeyParameters parameters)	Regenerates the specified account key for the specified Cognitive Services account.
com.azure.core.http.rest.Response<ApiKeys>	regenerateKeyWithResponse(String resourceGroupName, String accountName, RegenerateKeyParameters parameters, com.azure.core.util.Context context)	Regenerates the specified account key for the specified Cognitive Services account.

Method Detail

deleteByResourceGroup

void deleteByResourceGroup(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

Account 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<Account> 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<Account> 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<Account> 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<Account> 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<Account> 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

ApiKeys 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<ApiKeys> 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

ApiKeys 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<ApiKeys> 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

AccountSkuListResult 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<AccountSkuListResult> 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

UsageListResult 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<UsageListResult> 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<AccountModel> 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<AccountModel> 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.

getById

Account getById(String id)

Returns a Cognitive Services account specified by the parameters.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

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

Returns a Cognitive Services account specified by the parameters.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Deletes a Cognitive Services account from the resource group.

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 a Cognitive Services account from the resource group.

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.