你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Accounts interface

表示帐户的接口。

方法

createOrUpdate(string, string, MapsAccount, AccountsCreateOrUpdateOptionalParams)

创建或更新地图帐户。 Maps 帐户包含允许访问地图 REST API 的密钥。

delete(string, string, AccountsDeleteOptionalParams)

删除地图帐户。

get(string, string, AccountsGetOptionalParams)

获取地图帐户。

listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)

获取资源组中的所有 Maps 帐户

listBySubscription(AccountsListBySubscriptionOptionalParams)

获取订阅中的所有 Maps 帐户

listKeys(string, string, AccountsListKeysOptionalParams)

获取用于地图 API 的密钥。 密钥用于对地图 REST API 进行身份验证和授权访问。 一次只需要一个密钥;提供两个用于提供无缝密钥重新生成。

listSas(string, string, AccountSasParameters, AccountsListSasOptionalParams)

创建并列出帐户共享访问签名令牌。 使用此 SAS 令牌通过各种 Azure Maps SDK 向 Azure Maps REST API 进行身份验证。 作为创建 SAS 令牌的先决条件。

先决条件:

  1. 在帐户所在的同一 Azure 区域中创建或拥有现有用户分配的托管标识。
  2. 创建或更新与用户分配的托管标识相同的 Azure 区域 Azure 映射帐户。
regenerateKeys(string, string, MapsKeySpecification, AccountsRegenerateKeysOptionalParams)

重新生成用于 Maps API 的主密钥或辅助密钥。 旧密钥将立即停止工作。

update(string, string, MapsAccountUpdateParameters, AccountsUpdateOptionalParams)

更新地图帐户。 创建后只能更新参数的子集,例如 SKU、标记、属性。

方法详细信息

createOrUpdate(string, string, MapsAccount, AccountsCreateOrUpdateOptionalParams)

创建或更新地图帐户。 Maps 帐户包含允许访问地图 REST API 的密钥。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

accountName

string

地图帐户的名称。

mapsAccount
MapsAccount

地图帐户的新参数或更新的参数。

options
AccountsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<MapsAccount>

delete(string, string, AccountsDeleteOptionalParams)

删除地图帐户。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

accountName

string

地图帐户的名称。

options
AccountsDeleteOptionalParams

选项参数。

返回

Promise<void>

get(string, string, AccountsGetOptionalParams)

获取地图帐户。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

accountName

string

地图帐户的名称。

options
AccountsGetOptionalParams

选项参数。

返回

Promise<MapsAccount>

listByResourceGroup(string, AccountsListByResourceGroupOptionalParams)

获取资源组中的所有 Maps 帐户

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

返回

listBySubscription(AccountsListBySubscriptionOptionalParams)

获取订阅中的所有 Maps 帐户

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

参数

返回

listKeys(string, string, AccountsListKeysOptionalParams)

获取用于地图 API 的密钥。 密钥用于对地图 REST API 进行身份验证和授权访问。 一次只需要一个密钥;提供两个用于提供无缝密钥重新生成。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

accountName

string

地图帐户的名称。

options
AccountsListKeysOptionalParams

选项参数。

返回

Promise<MapsAccountKeys>

listSas(string, string, AccountSasParameters, AccountsListSasOptionalParams)

创建并列出帐户共享访问签名令牌。 使用此 SAS 令牌通过各种 Azure Maps SDK 向 Azure Maps REST API 进行身份验证。 作为创建 SAS 令牌的先决条件。

先决条件:

  1. 在帐户所在的同一 Azure 区域中创建或拥有现有用户分配的托管标识。
  2. 创建或更新与用户分配的托管标识相同的 Azure 区域 Azure 映射帐户。
function listSas(resourceGroupName: string, accountName: string, mapsAccountSasParameters: AccountSasParameters, options?: AccountsListSasOptionalParams): Promise<MapsAccountSasToken>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

accountName

string

地图帐户的名称。

mapsAccountSasParameters
AccountSasParameters

地图帐户的更新参数。

options
AccountsListSasOptionalParams

选项参数。

返回

regenerateKeys(string, string, MapsKeySpecification, AccountsRegenerateKeysOptionalParams)

重新生成用于 Maps API 的主密钥或辅助密钥。 旧密钥将立即停止工作。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

accountName

string

地图帐户的名称。

keySpecification
MapsKeySpecification

要重新生成的密钥:主密钥或辅助密钥。

options
AccountsRegenerateKeysOptionalParams

选项参数。

返回

Promise<MapsAccountKeys>

update(string, string, MapsAccountUpdateParameters, AccountsUpdateOptionalParams)

更新地图帐户。 创建后只能更新参数的子集,例如 SKU、标记、属性。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

accountName

string

地图帐户的名称。

mapsAccountUpdateParameters
MapsAccountUpdateParameters

地图帐户的更新参数。

options
AccountsUpdateOptionalParams

选项参数。

返回

Promise<MapsAccount>