你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
azure-maps-rest package
Azure Maps Web SDK 服务模块服务停用。 Azure Maps Web SDK 服务模块现已弃用，将于 26 年 9 月 30 日停用。 为避免服务中断，我们建议在 9/30/26 前迁移为使用 Azure Maps JavaScript REST SDK。 请按照我们的说明迁移到 Azure Maps JavaScript REST SDK。
类
| Aborter |
aborter 实例实现 AbortSignal 接口，可以中止 HTTP 请求。
对于现有实例中止程序：
|
| CarShareGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| ClosestPointGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| Credential |
Credential 是用于Azure Maps HTTP 请求签名的抽象类。 此类将托管生成 CredentialPolicy 的 credentialPolicyCreator 工厂。 |
| CredentialPolicy |
用于在发送请求之前对 HTTP (S) 签名的凭据策略。 这是一个抽象类。 |
| GeofenceGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| LoggingPolicyFactory |
LoggingPolicyFactory 是一个工厂类，可帮助生成 LoggingPolicy 对象。 |
| MapControlCredential |
MapControlCredential，用于与 |
| MapControlCredentialPolicy |
MapControlCredentialPolicy 是一种策略，用于使用 |
| MapsURL |
MapsURL 表示 SearchURL、RouteURL 等的基 URL 类。 |
| MetroAreaGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| NearbyTransitGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| Pipeline |
包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 MapsURL.newPipeline () 来创建默认管道。 或者，可以通过 Pipeline 的构造函数创建具有自己的策略的管道。 在实现自定义管道之前，请参阅 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 的凭据。 通过将新的令牌字符串值设置为 token 属性来续订令牌。 示例 const sasCredential = new SasCredential (“token”) ;const pipeline = MapsURL.newPipeline (sasCredential) ; const searchURL = new SearchURL (pipeline) ; 设置计时器以刷新令牌 const timerID = setInterval ( () => { // 通过访问公共 sasCredential.token sasCredential.token = “updatedToken”; // WARNING： 计时器必须手动停止！ 如果 (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 |
用于Azure Maps服务的帐户密钥授权的 SubscriptionKeyCredential。 |
| SubscriptionKeyCredentialPolicy |
SubscriptionKeyCredentialPolicy 是一种策略，用于使用订阅密钥对 HTTP 请求进行签名。 |
| TimezoneURL |
TimezoneURL 表示Azure Maps时区操作的 URL。 |
| TokenCredential |
TokenCredential 是用于生成 TokenCredentialPolicy 的凭据。 通过将新的令牌字符串值设置为 token 属性来续订令牌。 示例 const tokenCredential = new TokenCredential (“clientId”， “token”) ;const pipeline = MapsURL.newPipeline (tokenCredential) ; const searchURL = new SearchURL (pipeline) ; 设置计时器以刷新令牌 const timerID = setInterval ( () => { // 通过访问公共 tokenCredential.tokenCredential.token = “updatedToken”; // WARNING： 计时器必须手动停止！ 如果 (shouldStop () ) { clearInterval (timerID) ; } }， 60 * 60 * 1000) ， 它将禁止 tokenCredential 的 GC;设置令牌过期前的间隔时间 |
| TokenCredentialPolicy |
TokenCredentialPolicy 是用于使用令牌对 HTTP 请求进行签名的策略。 例如 OAuth 持有者令牌。 |
| TransitDockGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| TransitItineraryGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| TransitLineGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
| TransitStopGeojson |
一个帮助程序扩展，提供用于访问 GeoJSON 格式的响应数据的方法。 |
接口
类型别名
枚举
| AbsoluteDirection |
定义 AbsoluteDirection 的值。 可能的值包括：“north”、“northeast”、“east”、“southeast”、“south”、“southwest”、“west”、“northwest” |
| AgencyType |
定义 AgencyType 的值。 可能的值包括：“agencyId”、“agencyKey”、“agencyName” |
| AlternativeRouteType |
定义 AlternativeRouteType 的值。 可能的值包括：“anyRoute”、“betterRoute” |
| Avoid |
定义 Avoid 的值。 可能的值包括：“tollRoads”、“高速公路”、“渡轮”、“unpavedRoads”、“carpools”、“alreadyUsedRoads”、“borderCrossings” |
| BikeType |
定义 BikeType 的值。 可能的值包括：“privateBike”、“dockedBike” |
| ComputeTravelTimeFor |
定义 ComputeTravelTimeFor 的值。 可能的值包括：“none”、“all” |
| ConnectorSet |
定义 ConnectorSet 的值。 可能的值包括：“StandardHouseholdCountrySpecific”、“IEC62196Type1”、 “IEC62196Type1CCS”、“IEC62196Type2CableAttached”、“IEC62196Type2Outlet”、“IEC62196Type2CCS”、“IEC62196Type3”、“Chademo”、“IEC60309AC1PhaseBlue”、“IEC60309DCWhite”、“Tesla” |
| DestinationType |
定义 DestinationType 的值。 可能的值包括：“position”、“stopId”、“stopKey” |
| DrivingSide |
定义 DrivingSide 的值。 可能的值包括：“LEFT”、“RIGHT” |
| EntityType |
定义 EntityType 的值。 可能的值包括：“Country”、“CountrySubdivision”、“CountrySecondarySubdivision”、“CountryTertiarySubdivision”、“Municipality”、“MunicipalitySubdivision”、“Neighbourhood”、“PostalCodeArea” |
| GeofenceMode |
定义 GeofenceMode 的值。 可能的值包括：“All”、“EnterAndExit” |
| GuidanceInstructionType |
定义 GuidanceInstructionType 的值。 可能的值包括：“TURN”、“ROAD_CHANGE”、“LOCATION_DEPARTURE”、“LOCATION_ARRIVAL”、“DIRECTION_INFO”、“LOCATION_WAYPOINT” |
| GuidanceManeuver |
定义 GuidanceManeuver 的值。 可能的值包括：“ARRIVE”、“ARRIVE_LEFT”、“ARRIVE_RIGHT”、“DEPART”、“STRAIGHT”、“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”、“FOLLOW”， “SWITCH_PARALLEL_ROAD”、“SWITCH_MAIN_ROAD”、“ENTRANCE_RAMP”、“WAYPOINT_LEFT”、“WAYPOINT_RIGHT”、“WAYPOINT_REACHED” |
| Hilliness |
定义 Hilliness 的值。 可能的值包括：“low”、“normal”、“high” |
| LegType |
定义 LegType 的值。 可能的值包括：“Walk”、“Bicycle”、“Tram”、“Tram”、“Subway”、“Rail”、“Bus”、“Ferry”、“Cable”、“Gondola”、“Funicular”、“PathWayWalk”、“Wait”、“WaitOnVehicle” |
| MagnitudeOfDelay |
定义 MagnitudeOfDelay 的值。 可能的值包括：“0”、“1”、“2”、“3”、“4” |
| MapTileLayer |
定义 MapTileLayer 的值。 可能的值包括：“basic”、“hybrid”、“labels”、“terra” |
| MapTileStyle |
定义 MapTileStyle 的值。 可能的值包括：“main”、“shaded_relief” |
| MetroAreaDetailType |
定义 MetroAreaDetailType 的值。 可能的值包括：“agencies”、“alerts”、“alertDetails”、“transitTypes” |
| MetroAreaQueryType |
定义 MetroAreaQueryType 的值。 可能的值包括：“position”、“countryCode” |
| ModeType |
定义 ModeType 的值。 可能的值包括：“walk”、“bike”、“publicTransit” |
| ObjectType |
定义 ObjectType 的值。 可能的值包括：“stop”、“docklessBike”、“docklessElectricBike”、“docklessElectricScooter”、“docklessScooter”、“docklessMoped”、“carShare”、“docklessVehicle”、“bikeDock” |
| OpeningHours |
定义 OpenHours 的值。 可能的值包括：“nextSevenDays” |
| OriginType |
定义 OriginType 的值。 可能的值包括：“position”、“stopId”、“stopKey” |
| RealTimeArrivalsQueryType |
定义 RealTimeArrivalsQueryType 的值。 可能的值包括：“stops”、“line”、“lineAndStop”、“position” |
| RelativeDirection |
定义 RelativeDirection 的值。 可能的值包括：“depart”、“hardLeft”、“left”、“slightlyLeft”、“continue”、“slightlyRight”、“right”、“hardRight”、“circleClockwise”、“circleCounterclockwise”、“elevator”、“uturnLeft”、“uturnRight” |
| RouteInstructionsType |
定义 RouteInstructionsType 的值。 可能的值包括：“coded”、“text”、“tagged” |
| RouteRepresentation |
定义 RouteRepresentation 的值。 可能的值包括：“polyline”、“summaryOnly”、“none” |
| RouteType |
定义 RouteType 的值。 可能的值包括：“fastest”、“shortest”、“eco”、“thrilling” |
| ScheduleType |
定义 ScheduleType 的值。 可能的值包括：“scheduledTime”、“realTime” |
| SearchIndexSet |
定义 SearchIndexSet 的值。 可能的值包括：“Addr”、“Geo”、“PAD”、“POI”、“Str”、“Xstr” |
| SectionType |
定义 SectionType 的值。 可能的值包括：“carTrain”、“country”、“ferry”、“高速公路”、“行人”、“tollRoad”、“tollVignette”、“traffic”、“travelMode”、“tunnel” |
| StaticMapLayer |
定义 StaticMapLayer 的值。 可能的值包括：“basic”、“hybrid”、“labels” |
| StopQueryType |
定义 StopQueryType 的值。 可能的值包括：“stopId”、“stopKey” |
| Style |
定义 Style 的值。 可能的值包括：“main” |
| Text |
定义 Text 的值。 可能的值包括：“yes”、“no” |
| Text1 |
定义 Text1 的值。 可能的值包括：“yes”、“no” |
| Text2 |
定义 Text2 的值。 可能的值包括：“yes”、“no” |
| TileFormat |
定义 TileFormat 的值。 可能的值包括：“png”、“pbf” |
| TimeType |
定义 TimeType 的值。 可能的值包括：“arrival”、“departure”、“last” |
| TimezoneOptions |
定义 TimezoneOptions 的值。 可能的值包括：“none”、“zoneInfo”、“transitions”、“all” |
| TransitItineraryDetailType |
定义 TransitItineraryDetailType 的值。 可能的值包括：“geometry”、“schedule” |
| TransitLineDetailType |
定义 TransitLineDetailType 的值。 可能的值包括：“alerts”、“alertDetails”、“lines”、“stops”、“schedule”、“patterns” |
| TransitRouteType |
定义 TransitRouteType 的值。 可能的值包括：“optimal”、“leastWalk”、“leastTransfers” |
| TransitStopDetailType |
定义 TransitStopDetailType 的值。 可能的值包括：“alerts”、“alertDetails”、“line”、“lineGroups” |
| TransitStopQueryType |
定义 TransitStopQueryType 的值。 可能的值包括：“stopId”、“stopKey” |
| TransitType |
定义 TransitType 的值。 可能的值包括：“Bus”、“CableCar”、“Ferry”、“Funicular”、“Gondola”、“Rail”、“Tram”、“Subway” |
| TransitTypeFilter |
定义 TransitTypeFilter 的值。 可能的值包括：“bus”、“cableCar”、“ferry”、“funicular”、“gondola”、“rail”、“tram”、“subway” |
| TravelMode |
定义 TravelMode 的值。 可能的值包括：“car”、“truck”、“taxi”、“bus”、“van”、“motorcycle”、“bicycle”、“行人” |
| Type |
定义 Type 的值。 可能的值包括：“main”、“minor” |
| VehicleEngineType |
定义 VehicleEngineType 的值。 可能的值包括：“燃烧”、“电力” |
| VehicleLoadType |
定义 VehicleLoadType 的值。 可能的值包括：“USHazmatClass1”， “USHazmatClass2”、“USHazmatClass3”、“USHazmatClass4”、“USHazmatClass5”、“USHazmatClass6”、“USHazmatClass7”、“USHazmatClass8”、“USHazmatClass9”、“otherHazmatExplosive”、“otherHazmatGeneral”、“otherHazmatHarmfulToWater” |
| Windingness |
定义“绕组性”的值。 可能的值包括：“low”、“normal”、“high” |
| RetryPolicyType |
RetryPolicy 类型。 |