Accounts interface

Interface representing a Accounts.

Methods

beginCreate(string, string, Account, AccountsCreateOptionalParams)

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.

beginCreateAndWait(string, string, Account, AccountsCreateOptionalParams)

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.

beginDelete(string, string, AccountsDeleteOptionalParams)

Deletes a Cognitive Services account from the resource group.

beginDeleteAndWait(string, string, AccountsDeleteOptionalParams)

Deletes a Cognitive Services account from the resource group.

beginUpdate(string, string, Account, AccountsUpdateOptionalParams)

Updates a Cognitive Services account

beginUpdateAndWait(string, string, Account, AccountsUpdateOptionalParams)

Updates a Cognitive Services account

get(string, string, AccountsGetOptionalParams)

Returns a Cognitive Services account specified by the parameters.

list(AccountsListOptionalParams)

Returns all the resources of a particular type belonging to a subscription.

listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)

Returns all the resources of a particular type belonging to a resource group

listKeys(string, string, AccountsListKeysOptionalParams)

Lists the account keys for the specified Cognitive Services account.

listModels(string, string, AccountsListModelsOptionalParams)

List available Models for the requested Cognitive Services account

listSkus(string, string, AccountsListSkusOptionalParams)

List available SKUs for the requested Cognitive Services account

listUsages(string, string, AccountsListUsagesOptionalParams)

Get usages for the requested Cognitive Services account

regenerateKey(string, string, KeyName, AccountsRegenerateKeyOptionalParams)

Regenerates the specified account key for the specified Cognitive Services account.

Method Details

beginCreate(string, string, Account, AccountsCreateOptionalParams)

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.

function beginCreate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Account>, Account>>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

account
Account

The parameters to provide for the created account.

options
AccountsCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Account>, Account>>

beginCreateAndWait(string, string, Account, AccountsCreateOptionalParams)

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.

function beginCreateAndWait(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOptionalParams): Promise<Account>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

account
Account

The parameters to provide for the created account.

options
AccountsCreateOptionalParams

The options parameters.

Returns

Promise<Account>

beginDelete(string, string, AccountsDeleteOptionalParams)

Deletes a Cognitive Services account from the resource group.

function beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options
AccountsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, AccountsDeleteOptionalParams)

Deletes a Cognitive Services account from the resource group.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options
AccountsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, Account, AccountsUpdateOptionalParams)

Updates a Cognitive Services account

function beginUpdate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Account>, Account>>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

account
Account

The parameters to provide for the created account.

options
AccountsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Account>, Account>>

beginUpdateAndWait(string, string, Account, AccountsUpdateOptionalParams)

Updates a Cognitive Services account

function beginUpdateAndWait(resourceGroupName: string, accountName: string, account: Account, options?: AccountsUpdateOptionalParams): Promise<Account>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

account
Account

The parameters to provide for the created account.

options
AccountsUpdateOptionalParams

The options parameters.

Returns

Promise<Account>

get(string, string, AccountsGetOptionalParams)

Returns a Cognitive Services account specified by the parameters.

function get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<Account>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options
AccountsGetOptionalParams

The options parameters.

Returns

Promise<Account>

list(AccountsListOptionalParams)

Returns all the resources of a particular type belonging to a subscription.

function list(options?: AccountsListOptionalParams): PagedAsyncIterableIterator<Account, Account[], PageSettings>

Parameters

options
AccountsListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)

Returns all the resources of a particular type belonging to a resource group

function listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Account, Account[], PageSettings>

Parameters

resourceGroupName

string

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

options
AccountsListByResourceGroupOptionalParams

The options parameters.

Returns

listKeys(string, string, AccountsListKeysOptionalParams)

Lists the account keys for the specified Cognitive Services account.

function listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<ApiKeys>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options
AccountsListKeysOptionalParams

The options parameters.

Returns

Promise<ApiKeys>

listModels(string, string, AccountsListModelsOptionalParams)

List available Models for the requested Cognitive Services account

function listModels(resourceGroupName: string, accountName: string, options?: AccountsListModelsOptionalParams): PagedAsyncIterableIterator<AccountModel, AccountModel[], PageSettings>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options
AccountsListModelsOptionalParams

The options parameters.

Returns

listSkus(string, string, AccountsListSkusOptionalParams)

List available SKUs for the requested Cognitive Services account

function listSkus(resourceGroupName: string, accountName: string, options?: AccountsListSkusOptionalParams): Promise<AccountSkuListResult>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options
AccountsListSkusOptionalParams

The options parameters.

Returns

listUsages(string, string, AccountsListUsagesOptionalParams)

Get usages for the requested Cognitive Services account

function listUsages(resourceGroupName: string, accountName: string, options?: AccountsListUsagesOptionalParams): Promise<UsageListResult>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

options
AccountsListUsagesOptionalParams

The options parameters.

Returns

Promise<UsageListResult>

regenerateKey(string, string, KeyName, AccountsRegenerateKeyOptionalParams)

Regenerates the specified account key for the specified Cognitive Services account.

function regenerateKey(resourceGroupName: string, accountName: string, keyName: KeyName, options?: AccountsRegenerateKeyOptionalParams): Promise<ApiKeys>

Parameters

resourceGroupName

string

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

accountName

string

The name of Cognitive Services account.

keyName
KeyName

key name to generate (Key1|Key2)

options
AccountsRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<ApiKeys>