Data Registry - Unregister
Azure Maps アカウントに登録されている Azure Storage アカウントに格納されているデータの登録を解除するには、 を使用します。
Unregister
API は、基になるコンテンツを Azure ストレージ アカウントから削除せずにデータ レジストリを削除する HTTP DELETE
要求です。
Azure Maps Geofencing Service で使用するために Register または Replace API を使用して以前に登録したジオフェンス ファイルの登録解除や、Azure Maps Creator Conversion Service で使用される DWG デザイン ファイルを含む圧縮 (ZIP) ファイルの登録解除などのシナリオで役立ちます。
データ レジストリ サービス エンドポイントは、Azure Maps アカウントのリージョンのスコープに制限されており、グローバル Azure Maps アカウントでは使用できません。
登録解除要求を送信する
データ レジストリの とudid
共に HTTP DELETE
要求を使用して登録を解除します。
応答の登録解除
データ レジストリが正常に削除された場合、要求は Unregister
HTTP '204 No Content' 応答を空の本文で返します。
DELETE https://{geography}.atlas.microsoft.com/dataRegistries/{udid}?api-version=2023-06-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
geography
|
path | True |
string |
このパラメーターは、Azure Maps アカウントの場所を指定します。 有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。 |
udid
|
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 セキュリティを使用するには、ガイダンスについては、次 の記事を 参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
204 No Content |
要求は |
|
Other Status Codes |
予期しないエラーが発生しました。 ヘッダー 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
例
Unregister a data registry without deleting the underlying contents
要求のサンプル
DELETE https://us.atlas.microsoft.com/dataRegistries/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2023-06-01
応答のサンプル
定義
名前 | 説明 |
---|---|
Maps |
エラーの詳細。 |
Maps |
失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。 |
Maps |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
MapsErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
MapsErrorResponse
失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラーの詳細。 |
MapsInnerError
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |