Conversion - List

リファレンス

サービス:: Maps Creator

API バージョン:: 2.0

を使用して、データ変換の一覧を取得します。

List API は HTTP GET 要求であり、呼び出し元は、Conversion API を使用して以前に送信されたすべての成功したデータ変換の一覧をフェッチできます。

リスト要求の送信

成功したすべての変換を一覧表示するには、追加のパラメーターを含まない要求を GET 発行します。

データ応答の一覧表示

変換リスト API は、すべての変換の詳細の完全な一覧を形式で json 返します。

2 つの成功した変換要求の詳細を返す応答の例を次に示します。

{
    "conversions": 
    [
        {
            "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.",
            "featureCounts": {
                "DIR": 1,
                "LVL": 3,
                "FCL": 1,
                "UNIT": 150,
                "CTG": 8,
                "AEL": 0,
                "OPN": 10
            }
        },
        {
            "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",
            "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",
            "created": "5/19/2020 9:00:00 AM +00:00",
            "description": "User provided description.",
            "featureCounts": {
                "DIR": 1,
                "LVL": 3,
                "FCL": 1,
                "UNIT": 150,
                "CTG": 8,
                "AEL": 0,
                "OPN": 10
            }
        }
    ]
}

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

URI パラメーター

名前	/	必須	型	説明
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	ConversionListResult	要求の一覧表示が正常に完了しました。
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

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 アカウントを作成するとき、または 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

例

Returns a list of all the data processed by the Conversion Service for the account

要求のサンプル

HTTP

GET https://us.atlas.microsoft.com/conversions?api-version=2.0

応答のサンプル

状態コード:: 200

{
  "conversions": [
    {
      "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
      }
    },
    {
      "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003",
      "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039",
      "created": "5/20/2020 11:30:00 AM +00:00",
      "description": "User provided description.",
      "ontology": "facility-2.0",
      "featureCounts": {
        "structure": 614,
        "directoryInfo": 1,
        "level": 2,
        "facility": 1,
        "unit": 461,
        "category": 30,
        "verticalPenetration": 8,
        "opening": 270
      }
    }
  ]
}

定義

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

Conversion

変換要求の詳細情報。

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

ConversionListResult

変換リスト API の応答モデル。

名前	型	説明
conversions	Conversion[]	以前に送信されたすべての変換要求の一覧。
nextLink	string	存在する場合は、データの次のページの場所。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

次の方法で共有