Package version:

Interface Accounts

Interface representing a Accounts.

Hierarchy

Accounts

Index

Methods

createOrUpdate delete get listByResourceGroup listBySubscription listKeys listSas regenerateKeys update

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, accountName: string, mapsAccount: MapsAccount, options?: AccountsCreateOrUpdateOptionalParams): Promise<MapsAccount>
Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.
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.
- Optional options: AccountsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<MapsAccount>
- Defined in operationsInterfaces/accounts.ts:59

delete

delete(resourceGroupName: string, accountName: string, options?: AccountsDeleteOptionalParams): Promise<void>
Delete a Maps Account.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The name of the Maps Account.
- Optional options: AccountsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/accounts.ts:85

get

get(resourceGroupName: string, accountName: string, options?: AccountsGetOptionalParams): Promise<MapsAccount>
Get a Maps Account.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The name of the Maps Account.
- Optional options: AccountsGetOptionalParams
  
  The options parameters.
Returns Promise<MapsAccount>
- Defined in operationsInterfaces/accounts.ts:96

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<MapsAccount>
Get all Maps Accounts in a Resource Group
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: AccountsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MapsAccount>
- Defined in operationsInterfaces/accounts.ts:40

listBySubscription

listBySubscription(options?: AccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<MapsAccount>
Get all Maps Accounts in a Subscription
Parameters
- Optional options: AccountsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MapsAccount>
- Defined in operationsInterfaces/accounts.ts:48

listKeys

listKeys(resourceGroupName: string, accountName: string, options?: AccountsListKeysOptionalParams): Promise<MapsAccountKeys>
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.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  The name of the Maps Account.
- Optional options: AccountsListKeysOptionalParams
  
  The options parameters.
Returns Promise<MapsAccountKeys>
- Defined in operationsInterfaces/accounts.ts:129

listSas

listSas(resourceGroupName: string, accountName: string, mapsAccountSasParameters: AccountSasParameters, options?: AccountsListSasOptionalParams): Promise<MapsAccountSasToken>
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.
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.
- Optional options: AccountsListSasOptionalParams
  
  The options parameters.
Returns Promise<MapsAccountSasToken>
- Defined in operationsInterfaces/accounts.ts:115

regenerateKeys

regenerateKeys(resourceGroupName: string, accountName: string, keySpecification: MapsKeySpecification, options?: AccountsRegenerateKeysOptionalParams): Promise<MapsAccountKeys>
Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.
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.
- Optional options: AccountsRegenerateKeysOptionalParams
  
  The options parameters.
Returns Promise<MapsAccountKeys>
- Defined in operationsInterfaces/accounts.ts:142

update

update(resourceGroupName: string, accountName: string, mapsAccountUpdateParameters: MapsAccountUpdateParameters, options?: AccountsUpdateOptionalParams): Promise<MapsAccount>
Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.
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.
- Optional options: AccountsUpdateOptionalParams
  
  The options parameters.
Returns Promise<MapsAccount>
- Defined in operationsInterfaces/accounts.ts:73

Interface Accounts

Hierarchy

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

accountName: string

mapsAccount: MapsAccount

Optional options: AccountsCreateOrUpdateOptionalParams

Returns Promise<MapsAccount>

delete

Parameters

resourceGroupName: string

accountName: string

Optional options: AccountsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

accountName: string

Optional options: AccountsGetOptionalParams

Returns Promise<MapsAccount>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: AccountsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<MapsAccount>

listBySubscription

Parameters

Optional options: AccountsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<MapsAccount>

listKeys

Parameters

resourceGroupName: string

accountName: string

Optional options: AccountsListKeysOptionalParams

Returns Promise<MapsAccountKeys>

listSas

Parameters

resourceGroupName: string

accountName: string

mapsAccountSasParameters: AccountSasParameters

Optional options: AccountsListSasOptionalParams

Returns Promise<MapsAccountSasToken>

regenerateKeys

Parameters

resourceGroupName: string

accountName: string

keySpecification: MapsKeySpecification

Optional options: AccountsRegenerateKeysOptionalParams

Returns Promise<MapsAccountKeys>

update

Parameters

resourceGroupName: string

accountName: string

mapsAccountUpdateParameters: MapsAccountUpdateParameters

Optional options: AccountsUpdateOptionalParams

Returns Promise<MapsAccount>

Settings

Member Visibility

Theme

`Optional` options: AccountsCreateOrUpdateOptionalParams

`Optional` options: AccountsDeleteOptionalParams

`Optional` options: AccountsGetOptionalParams

`Optional` options: AccountsListByResourceGroupOptionalParams

`Optional` options: AccountsListBySubscriptionOptionalParams

`Optional` options: AccountsListKeysOptionalParams

`Optional` options: AccountsListSasOptionalParams

`Optional` options: AccountsRegenerateKeysOptionalParams

`Optional` options: AccountsUpdateOptionalParams