Routeset - Delete

リファレンス

Service:: Maps Creator

API Version:: 2022-09-01-preview

Creator を使用すると、Azure Maps API と SDK を使用して、プライベート屋内マップデータに基づいてアプリケーションを開発できます。 Azure Maps Creator の概念とツールの概要については、屋内マップの Creator に関する記事を参照してください。

この API を使用すると、呼び出し元は既存のルートセットを削除できます。ルートセットが不要になった場合は、この API を使用します。

削除要求の送信

ルートセットを削除するには、削除する DELETE ルートセットのを routesetId 使用して要求を送信します。

DELETE https://{geography}.atlas.microsoft.com/routesets/{routesetId}?api-version=2022-09-01-preview

URI パラメーター

Name	In	Required	Type	Description
geography	path	True	string	このパラメーターは、Azure Maps Creator リソースの場所を指定します。有効な値は、us と eu です。
routesetId	path	True	string	削除するルートセットの ID。
api-version	query	True	string	Azure Maps API のバージョン番号。

要求ヘッダー

Name	Required	Type	Description
x-ms-client-id		string	Azure AD セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure Mapsで Azure AD セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

Name	Type	Description
204 No Content		Routeset 削除要求が正常に完了しました。
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 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 と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
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 にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

例

Delete an existing routeset

Sample Request

HTTP

DELETE https://us.atlas.microsoft.com/routesets/[routeset-Id]?api-version=2022-09-01-preview

Sample Response

Status code:: 204

定義

ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

ErrorAdditionalInfo

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

Name	Type	Description
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

Name	Type	Description
error	ErrorDetail	error オブジェクト。