Route - Get Route Operations Status

非同期操作のステータスを操作IDで取得します。

GET {endpoint}/route/operations/{id}?api-version=2025-01-01

URI パラメーター

名前 / 必須 説明
endpoint
path True

string (uri)

Azure Mapsサービスのホストネーム。 Azureパブリッククラウドにはhttps://atlas.microsoft.comを使いましょう。 特定のAzure Maps地理やソブリンクラウドをターゲットにする場合は、Azure Maps地理的範囲を参照してください。

id
path True

string

minLength: 36
maxLength: 36
pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

非同期操作の実行依頼後にシステムが生成した一意の識別子。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

応答

名前 説明
200 OK

RouteOperation

要求は成功しました。

404 Not Found

MapsErrorResponse

サーバーは、要求されたリソースを見つけることができません。

Other Status Codes

MapsErrorResponse

予期しないエラー応答。

セキュリティ

AadToken

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

シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

Note

  • このセキュリティ定義 使用して、アプリケーションがアクセスを要求している 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

subscription-key

これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウント を作成 場合にプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。

パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。

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

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

型: apiKey
/: header

Retrieve the async matrix operation status

要求のサンプル

GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

応答のサンプル

{
  "createdAt": "2023-01-01T00:00:00Z",
  "kind": "RouteMatrix",
  "lastActionAt": "2023-01-01T00:05:00Z",
  "result": {
    "resultUrl": "https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01"
  },
  "status": "Completed"
}
{
  "error": {
    "code": "NotFound",
    "message": "Not Found: the requested resource could not be found."
  }
}

定義

名前 説明
CommonErrorDetail

エラーの詳細。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

MapsErrorDetail

エラーの詳細。

MapsErrorResponse

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

MapsInnerError

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

RouteOperation

このオブジェクトは、成功したGet Operationリクエストから返されます。

RouteOperationKindEnum

非同期操作の種類

RouteOperationResult

非同期操作の結果

StatusEnum

非同期操作の現在の状況。

CommonErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

CommonErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

MapsErrorDetail

エラーの詳細。

名前 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。

details

MapsErrorDetail[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。

innererror

MapsInnerError

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

message

string

エラーの人間が判読できる表現。

target

string

エラーのターゲット。

MapsErrorResponse

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

名前 説明
error

MapsErrorDetail

エラーの詳細。

MapsInnerError

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

名前 説明
code

string

エラー コード。

innererror

MapsInnerError

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

RouteOperation

このオブジェクトは、成功したGet Operationリクエストから返されます。

名前 説明
createdAt

string (date-time)

操作が作成されたタイムスタンプ。

error

CommonErrorDetail

エラーの詳細。

id

string

非同期操作の一意識別子。

kind

RouteOperationKindEnum

非同期操作の種類

lastActionAt

string (date-time)

操作状況が更新されたタイムスタンプ。

result

RouteOperationResult

非同期操作の結果

status

StatusEnum

非同期操作の現在の状況。

RouteOperationKindEnum

非同期操作の種類

説明
RouteMatrix

ルート マトリックス非同期ジョブ。

RouteOperationResult

非同期操作の結果

名前 説明
resultUrl

string (uri)

非同期操作の結果を得るURLは

StatusEnum

非同期操作の現在の状況。

説明
NotStarted

作戦はまだ始まっていない。

Running

作戦は進行中だ。

Completed

操作は正常に完了しました。

Failed

操作が失敗しました。