Data Registry - Get Operation

リファレンス

サービス:: Maps

API バージョン:: 2023-06-01

を使用して、データレジスタまたは置換要求の状態を確認します。
Get Operation API は、データレジスタの状態を取得するために使用される HTTP GET 要求です。または、キーの値Operation-Locationとしてレジスタまたは置換応答のヘッダーに返される置換要求です。進行中は、HTTP 200 OK 応答がヘッダーと共 Retry-After に返され、その後に完了した後に追加のヘッダーのない HTTP 200 OK が返されます。

データレジストリサービスエンドポイントは、Azure Maps アカウントのリージョンのスコープに制限されており、グローバル Azure Maps アカウントでは使用できません。

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01

URI パラメーター

名前 / 必須型説明

名前	/	必須	型	説明
geography	path	True	string	このパラメーターは、Azure Maps アカウントの場所を指定します。有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。
operationId	path	True	string	データレジスタ要求の状態のクエリに使用される ID。正規表現パターン: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
api-version	query	True	string	Azure Maps API のバージョン番号。

geography

path

True

string

このパラメーターは、Azure Maps アカウントの場所を指定します。有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。

operationId

path

True

string

データレジスタ要求の状態のクエリに使用される ID。

正規表現パターン: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

api-version

query

True

string

Azure Maps API のバージョン番号。

応答

名前	型	説明
200 OK	LongRunningOperationResult	実行時間の長い操作の状態。ヘッダー Retry-After: integer
Other Status Codes	MapsErrorResponse	予期しないエラーが発生しました。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

LongRunningOperationResult

実行時間の長い操作の状態。

ヘッダー

Retry-After: integer

Other Status Codes

MapsErrorResponse

予期しないエラーが発生しました。

ヘッダー

x-ms-error-code: string

セキュリティ

AADToken

これらは Microsoft Entra OAuth 2.0 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の 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、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介して Azure Maps リソースを作成するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスする権限が与えられている。つまり、これらは現在、発行対象のアカウントのマスターキーとして扱うことができます。

公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。

型: apiKey
/: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して、Azure 管理プレーンを介して Azure Maps リソースの SAS の一覧表示操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

型: apiKey
/: header

例

Get the status of an operation that failed

Get the status of an operation that finished successfully

Get the status of an operation that is still running

Get the status of an operation that failed

要求のサンプル

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

応答のサンプル

状態コード:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

要求のサンプル

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

応答のサンプル

状態コード:: 200

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

要求のサンプル

HTTP

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

応答のサンプル

状態コード:: 200

Retry-After: 10

{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

定義

名前	説明
LongRunningOperationResult	実行時間の長い操作の応答モデル。
LongRunningOperationStatus	実行時間の長い操作の状態。
MapsErrorDetail	エラーの詳細。
MapsErrorResponse	失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。
MapsInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

LongRunningOperationResult

実行時間の長い操作の応答モデル。

名前	型	説明
error	MapsErrorDetail	エラーの詳細。
id	string	operationId
status	LongRunningOperationStatus	実行時間の長い操作の状態。

LongRunningOperationStatus

実行時間の長い操作の状態。

名前	型	説明
Completed	string	要求は正常に完了しました。
Failed	string	要求に 1 つ以上のエラーがあります。
Running	string	要求は現在処理中です。

MapsErrorDetail

エラーの詳細。

名前	型	説明
code	string	サーバー定義のエラーコードのセットの 1 つ。
details	MapsErrorDetail[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	MapsInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

MapsErrorResponse

失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。

名前	型	説明
error	MapsErrorDetail	エラーの詳細。

MapsInnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

名前	型	説明
code	string	エラーコード。
innererror	MapsInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

次の方法で共有

Data Registry - Get Operation

URI パラメーター

応答

セキュリティ

AADToken

メモ

スコープ

subscription-key

SAS Token

例

Get the status of an operation that failed

要求のサンプル

応答のサンプル

Get the status of an operation that finished successfully

要求のサンプル

応答のサンプル

Get the status of an operation that is still running

要求のサンプル

応答のサンプル

定義

LongRunningOperationResult

LongRunningOperationStatus

MapsErrorDetail

MapsErrorResponse

MapsInnerError

その他のリソース