The Get Data for Points API provides elevation data for one or more points. A point is defined in lat,long + * coordinate format. + * + *
Due to the URL character length limit of 2048, it's not possible to pass more than 100 coordinates as a + * pipeline delimited string in a URL GET request. If you intend to pass more than 100 coordinates as a pipeline + * delimited string, use the [POST Data For + * Points](https://docs.microsoft.com/rest/api/maps/elevation/postdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| points | String | Yes | The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate reference system format. If multiple points are requested, each of the points in a list should be separated by the pipe ('|') character. The maximum number of points that can be requested in a single request is 2,000. The resolution of the elevation data will be the highest for a single point and will decrease if multiple points are spread further apart. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Post Data for Points API provides elevation data for multiple points. A point is defined lon/lat + * coordinate format. + * + *
Use the POST endpoint only if you intend to pass multiple points in the request. If you intend to pass a + * single coordinate into the API, use the [GET Data For Points + * API](https://docs.microsoft.com/rest/api/maps/elevation/getdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param points The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate
+ * reference system format. Each points in a list should be separated by the pipe ('|') character. The number of
+ * points that can be requested in a POST request ranges from 2 to 2,000. The resolution of the elevation data
+ * will be the highest for a single point and will decrease if multiple points are spread further apart.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and endpoints, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| lines | String | Yes | The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]`. + * + * The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation depends on the distance between the endpoints. |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Post Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and end points, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param polyline The string representation of a polyline path. A polyline is defined by endpoint coordinates, with
+ * each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format:
+ * `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN,
+ * latitude_pointN]`. The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate
+ * reference system. The resolution of the data used to compute the elevation will depend on the distance
+ * between the endpoints.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Bounding Box API provides elevation data at equally spaced locations within a bounding box. A + * bounding box is defined by the coordinates for two corners (southwest, northeast) and then subsequently divided + * into rows and columns. + * + *
Elevations are returned for the vertices of the grid created by the rows and columns. Up to 2,000 elevations + * can be returned in a single request. The returned elevation values are ordered, starting at the southwest corner, + * and then proceeding west to east along the row. At the end of the row, it moves north to the next row, and + * repeats the process until it reaches the far northeast corner. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| bounds | String | Yes | The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. |
| rows | int | Yes | Specifies the number of rows to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
| columns | int | Yes | Specifies the number of columns to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Points API provides elevation data for one or more points. A point is defined in lat,long + * coordinate format. + * + *
Due to the URL character length limit of 2048, it's not possible to pass more than 100 coordinates as a + * pipeline delimited string in a URL GET request. If you intend to pass more than 100 coordinates as a pipeline + * delimited string, use the [POST Data For + * Points](https://docs.microsoft.com/rest/api/maps/elevation/postdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| points | String | Yes | The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate reference system format. If multiple points are requested, each of the points in a list should be separated by the pipe ('|') character. The maximum number of points that can be requested in a single request is 2,000. The resolution of the elevation data will be the highest for a single point and will decrease if multiple points are spread further apart. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Post Data for Points API provides elevation data for multiple points. A point is defined lon/lat + * coordinate format. + * + *
Use the POST endpoint only if you intend to pass multiple points in the request. If you intend to pass a + * single coordinate into the API, use the [GET Data For Points + * API](https://docs.microsoft.com/rest/api/maps/elevation/getdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param points The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate
+ * reference system format. Each points in a list should be separated by the pipe ('|') character. The number of
+ * points that can be requested in a POST request ranges from 2 to 2,000. The resolution of the elevation data
+ * will be the highest for a single point and will decrease if multiple points are spread further apart.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Get Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and endpoints, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| lines | String | Yes | The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]`. + * + * The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation depends on the distance between the endpoints. |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Post Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and end points, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param polyline The string representation of a polyline path. A polyline is defined by endpoint coordinates, with
+ * each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format:
+ * `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN,
+ * latitude_pointN]`. The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate
+ * reference system. The resolution of the data used to compute the elevation will depend on the distance
+ * between the endpoints.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Get Data for Bounding Box API provides elevation data at equally spaced locations within a bounding box. A + * bounding box is defined by the coordinates for two corners (southwest, northeast) and then subsequently divided + * into rows and columns. + * + *
Elevations are returned for the vertices of the grid created by the rows and columns. Up to 2,000 elevations + * can be returned in a single request. The returned elevation values are ordered, starting at the southwest corner, + * and then proceeding west to east along the row. At the end of the row, it moves north to the next row, and + * repeats the process until it reaches the far northeast corner. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| bounds | String | Yes | The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. |
| rows | int | Yes | Specifies the number of rows to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
| columns | int | Yes | Specifies the number of columns to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Get Data for Points API provides elevation data for one or more points. A point is defined in lat,long + * coordinate format. + * + *
Due to the URL character length limit of 2048, it's not possible to pass more than 100 coordinates as a + * pipeline delimited string in a URL GET request. If you intend to pass more than 100 coordinates as a pipeline + * delimited string, use the [POST Data For + * Points](https://docs.microsoft.com/rest/api/maps/elevation/postdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| points | String | Yes | The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate reference system format. If multiple points are requested, each of the points in a list should be separated by the pipe ('|') character. The maximum number of points that can be requested in a single request is 2,000. The resolution of the elevation data will be the highest for a single point and will decrease if multiple points are spread further apart. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Points API provides elevation data for one or more points. A point is defined in lat,long + * coordinate format. + * + *
Due to the URL character length limit of 2048, it's not possible to pass more than 100 coordinates as a + * pipeline delimited string in a URL GET request. If you intend to pass more than 100 coordinates as a pipeline + * delimited string, use the [POST Data For + * Points](https://docs.microsoft.com/rest/api/maps/elevation/postdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| points | String | Yes | The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate reference system format. If multiple points are requested, each of the points in a list should be separated by the pipe ('|') character. The maximum number of points that can be requested in a single request is 2,000. The resolution of the elevation data will be the highest for a single point and will decrease if multiple points are spread further apart. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Points API provides elevation data for one or more points. A point is defined in lat,long + * coordinate format. + * + *
Due to the URL character length limit of 2048, it's not possible to pass more than 100 coordinates as a + * pipeline delimited string in a URL GET request. If you intend to pass more than 100 coordinates as a pipeline + * delimited string, use the [POST Data For + * Points](https://docs.microsoft.com/rest/api/maps/elevation/postdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| points | String | Yes | The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate reference system format. If multiple points are requested, each of the points in a list should be separated by the pipe ('|') character. The maximum number of points that can be requested in a single request is 2,000. The resolution of the elevation data will be the highest for a single point and will decrease if multiple points are spread further apart. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Post Data for Points API provides elevation data for multiple points. A point is defined lon/lat + * coordinate format. + * + *
Use the POST endpoint only if you intend to pass multiple points in the request. If you intend to pass a + * single coordinate into the API, use the [GET Data For Points + * API](https://docs.microsoft.com/rest/api/maps/elevation/getdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param points The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate
+ * reference system format. Each points in a list should be separated by the pipe ('|') character. The number of
+ * points that can be requested in a POST request ranges from 2 to 2,000. The resolution of the elevation data
+ * will be the highest for a single point and will decrease if multiple points are spread further apart.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Post Data for Points API provides elevation data for multiple points. A point is defined lon/lat + * coordinate format. + * + *
Use the POST endpoint only if you intend to pass multiple points in the request. If you intend to pass a + * single coordinate into the API, use the [GET Data For Points + * API](https://docs.microsoft.com/rest/api/maps/elevation/getdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param points The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate
+ * reference system format. Each points in a list should be separated by the pipe ('|') character. The number of
+ * points that can be requested in a POST request ranges from 2 to 2,000. The resolution of the elevation data
+ * will be the highest for a single point and will decrease if multiple points are spread further apart.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Post Data for Points API provides elevation data for multiple points. A point is defined lon/lat + * coordinate format. + * + *
Use the POST endpoint only if you intend to pass multiple points in the request. If you intend to pass a + * single coordinate into the API, use the [GET Data For Points + * API](https://docs.microsoft.com/rest/api/maps/elevation/getdataforpoints). + * + *
The result will be in the same sequence of points listed in the request. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param points The string representation of a list of points. A point is defined in lon/lat WGS84 coordinate
+ * reference system format. Each points in a list should be separated by the pipe ('|') character. The number of
+ * points that can be requested in a POST request ranges from 2 to 2,000. The resolution of the elevation data
+ * will be the highest for a single point and will decrease if multiple points are spread further apart.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Get Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and endpoints, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| lines | String | Yes | The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]`. + * + * The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation depends on the distance between the endpoints. |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and endpoints, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| lines | String | Yes | The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]`. + * + * The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation depends on the distance between the endpoints. |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and endpoints, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| lines | String | Yes | The string representation of a polyline path. A polyline is defined by endpoint coordinates, with each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format: `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN, latitude_pointN]`. + * + * The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate reference system. The resolution of the data used to compute the elevation depends on the distance between the endpoints. |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Post Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and end points, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param polyline The string representation of a polyline path. A polyline is defined by endpoint coordinates, with
+ * each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format:
+ * `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN,
+ * latitude_pointN]`. The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate
+ * reference system. The resolution of the data used to compute the elevation will depend on the distance
+ * between the endpoints.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Post Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and end points, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param polyline The string representation of a polyline path. A polyline is defined by endpoint coordinates, with
+ * each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format:
+ * `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN,
+ * latitude_pointN]`. The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate
+ * reference system. The resolution of the data used to compute the elevation will depend on the distance
+ * between the endpoints.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Post Data for Polyline API provides elevation data along a polyline. + * + *
A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. + * In addition to passing in endpoints, customers can specify the number of sample points that will be used to + * divide polyline into equally spaced segments. + * + *
Elevation data at both start and end points, as well as equally spaced points along the polyline will be + * returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line + * between two endpoints is a straight Cartesian line, the shortest line between those two points in the coordinate + * reference system. Note that the point is chosen based on Euclidean distance and may markedly differ from the + * geodesic path along the curved surface of the reference ellipsoid. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| samples | String | No | The samples parameter specifies the number of equally spaced points at which elevation values should be provided along a polyline path. The number of samples should range from 2 to 2,000. Default value is 10. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Request Body Schema + * + *
{@code
+ * [
+ * {
+ * lat: Double
+ * lon: Double
+ * }
+ * ]
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param polyline The string representation of a polyline path. A polyline is defined by endpoint coordinates, with
+ * each endpoint separated by a pipe ('|') character. The polyline should be defined in the following format:
+ * `[longitude_point1, latitude_point1 | longitude_point2, latitude_point2, ..., longitude_pointN,
+ * latitude_pointN]`. The longitude and latitude values refer to the World Geodetic System (WGS84) coordinate
+ * reference system. The resolution of the data used to compute the elevation will depend on the distance
+ * between the endpoints.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseThe Get Data for Bounding Box API provides elevation data at equally spaced locations within a bounding box. A + * bounding box is defined by the coordinates for two corners (southwest, northeast) and then subsequently divided + * into rows and columns. + * + *
Elevations are returned for the vertices of the grid created by the rows and columns. Up to 2,000 elevations + * can be returned in a single request. The returned elevation values are ordered, starting at the southwest corner, + * and then proceeding west to east along the row. At the end of the row, it moves north to the next row, and + * repeats the process until it reaches the far northeast corner. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| bounds | String | Yes | The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. |
| rows | int | Yes | Specifies the number of rows to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
| columns | int | Yes | Specifies the number of columns to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Bounding Box API provides elevation data at equally spaced locations within a bounding box. A + * bounding box is defined by the coordinates for two corners (southwest, northeast) and then subsequently divided + * into rows and columns. + * + *
Elevations are returned for the vertices of the grid created by the rows and columns. Up to 2,000 elevations + * can be returned in a single request. The returned elevation values are ordered, starting at the southwest corner, + * and then proceeding west to east along the row. At the end of the row, it moves north to the next row, and + * repeats the process until it reaches the far northeast corner. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| bounds | String | Yes | The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. |
| rows | int | Yes | Specifies the number of rows to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
| columns | int | Yes | Specifies the number of columns to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoThe Get Data for Bounding Box API provides elevation data at equally spaced locations within a bounding box. A + * bounding box is defined by the coordinates for two corners (southwest, northeast) and then subsequently divided + * into rows and columns. + * + *
Elevations are returned for the vertices of the grid created by the rows and columns. Up to 2,000 elevations + * can be returned in a single request. The returned elevation values are ordered, starting at the southwest corner, + * and then proceeding west to east along the row. At the end of the row, it moves north to the next row, and + * repeats the process until it reaches the far northeast corner. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| api-version | String | Yes | Api Version |
| bounds | String | Yes | The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. |
| rows | int | Yes | Specifies the number of rows to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
| columns | int | Yes | Specifies the number of columns to use to divide the bounding box area into a grid. The number of vertices (rows x columns) in the grid should be less than 2,000. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| x-ms-client-id | String | No | Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. |
Response Body Schema + * + *
{@code
+ * {
+ * elevations: [
+ * {
+ * coordinate: {
+ * latitude: Double
+ * longitude: Double
+ * }
+ * elevationInMeter: Float
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param format Desired format of the response. Only `json` format is supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @return the response from a successful Get Data for Bounding Box API along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Response