AccountsOperations interface

Package:

@azure/arm-purview

Interface representing a Accounts operations.

Properties

addRootCollectionAdmin	Add the administrator for root collection associated with this account.
beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability	Checks if account name is available.
createOrUpdate	Creates or updates an account
delete	Deletes an account resource
get	Get an account
listByResourceGroup	List accounts in ResourceGroup
listBySubscription	List accounts in Subscription
listKeys	List the authorization keys associated with this account.
update	Updates an account

Property Details

addRootCollectionAdmin

Add the administrator for root collection associated with this account.

addRootCollectionAdmin: (resourceGroupName: string, accountName: string, collectionAdminUpdate: CollectionAdminUpdate, options?: AccountsAddRootCollectionAdminOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, collectionAdminUpdate: CollectionAdminUpdate, options?: AccountsAddRootCollectionAdminOptionalParams) => Promise<void>

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Account>, Account>>

Property Value

(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Account>, Account>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams) => Promise<Account>

Property Value

(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams) => Promise<Account>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Account>, Account>>

Property Value

(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Account>, Account>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams) => Promise<Account>

Property Value

(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams) => Promise<Account>

checkNameAvailability

Checks if account name is available.

checkNameAvailability: (checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: AccountsCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResult>

Property Value

(checkNameAvailabilityRequest: CheckNameAvailabilityRequest, options?: AccountsCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResult>

createOrUpdate

Creates or updates an account

createOrUpdate: (resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Account>, Account>

Property Value

(resourceGroupName: string, accountName: string, account: Account, options?: AccountsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Account>, Account>

delete

Deletes an account resource

delete: (resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get an account

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

Property Value

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

listByResourceGroup

List accounts in ResourceGroup

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

Property Value

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

listBySubscription

List accounts in Subscription

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

Property Value

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

listKeys

List the authorization keys associated with this account.

listKeys: (resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams) => Promise<AccessKeys>

Property Value

(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams) => Promise<AccessKeys>

update

Updates an account

update: (resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams) => PollerLike<OperationState<Account>, Account>

Property Value

(resourceGroupName: string, accountName: string, accountUpdateParameters: AccountUpdateParameters, options?: AccountsUpdateOptionalParams) => PollerLike<OperationState<Account>, Account>