Dataset - Get Operation
データセット作成プロセスの状態を確認するために使用します。
注
Azure Maps Creator の提供終了
Azure Maps Creator のフロア ガイド サービスは現在非推奨となっており、2025 年 9 月 30 日付けで提供が終了します。 詳細については、Azure Maps Creator のサポート終了のお知らせを参照してください。
Get Operation API は、データセット作成プロセスの状態を確認し、GET 値を取得するために使用される HTTP datasetId 要求です。
操作要求の送信
データセット操作の現在の進行状況を表示するには、GET 要求を使用します。パスを指定した operationId は、操作を表す ID です。
操作の応答
進行中は、200-OK http 状態コードが追加のヘッダーなしで返されます。 操作が成功すると、Resource-Location ヘッダーを含む 200-OK http 状態コードが返されます。
GET https://{geography}.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
geography
|
path | True |
string |
このパラメーターは、Azure Maps Creator リソースが配置されている場所を指定します。 有効な値は us と eu です。 |
|
operation
|
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 セキュリティを使用するには、ガイダンス 次の |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
操作が実行中または完了しています。 操作が成功した場合は、Resource-Location ヘッダーを使用して結果へのパスを取得します。 ヘッダー Resource-Location: string |
|
| Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは、Microsoft Entra OAuth 2.0 フロー
シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。
注記
- このセキュリティ定義 使用して、アプリケーションがアクセスを要求している 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 で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウント を作成 場合にプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。
このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。
型:
apiKey
/:
header
例
| Get the status of an operation which has finished successfully |
| Get the status of an operation which is still running |
Get the status of an operation which has finished successfully
要求のサンプル
GET https://us.atlas.microsoft.com/datasets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
応答のサンプル
Resource-Location: https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-20T22:43:14.9401559+00:00",
"status": "Succeeded"
}Get the status of an operation which is still running
要求のサンプル
GET https://us.atlas.microsoft.com/datasets/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0
応答のサンプル
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-23T19:14:03.2452596+00:00",
"status": "Running"
}定義
| 名前 | 説明 |
|---|---|
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Long |
Long-Running Operations API の応答モデル。 |
|
Lro |
要求の状態。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
LongRunningOperationResult
Long-Running Operations API の応答モデル。
| 名前 | 型 | 説明 |
|---|---|---|
| created |
string (date-time) |
作成されたタイムスタンプ。 |
| error |
エラーの詳細。 |
|
| operationId |
string |
この実行時間の長い操作の ID。 |
| status |
要求の状態。 |
|
| warning |
エラーの詳細。 |
LroStatus
要求の状態。
| 値 | 説明 |
|---|---|
| Failed |
要求に 1 つ以上のエラーがあります。 |
| NotStarted |
要求はまだ処理を開始していません。 |
| Running |
要求が処理を開始しました。 |
| Succeeded |
要求が正常に完了しました。 |