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

Feature State - Update States

参考

Service:: Maps Creator

API Version:: 2.0

使用更新功能的状态。

注意

Azure Maps Creator 功能状态服务停用

Azure Maps Creator 功能状态服务现已弃用，将于 25 年 3 月 31 日停用。为避免服务中断，请在 25 月 31 日停止使用功能状态服务。有关 Creator 中的实时特征样式设置的信息，请参阅使用实时地图功能样式增强室内地图。

提交更新状态请求

Update States API 是一个PUT请求，允许用户更新给定状态集中指定功能的状态。

PUT https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}/featureStates/{featureId}?api-version=2.0

URI 参数

名称	在	必需	类型	说明
featureId	path	True	string	给定数据集中特征的 ID。如果数据集中不存在 featureId，则将返回错误的请求响应。
geography	path	True	string	此参数指定 Azure Maps Creator 资源所在的位置。有效值为 us 和 eu。
statesetId	path	True	string	创建的状态集 ID。
api-version	query	True	string	Azure Maps API 的版本号。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定要与Microsoft Entra ID安全模型结合使用的帐户。它表示Azure Maps帐户的唯一 ID，可从Azure Maps管理平面帐户 API 检索。若要在 Azure Maps 中使用Microsoft Entra ID安全性，请参阅以下文章以获取指导。

请求正文

名称	类型	说明
states	FeatureState[]	特征状态数组。

响应

名称	类型	说明
200 OK		功能状态已成功更新。
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

AADToken

这些是Microsoft Entra OAuth 2.0 流。与 Azure 基于角色的访问控制配对时，它可用于控制对Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限，以Azure Maps REST API。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一种解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问的Azure Maps资源。这可以从地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和Microsoft Entra ID配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 允许针对多个用例对应用程序进行基于配置的设置。

有关Microsoft 标识平台的详细信息，请参阅Microsoft 标识平台概述。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

这是在Azure 门户中使用 PowerShell、CLI、Azure SDK 或 REST API Create Azure Maps 帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问Azure Maps REST API，以便安全地存储密钥。

Type: apiKey
In: query

SAS Token

这是一个共享访问签名令牌，通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API，通过 Azure 管理平面在Azure Maps资源上列出 SAS 操作创建。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 Map 帐户资源上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

Type: apiKey
In: header

示例

Update the states of a feature

Sample Request

HTTP

PUT https://us.atlas.microsoft.com/featureStateSets/b24bdb73-1305-3212-1909-a428d937b64/featureStates/SPC4709?api-version=2.0

{
  "states": [
    {
      "keyName": "s1",
      "value": "true",
      "eventTimestamp": "2019-08-16 13:01"
    }
  ]
}

Sample Response

Status code:: 200

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
FeatureState	单特征状态模型。
FeatureStatesStructure	特征的特征状态模型。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

FeatureState

单特征状态模型。

名称	类型	说明
eventTimestamp	string	捕获功能状态时的有效时间戳。
keyName	string	功能状态 Keyname。允许的最大长度为 1000。
value	string	功能状态的值。类型应符合附加到 featurestate 的样式定义。字符串类型允许的最大长度为 1024。

FeatureStatesStructure

特征的特征状态模型。

名称	类型	说明
states	FeatureState[]	特征状态数组。