Share via

DefaultAccounts interface

  • Reference
Package:
@azure/arm-purview

Interface representing a DefaultAccounts.

Methods

get(string, string, DefaultAccountsGetOptionalParams)

Get the default account for the scope.
remove(string, string, DefaultAccountsRemoveOptionalParams)

Removes the default account from the scope.
set(DefaultAccountPayload, DefaultAccountsSetModelOptionalParams)

Sets the default account for the scope.

Method Details

get(string, string, DefaultAccountsGetOptionalParams)

Get the default account for the scope.

function get(scopeTenantId: string, scopeType: string, options?: DefaultAccountsGetOptionalParams): Promise<DefaultAccountPayload>

Parameters

scopeTenantId

string

The tenant ID.

scopeType

string

The scope for the default account.

options
DefaultAccountsGetOptionalParams

The options parameters.

Returns

Promise<DefaultAccountPayload>

remove(string, string, DefaultAccountsRemoveOptionalParams)

Removes the default account from the scope.

function remove(scopeTenantId: string, scopeType: string, options?: DefaultAccountsRemoveOptionalParams): Promise<void>

Parameters

scopeTenantId

string

The tenant ID.

scopeType

string

The scope for the default account.

options
DefaultAccountsRemoveOptionalParams

The options parameters.

Returns

Promise<void>

set(DefaultAccountPayload, DefaultAccountsSetModelOptionalParams)

Sets the default account for the scope.

function set(defaultAccountPayload: DefaultAccountPayload, options?: DefaultAccountsSetModelOptionalParams): Promise<DefaultAccountPayload>

Parameters

defaultAccountPayload
DefaultAccountPayload

The payload containing the default account information and the scope.

options
DefaultAccountsSetModelOptionalParams

The options parameters.

Returns

Promise<DefaultAccountPayload>