azure-maps-rest package
Azure Maps Web SDK Service Module service retirement. Azure Maps Web SDK 服務模組現已棄用，將於 2026/9/30 正式退休。 為避免服務中斷，我們建議於 2026/9/30 前遷移至 Azure Maps JavaScript REST SDK。 請依照我們的 指示 遷移至 Azure Maps JavaScript REST SDK。
類別
| Aborter |
中止實例實作 AbortSignal 介面，可以中止 HTTP 請求。
對於現有的實例中止器：
|
| CarShareGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| ClosestPointGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| Credential |
Credential 是一個用於 Azure Maps HTTP 請求簽署的抽象類別。 此類別會裝載一個 credentialPolicyCreator Factory，其會產生 CredentialPolicy。 |
| CredentialPolicy |
在傳送之前，用來簽署 HTTP（S） 要求的認證原則。 這是抽象類。 |
| GeofenceGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| LoggingPolicyFactory |
LoggingPolicyFactory 是一個工廠類別，協助產生 LoggingPolicy 物件。 |
| MapControlCredential |
MapControlCredential 用於與實 |
| MapControlCredentialPolicy |
MapControlCredentialPolicy 是一種用於從實 |
| MapsURL |
MapsURL 代表 SearchURL、RouteURL 等的基底 URL 類別。 |
| MetroAreaGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| NearbyTransitGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| Pipeline |
一個包含 HTTP 請求策略的管線類別。 你可以透過呼叫 MapsURL.newPipeline（） 來建立預設管線。 或者你也可以透過管線的建構者建立一個包含你自己政策的管線。 在實作自訂管線前，請參考 MapsURL.newPipeline（） 及提供的政策作為參考。 |
| PointInPolygonGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| RealTimeArrivalsGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| RenderURL |
RenderURL 代表 Azure Maps 渲染操作的 URL。 |
| RetryPolicyFactory |
RetryPolicyFactory 是一個工廠類別，協助產生 RetryPolicy 物件。 |
| RouteGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| RouteRangeGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| RouteURL |
RouteURL 代表 Azure Maps 路由操作的 URL。 |
| SasCredential |
SasCredential 是一種用來產生 SasCredentialPolicy 的憑證。 透過將新的標記字串值設為標記屬性來更新代幣。 範例 const sasCredential = new SasCredential（“token”）;const pipeline = MapsURL.newPipeline（sasCredential）; const searchURL = new SearchURL（pipeline）; 設定一個計時器來刷新令牌 const timerID = setInterval（（） => { // 透過存取公開的 sasCredential.token sasCredential.token 來更新令牌 sasCredential.token = “updatedToken”;// 警告：計時器必須手動停止！ 若 （shouldStop（）） { clearInterval（timerID）; } }， 60 * 60 * 1000，則禁止 sasCredential 的 GC）;設定一個時間間隔，讓你的代幣到期 |
| SasCredentialPolicy |
SasCredentialPolicy 是一種用來以令牌簽署 HTTP 請求的政策。 例如 JWT SAS 代幣。 |
| SearchGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| SearchPolygonGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| SearchReverseGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| SearchURL |
SearchURL 代表 Azure Maps 搜尋操作的 URL。 |
| SpatialURL |
SpatialURL 代表 Azure Maps 空間操作的 URL。 |
| SubscriptionKeyCredential |
SubscriptionKeyCredential for account key authorization of Azure Maps service. |
| SubscriptionKeyCredentialPolicy |
SubscriptionKeyCredentialPolicy 是一種用訂閱金鑰簽署 HTTP 請求的政策。 |
| TimezoneURL |
TimezoneURL 代表 Azure Maps 時區操作的 URL。 |
| TokenCredential |
TokenCredential 是一種用來產生 TokenCredentialPolicy 的憑證。 透過將新的標記字串值設為標記屬性來更新代幣。 範例 const tokenCredential = new TokenCredential（“clientId”， “token”）;const pipeline = MapsURL.newPipeline（tokenCredential）; const searchURL = new SearchURL（pipeline）; 設定一個計時器來刷新令牌 const timerID = setInterval（（） => { // 透過存取公開 tokenCredential.token 更新令牌 Credential.token = “updatedToken”;// 警告：計時器必須手動停止！ 若 （shouldStop（）） { clearInterval（timerID）; } }， 60 * 60 * 1000，則禁止 tokenCredential 的 GC）;設定一個時間間隔，讓你的代幣到期 |
| TokenCredentialPolicy |
TokenCredentialPolicy 是一種用 token 簽署 HTTP 請求的政策。 例如OAuth持有人代幣。 |
| TransitDockGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| TransitItineraryGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| TransitLineGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
| TransitStopGeojson |
一個輔助擴充功能，提供以 GeoJSON 格式存取回應資料的方法。 |
介面
類型別名
列舉
| AbsoluteDirection |
定義絕對方向的數值。 可能的數值包括：「北」、「東北」、「東」、「東南」、「南」、「西南」、「西」、「西北」 |
| AgencyType |
定義 AgencyType 的價值。 可能的值包括：『agencyId』、『agencyKey』、『agencyName』 |
| AlternativeRouteType |
定義 AlternativeRouteType 的值。 可能的值包括：『anyRoute』、『betterRoute』 |
| Avoid |
定義了「避免」的數值。 可能的數值包括：「收費道路」、「高速公路」、「渡輪」、「未鋪裝道路」、「共乘」、「已使用道路」、「邊境穿越點」。 |
| BikeType |
定義 BikeType 的數值。 可能的值包括：「privateBike」、「dockedBike」 |
| ComputeTravelTimeFor |
定義了 ComputeTravelTimeFor 的數值。 可能的值包括：「無」、「全部」。 |
| ConnectorSet |
定義 ConnectorSet 的數值。 可能的數值包括：『StandardHouseholdCountrySpecific』、『IEC62196Type1』、『IEC62196Type1CCS』、『IEC62196Type2CableAttached』、『IEC62196Type2Outlet』、『IEC62196Type2CCS』、『IEC62196Type3』、『Chademo』、『IEC60309AC1PhaseBlue』、『IEC60309DCWhite』、『特斯拉』 |
| DestinationType |
定義 DestinationType 的值。 可能的值包括：『position』、『stopId』、『stopKey』 |
| DrivingSide |
定義 DrivingSide 的值。 可能的數值包括：「左」、「右」。 |
| EntityType |
定義 EntityType 的值。 可能的數值包括：「國家」、「國家分區」、「國家次級分區」、「國家第三次級分區」、「市政當局」、「市政分區」、「鄰里」、「郵遞區號」 |
| GeofenceMode |
定義 GeofenceMode 的數值。 可能的值包括：「全部」、「進入與退出」 |
| GuidanceInstructionType |
定義 GuidanceInstructionType 的值。 可能的數值包括：『TURN』、『ROAD_CHANGE』、『LOCATION_DEPARTURE』、『LOCATION_ARRIVAL』、『DIRECTION_INFO』、『LOCATION_WAYPOINT』 |
| GuidanceManeuver |
定義導引機動的數值。 可能的值包括：「抵達」、「ARRIVE_LEFT」、「ARRIVE_RIGHT」、「出發」、「直達」、「KEEP_RIGHT」、「BEAR_RIGHT」、「TURN_RIGHT」、「SHARP_RIGHT」、「KEEP_LEFT」、「BEAR_LEFT」、「TURN_LEFT」、「SHARP_LEFT」、「MAKE_UTURN」、「ENTER_MOTORWAY」、「ENTER_FREEWAY」、「ENTER_HIGHWAY」、「TAKE_EXIT」、「MOTORWAY_EXIT_LEFT」、「MOTORWAY_EXIT_RIGHT」、「TAKE_FERRY」、「ROUNDABOUT_CROSS」、「ROUNDABOUT_RIGHT」、「ROUNDABOUT_LEFT」、「ROUNDABOUT_BACK」、「TRY_MAKE_UTURN」、「跟上」。 「SWITCH_PARALLEL_ROAD」、「SWITCH_MAIN_ROAD」、「ENTRANCE_RAMP」、「WAYPOINT_LEFT」、「WAYPOINT_RIGHT」、「WAYPOINT_REACHED」 |
| Hilliness |
定義了丘陵度的價值。 可能的數值包括：「低」、「正常」、「高」 |
| LegType |
定義 LegType 的值。 可能的數值包括：「步行」、「自行車」、「有軌電車」、「地鐵」、「鐵路」、「公車」、「渡輪」、「纜車」、「路徑步行」、「等待」、「等待車輛」 |
| MagnitudeOfDelay |
定義 MagnitudeOfDelay 的數值。 可能的數值包括：『0』、『1』、『2』、『3』、『4』 |
| MapTileLayer |
定義 MapTileLayer 的數值。 可能的值包括：「基本」、「混合」、「標籤」、「terra」 |
| MapTileStyle |
定義 MapTileStyle 的數值。 可能的值包括：「主」、「shaded_relief」 |
| MetroAreaDetailType |
定義 MetroAreaDetailType 的值。 可能的值包括：「機構」、「警報」、「警報詳情」、「運輸類型」 |
| MetroAreaQueryType |
定義 MetroAreaQueryType 的值。 可能的值包括：「位置」、「國家代碼」 |
| ModeType |
定義 ModeType 的值。 可能的數值包括：「步行」、「自行車」、「公共運輸」 |
| ObjectType |
定義 ObjectType 的值。 可能的數值包括：『stop』、『無dockBike』、『無dock電動自行車』、『無碼頭電動滑板車』、『無碼頭滑板車』、『無碼頭摩托車』、『汽車共享』、『無碼頭車輛』、『bikeDock』 |
| OpeningHours |
定義開放時間的數值。 可能的數值包括：「nextSevenDays」 |
| OriginType |
定義 OriginType 的值。 可能的值包括：『position』、『stopId』、『stopKey』 |
| RealTimeArrivalsQueryType |
定義 RealTimeArrivalsQueryType 的值。 可能的值包括：「停止」、「線」、「線與停止」、「位置」 |
| RelativeDirection |
定義 RelativeDirection 的值。 可能的數值包括：『離開』、『硬左』、『左』、『稍微左轉』、『繼續』、『稍微右轉』、『右』、『硬右』、『順時針圓圈』、『逆時針圓圈』、『電梯』、『左轉』、『右轉』 |
| RouteInstructionsType |
定義 RouteInstructionsType 的值。 可能的值包括：「編碼」、「文字」、「標籤」 |
| RouteRepresentation |
定義路由表示的值。 可能的值包括：『多線』、『僅摘要』、『無』 |
| RouteType |
定義 RouteType 的值。 可能的數值包括：「最快」、「最短」、「環保」、「刺激」 |
| ScheduleType |
定義 ScheduleType 的值。 可能的值包括：「scheduledTime」、「realTime」 |
| SearchIndexSet |
定義 SearchIndexSet 的值。 可能的數值包括：『Addr』、『Geo』、『PAD』、『POI』、『力量』、『Xstr』 |
| SectionType |
定義 SectionType 的值。 可能的數值包括：「carTrain」、「country」、「ferry」、「motorway」、「pedestrian」、「toll road」、「tollVignette」、「traffic」、「travelMode」、「tunnel」。 |
| StaticMapLayer |
定義 StaticMapLayer 的數值。 可能的值包括：「基本」、「混合」、「標籤」。 |
| StopQueryType |
定義 StopQueryType 的值。 可能的值包括：'stopId'， 'stopKey' |
| Style |
定義風格的價值。 可能的值包括：「主」 |
| Text |
定義文字的數值。 可能的數值包括：「是」、「否」。 |
| Text1 |
定義 Text1 的值。 可能的數值包括：「是」、「否」。 |
| Text2 |
定義 Text2 的值。 可能的數值包括：「是」、「否」。 |
| TileFormat |
定義 TileFormat 的值。 可能的值包括：'png'， 'pbf' |
| TimeType |
定義了 TimeType 的值。 可能的數值包括：「抵達」、「出發」、「最後」 |
| TimezoneOptions |
定義 TimezoneOptions 的值。 可能的值包括：『無』、『zoneInfo』、『transitions』、『全部』 |
| TransitItineraryDetailType |
定義 TransitineraryDetailType 的值。 可能的值包括：「幾何」、「排程」 |
| TransitLineDetailType |
定義 TransitLineDetailType 的值。 可能的值包括：「警報」、「警報詳情」、「路線」、「停靠」、「排程」、「模式」 |
| TransitRouteType |
定義 TransitRouteType 的值。 可能的值包括：「最佳」、「最少行走」、「最少轉移」。 |
| TransitStopDetailType |
定義 TransitStopDetailType 的值。 可能的值包括：「警報」、「alertDetails」、「lines」、「lineGroups」 |
| TransitStopQueryType |
定義 TransitStopQueryType 的值。 可能的值包括：'stopId'， 'stopKey' |
| TransitType |
定義了TransitType的值。 可能的數值包括：「巴士」、「纜車」、「渡輪」、「纜車」、「纜車」、「鐵路」、「有軌電車」、「地鐵」 |
| TransitTypeFilter |
定義 TransitTypeFilter 的值。 可能的數值包括：「公車」、「纜車」、「渡輪」、「纜車」、「貢多拉」、「鐵路」、「有軌電車」、「地鐵」 |
| TravelMode |
定義 TravelMode 的數值。 可能的數值包括：「汽車」、「卡車」、「計程車」、「公車」、「廂型車」、「機車」、「自行車」、「行人」 |
| Type |
定義 Type 的值。 可能的值包括：「主要」、「次要」 |
| VehicleEngineType |
定義 VehicleEngineType 的值。 可能的數值包括：「燃燒」、「電力」 |
| VehicleLoadType |
定義了 VehicleLoadType 的值。 可能的數值包括：「USHazmatClass1」、「USHazmatClass2」、「USHazmatClass3」、「USHazmatClass4」、「USHazmatClass5」、「USHazmatClass6」、「USHazmatClass7」、「USHazmatClass8」、「USHazmatClass9」、「otherHazmatExplosive」、「otherHazmatGeneral」、「otherHazmatHarmfulToWater」 |
| Windingness |
定義繞度數值。 可能的數值包括：「低」、「正常」、「高」 |
| RetryPolicyType |
RetryPolicy 類型。 |