Conversion - Get

リファレンス

サービス:: Maps Creator

API バージョン:: 2.0

を使用して、指定したデータ変換をフェッチします。

Get API は HTTP GET 要求であり、呼び出し元は、変換サービスを使用して以前に送信された正常なデータ変換をフェッチできます。

GET https://{geography}.atlas.microsoft.com/conversions/{conversionId}?api-version=2.0

URI パラメーター

名前	/	必須	型	説明
conversionId	path	True	string	コンテンツの変換 ID。は `conversionId` 、成功した Conversion API 呼び出しから取得されている必要があります。
geography	path	True	string	このパラメーターは、Azure Maps Creator リソースの場所を指定します。有効な値は、us と eu です。
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	Conversion	指定した変換の詳細を返します。
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 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でAzure Maps アカウントを作成するとき、または 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

例

Get the details for one conversion operation

要求のサンプル

HTTP

GET https://us.atlas.microsoft.com/conversions/54398242-ea6c-1f31-4fa6-79b1ae0fc24d?api-version=2.0

応答のサンプル

状態コード:: 200

{
  "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",
  "udid": "31838736-8b84-11ea-bc55-0242ac130003",
  "created": "5/19/2020 9:00:00 AM +00:00",
  "description": "User provided description.",
  "ontology": "facility-2.0",
  "featureCounts": {
    "directoryInfo": 1,
    "level": 3,
    "facility": 1,
    "unit": 150,
    "category": 8,
    "areaElement": 0,
    "opening": 10
  }
}

定義

名前	説明
Conversion	変換要求の詳細情報。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

Conversion

変換要求の詳細情報。

名前	型	説明
conversionId	string	正常に完了した変換プロセスの成果物を表す一意の ID。
created	string	この変換の日時。
description	string	変換されるコンテンツの説明をユーザーが指定しました。
featureCounts	object	この変換における機能数の概要。
ontology	string	このデータセットのオントロジバージョン。
udid	string	この変換を作成するために提供されるコンテンツの一意の ID。

ErrorAdditionalInfo

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

次の方法で共有