Feature State - Update States
機能の状態を更新するには、 を使用します。
注意
Azure Maps Creator Feature State サービスの廃止
Azure Maps Creator Feature State サービスは非推奨となり、3/31/25 に廃止されます。 サービスの中断を回避するには、3/31/25 までに Feature State サービスの使用を中止してください。 Creator のリアルタイムフィーチャスタイル設定の詳細については、「 リアルタイムマップフィーチャスタイルを使用して屋内マップを強化する」を参照してください。
更新状態要求を送信する
Update States
API は、PUT
ユーザーが特定の状態セット内の指定された機能の状態を更新できるようにする要求です。
PUT https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}/featureStates/{featureId}?api-version=2.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
feature
|
path | True |
string |
指定されたデータセット内の特徴の ID。 featureId がデータセットに存在しない場合は、Bad Request 応答が返されます。 |
geography
|
path | True |
string |
このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。 |
stateset
|
path | True |
string |
作成された stateset 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 |
特徴の状態配列。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
機能の状態は正常に更新されます。 |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権 Azure Mapsを付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
メモ
- このセキュリティ定義では、 ヘッダーを使用して、
x-ms-client-id
アプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。 これは、 Maps 管理 API から取得できます。
Authorization URL
は、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。
* Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
* Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
これは、Azure portalでAzure Maps アカウントをCreateするとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
公開されているアプリケーションの場合は、機密クライアント アプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
型:
apiKey
/:
header
例
Update the states of a feature
要求のサンプル
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"
}
]
}
応答のサンプル
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Feature |
単一の特徴状態モデル。 |
Feature |
特徴の特徴状態モデル。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
FeatureState
単一の特徴状態モデル。
名前 | 型 | 説明 |
---|---|---|
eventTimestamp |
string |
機能の状態がキャプチャされたときの有効なタイムスタンプ。 |
keyName |
string |
機能状態のキー名。 許容される最大の長さは 1,000 です。 |
value |
string |
特徴の状態の値。 型は、featurestate にアタッチされているスタイル定義に準拠している必要があります。 文字列型に使用できる最大長は 1024 です。 |
FeatureStatesStructure
特徴の特徴状態モデル。
名前 | 型 | 説明 |
---|---|---|
states |
特徴の状態配列。 |