你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

RouteRequestRouteMatrixSyncQueryParamProperties interface

  • 参考
包:
@azure-rest/maps-route

属性

arriveAt

到达目标点的日期和时间。 它必须指定为 dateTime。 如果未指定时区偏移量，则假定其为目标点的偏移量。 arriveAt 值必须位于将来。 arriveAt 参数不能与 departAt、minDeviationDistance 或 minDeviationTime 结合使用。
avoid

指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定“&avoid=高速公路，&避免=tollRoads&avoid=ferries”。 在 calculateReachableRange 请求中，不能使用 alreadyUsedRoads 值。
computeTravelTimeFor

指定是否使用不同类型的交通信息（无、历史、实时）以及默认的最佳估计行程时间返回其他旅行时间。
departAt

从原点出发的日期和时间。 除现在以外的出发时间必须指定为 dateTime。 如果未指定时区偏移量，则假定其为原点的偏移量。 departAt 值必须采用日期时间格式（1996-12-19T16：39：57-08：00）。
hilliness

惊心动魄的路线的丘陵程度。 此参数只能与 routeType=thrilling 结合使用。
routeType

请求的路由类型。
sectionType

指定路由响应中报告哪些节类型。

例如，如果 sectionType = 行人，则仅返回适合行人的部分。 可以使用多个类型。 默认 sectionType 引用 travelMode 输入。 默认情况下，travelMode 设置为汽车
traffic

可能的值：

  • true - 在路由期间考虑所有可用的流量信息
  • false - 在路由期间忽略当前流量数据。 请注意，虽然当前交通数据在路由期间被忽略，但历史交通对有效道路速度的影响仍会合并。
travelMode

所请求路线的旅行模式。 如果未定义，则默认值为“car”。 请注意，请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节，则响应的 travelMode 元素将为“其他”。 请注意，旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。 完全限制数据在所有方面都不可用。 在 calculateReachableRange 请求中，不得使用自行车和行人的值。
vehicleAxleWeight

车辆每轴重量（以公斤为单位）。 值为 0 表示不考虑每个轴的重量限制。
vehicleHeight

车辆的高度（以米为单位）。 值为 0 表示不考虑高度限制。
vehicleLength

车辆长度（以米为单位）。 值为 0 表示不考虑长度限制。
vehicleLoadType

可能归类为危险物质的货物类型，并受某些道路限制。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9，以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值用于美国路由，而其他Hazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数当前仅考虑用于 travelMode=truck。
vehicleMaxSpeed

车辆的最大速度（以公里/小时为单位）。 车辆配置文件中的最大速度用于检查是否允许车辆在高速公路上。

  • 值为 0 表示将在路线规划期间确定并应用车辆的相应值。

  • 在路由规划期间，可能会重写非零值。 例如，当前流量流为 60 公里/小时。 如果车辆最大速度设置为 50 公里/小时，路由引擎将考虑 60 公里/小时，因为这是目前的情况。 如果车辆的最大速度为 80 公里/小时，但当前交通流量为 60 公里/小时，则路由引擎将再次使用 60 公里/小时。
vehicleWeight

车辆重量（以公斤为单位）。
vehicleWidth

车辆宽度（以米为单位）。 值为 0 表示不考虑宽度限制。
waitForResults

指示是否同步执行请求的布尔值。 如果设置为 true，则如果在 120 秒内完成请求，用户将收到 200 响应。 否则，用户将立即获得 202 响应。 有关 202 响应的更多详细信息，请参阅 API 说明。 仅支持异步请求。
windingness

惊心动魄的路线的转弯水平。 此参数只能与 routeType=thrilling 结合使用。

属性详细信息

arriveAt

到达目标点的日期和时间。 它必须指定为 dateTime。 如果未指定时区偏移量，则假定其为目标点的偏移量。 arriveAt 值必须位于将来。 arriveAt 参数不能与 departAt、minDeviationDistance 或 minDeviationTime 结合使用。

arriveAt?: string | Date

属性值

string | Date

avoid

指定路由计算在确定路由时应尝试避免的内容。 可以在一个请求中多次指定“&avoid=高速公路，&避免=tollRoads&avoid=ferries”。 在 calculateReachableRange 请求中，不能使用 alreadyUsedRoads 值。

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

属性值

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

computeTravelTimeFor

指定是否使用不同类型的交通信息（无、历史、实时）以及默认的最佳估计行程时间返回其他旅行时间。

computeTravelTimeFor?: "none" | "all"

属性值

"none" | "all"

departAt

从原点出发的日期和时间。 除现在以外的出发时间必须指定为 dateTime。 如果未指定时区偏移量，则假定其为原点的偏移量。 departAt 值必须采用日期时间格式（1996-12-19T16：39：57-08：00）。

departAt?: string | Date

属性值

string | Date

hilliness

惊心动魄的路线的丘陵程度。 此参数只能与 routeType=thrilling 结合使用。

hilliness?: "low" | "normal" | "high"

属性值

"low" | "normal" | "high"

routeType

请求的路由类型。

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

属性值

"fastest" | "shortest" | "eco" | "thrilling"

sectionType

指定路由响应中报告哪些节类型。

例如，如果 sectionType = 行人，则仅返回适合行人的部分。 可以使用多个类型。 默认 sectionType 引用 travelMode 输入。 默认情况下，travelMode 设置为汽车

sectionType?: "carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"

属性值

"carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban"

traffic

可能的值：

  • true - 在路由期间考虑所有可用的流量信息
  • false - 在路由期间忽略当前流量数据。 请注意，虽然当前交通数据在路由期间被忽略，但历史交通对有效道路速度的影响仍会合并。
traffic?: boolean

属性值

boolean

travelMode

所请求路线的旅行模式。 如果未定义，则默认值为“car”。 请注意，请求的 travelMode 可能不适用于整个路线。 如果请求的 travelMode 不适用于特定节，则响应的 travelMode 元素将为“其他”。 请注意，旅行模式巴士、摩托车、出租车和面包车是 BETA 功能。 完全限制数据在所有方面都不可用。 在 calculateReachableRange 请求中，不得使用自行车和行人的值。

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

属性值

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

vehicleAxleWeight

车辆每轴重量（以公斤为单位）。 值为 0 表示不考虑每个轴的重量限制。

vehicleAxleWeight?: number

属性值

number

vehicleHeight

车辆的高度（以米为单位）。 值为 0 表示不考虑高度限制。

vehicleHeight?: number

属性值

number

vehicleLength

车辆长度（以米为单位）。 值为 0 表示不考虑长度限制。

vehicleLength?: number

属性值

number

vehicleLoadType

可能归类为危险物质的货物类型，并受某些道路限制。 可用的 vehicleLoadType 值为美国 Hazmat 类 1 到 9，以及用于其他国家/地区的通用分类。 以 USHazmat 开头的值用于美国路由，而其他Hazmat 应用于所有其他国家/地区。 可以多次指定 vehicleLoadType。 此参数当前仅考虑用于 travelMode=truck。

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

属性值

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

车辆的最大速度（以公里/小时为单位）。 车辆配置文件中的最大速度用于检查是否允许车辆在高速公路上。

  • 值为 0 表示将在路线规划期间确定并应用车辆的相应值。

  • 在路由规划期间，可能会重写非零值。 例如，当前流量流为 60 公里/小时。 如果车辆最大速度设置为 50 公里/小时，路由引擎将考虑 60 公里/小时，因为这是目前的情况。 如果车辆的最大速度为 80 公里/小时，但当前交通流量为 60 公里/小时，则路由引擎将再次使用 60 公里/小时。

vehicleMaxSpeed?: number

属性值

number

vehicleWeight

车辆重量（以公斤为单位）。

vehicleWeight?: number

属性值

number

vehicleWidth

车辆宽度（以米为单位）。 值为 0 表示不考虑宽度限制。

vehicleWidth?: number

属性值

number

waitForResults

指示是否同步执行请求的布尔值。 如果设置为 true，则如果在 120 秒内完成请求，用户将收到 200 响应。 否则，用户将立即获得 202 响应。 有关 202 响应的更多详细信息，请参阅 API 说明。 仅支持异步请求。

waitForResults?: boolean

属性值

boolean

windingness

惊心动魄的路线的转弯水平。 此参数只能与 routeType=thrilling 结合使用。

windingness?: "low" | "normal" | "high"

属性值

"low" | "normal" | "high"