Share via


Accounts interface

Interface representing a Accounts.

Method Details

beginCreate(string, string, Account, AccountsCreateOptionalParams)

Creates or updates Account.

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

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

account
Account

Account details.

options
AccountsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Account>, Account>>

beginCreateAndWait(string, string, Account, AccountsCreateOptionalParams)

Creates or updates Account.

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

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

account
Account

Account details.

options
AccountsCreateOptionalParams

The options parameters.

Returns

Promise<Account>

beginDelete(string, string, AccountsDeleteOptionalParams)

Deletes account.

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

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

options
AccountsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, AccountsDeleteOptionalParams)

Deletes account.

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

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

options
AccountsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, AccountUpdate, AccountsUpdateOptionalParams)

Updates account's patchable properties

function beginUpdate(resourceGroupName: string, accountName: string, accountUpdatePayload: AccountUpdate, options?: AccountsUpdateOptionalParams): Promise<PollerLike<PollOperationState<Account>, Account>>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

accountUpdatePayload
AccountUpdate

Updated Account.

options
AccountsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Account>, Account>>

beginUpdateAndWait(string, string, AccountUpdate, AccountsUpdateOptionalParams)

Updates account's patchable properties

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

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

accountUpdatePayload
AccountUpdate

Updated Account.

options
AccountsUpdateOptionalParams

The options parameters.

Returns

Promise<Account>

get(string, string, AccountsGetOptionalParams)

Returns account details for the given account name.

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

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

options
AccountsGetOptionalParams

The options parameters.

Returns

Promise<Account>

head(string, string, AccountsHeadOptionalParams)

Checks whether account exists.

function head(resourceGroupName: string, accountName: string, options?: AccountsHeadOptionalParams): Promise<AccountsHeadResponse>

Parameters

resourceGroupName

string

The resource group name.

accountName

string

Account name.

options
AccountsHeadOptionalParams

The options parameters.

Returns

listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)

Returns list of Accounts.

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

Parameters

resourceGroupName

string

The resource group name.

options
AccountsListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(AccountsListBySubscriptionOptionalParams)

Returns list of Accounts.

function listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Account, Account[], PageSettings>

Parameters

options
AccountsListBySubscriptionOptionalParams

The options parameters.

Returns