Accounts interface

Package:

@azure/arm-maps

Interface representing a Accounts.

Methods

createOrUpdate(string, string, MapsAccount, AccountsCreateOrUpdateOptionalParams)	Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.
delete(string, string, AccountsDeleteOptionalParams)	Delete a Maps Account.
get(string, string, AccountsGetOptionalParams)	Get a Maps Account.
listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)	Get all Maps Accounts in a Resource Group
listBySubscription(AccountsListBySubscriptionOptionalParams)	Get all Maps Accounts in a Subscription
listKeys(string, string, AccountsListKeysOptionalParams)	Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.
listSas(string, string, AccountSasParameters, AccountsListSasOptionalParams)	Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token. Prerequisites: Create or have an existing User Assigned Managed Identity in the same Azure region as the account. Create or update an Azure Map account with the same Azure region as the User Assigned Managed Identity is placed.
regenerateKeys(string, string, MapsKeySpecification, AccountsRegenerateKeysOptionalParams)	Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.
update(string, string, MapsAccountUpdateParameters, AccountsUpdateOptionalParams)	Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.

Method Details

createOrUpdate(string, string, MapsAccount, AccountsCreateOrUpdateOptionalParams)

Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.

function createOrUpdate(resourceGroupName: string, accountName: string, mapsAccount: MapsAccount, options?: AccountsCreateOrUpdateOptionalParams): Promise<MapsAccount>

Parameters

resourceGroupName

string

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

accountName

string

The name of the Maps Account.

mapsAccount

MapsAccount

The new or updated parameters for the Maps Account.

options

AccountsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<MapsAccount>

delete(string, string, AccountsDeleteOptionalParams)

Delete a Maps Account.

function delete(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 the Maps Account.

options

AccountsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, AccountsGetOptionalParams)

Get a Maps Account.

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

Parameters

resourceGroupName

string

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

accountName

string

The name of the Maps Account.

options

AccountsGetOptionalParams

The options parameters.

Returns

Promise<MapsAccount>

listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)

Get all Maps Accounts in a Resource Group

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

Parameters

resourceGroupName

string

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

options

AccountsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MapsAccount, MapsAccount[], PageSettings>

listBySubscription(AccountsListBySubscriptionOptionalParams)

Get all Maps Accounts in a Subscription

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

Parameters

options

AccountsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MapsAccount, MapsAccount[], PageSettings>

listKeys(string, string, AccountsListKeysOptionalParams)

Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

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

Parameters

resourceGroupName

string

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

accountName

string

The name of the Maps Account.

options

AccountsListKeysOptionalParams

The options parameters.

Returns

Promise<MapsAccountKeys>

listSas(string, string, AccountSasParameters, AccountsListSasOptionalParams)

Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token.

Prerequisites:

1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account.
2. Create or update an Azure Map account with the same Azure region as the User Assigned Managed Identity is placed.

function listSas(resourceGroupName: string, accountName: string, mapsAccountSasParameters: AccountSasParameters, options?: AccountsListSasOptionalParams): Promise<MapsAccountSasToken>

Parameters

resourceGroupName

string

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

accountName

string

The name of the Maps Account.

mapsAccountSasParameters

AccountSasParameters

The updated parameters for the Maps Account.

options

AccountsListSasOptionalParams

The options parameters.

Returns

Promise<MapsAccountSasToken>

regenerateKeys(string, string, MapsKeySpecification, AccountsRegenerateKeysOptionalParams)

Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.

function regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options?: AccountsRegenerateKeysOptionalParams): Promise<MapsAccountKeys>

Parameters

resourceGroupName

string

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

accountName

string

The name of the Maps Account.

keySpecification

MapsKeySpecification

Which key to regenerate: primary or secondary.

options

AccountsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<MapsAccountKeys>

update(string, string, MapsAccountUpdateParameters, AccountsUpdateOptionalParams)

Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.

function update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<MapsAccount>

Parameters

resourceGroupName

string

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

accountName

string

The name of the Maps Account.

mapsAccountUpdateParameters

MapsAccountUpdateParameters

The updated parameters for the Maps Account.

options

AccountsUpdateOptionalParams

The options parameters.

Returns

Promise<MapsAccount>