Accounts interface
Interface representing a Accounts.
Methods
Method Details
addRootCollectionAdmin(string, string, CollectionAdminUpdate, AccountsAddRootCollectionAdminOptionalParams)
Add the administrator for root collection associated with this account.
function addRootCollectionAdmin(resourceGroupName: string, accountName: string, collectionAdminUpdate: CollectionAdminUpdate, options?: AccountsAddRootCollectionAdminOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- collectionAdminUpdate
- CollectionAdminUpdate
The collection admin update payload.
The options parameters.
Returns
Promise<void>
beginCreateOrUpdate(string, string, Account, AccountsCreateOrUpdateOptionalParams)
Creates or updates an account
function beginCreateOrUpdate(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Account>, Account>>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- account
- Account
The account.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Account>, Account>>
beginCreateOrUpdateAndWait(string, string, Account, AccountsCreateOrUpdateOptionalParams)
Creates or updates an account
function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams): Promise<Account>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- account
- Account
The account.
The options parameters.
Returns
Promise<Account>
beginDelete(string, string, AccountsDeleteOptionalParams)
Deletes an account resource
function beginDelete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- options
- AccountsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, AccountsDeleteOptionalParams)
Deletes an account resource
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- options
- AccountsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, AccountUpdateParameters, AccountsUpdateOptionalParams)
Updates an account
function beginUpdate(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<PollerLike<PollOperationState<Account>, Account>>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- accountUpdateParameters
- AccountUpdateParameters
The account update parameters.
- options
- AccountsUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Account>, Account>>
beginUpdateAndWait(string, string, AccountUpdateParameters, AccountsUpdateOptionalParams)
Updates an account
function beginUpdateAndWait(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<Account>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- accountUpdateParameters
- AccountUpdateParameters
The account update parameters.
- options
- AccountsUpdateOptionalParams
The options parameters.
Returns
Promise<Account>
checkNameAvailability(CheckNameAvailabilityRequest, AccountsCheckNameAvailabilityOptionalParams)
Checks if account name is available.
function checkNameAvailability(checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: AccountsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>Parameters
- checkNameAvailabilityRequest
- CheckNameAvailabilityRequest
The check name availability request.
The options parameters.
Returns
Promise<CheckNameAvailabilityResult>
get(string, string, AccountsGetOptionalParams)
Get an account
function get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<Account>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- options
- AccountsGetOptionalParams
The options parameters.
Returns
Promise<Account>
listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)
List accounts in ResourceGroup
function listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Account, Account[], PageSettings>Parameters
- resourceGroupName
-
string
The resource group name.
The options parameters.
Returns
listBySubscription(AccountsListBySubscriptionOptionalParams)
List accounts in Subscription
function listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Account, Account[], PageSettings>Parameters
The options parameters.
Returns
listKeys(string, string, AccountsListKeysOptionalParams)
List the authorization keys associated with this account.
function listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<AccessKeys>Parameters
- resourceGroupName
-
string
The resource group name.
- accountName
-
string
The name of the account.
- options
- AccountsListKeysOptionalParams
The options parameters.
Returns
Promise<AccessKeys>