diff --git a/sdk/maps/Azure.Maps.Geolocation/src/Generated/GeolocationRestClient.cs b/sdk/maps/Azure.Maps.Geolocation/src/Generated/GeolocationRestClient.cs index b8e70334a4d28..df02bc50b7490 100644 --- a/sdk/maps/Azure.Maps.Geolocation/src/Generated/GeolocationRestClient.cs +++ b/sdk/maps/Azure.Maps.Geolocation/src/Generated/GeolocationRestClient.cs @@ -28,7 +28,7 @@ internal partial class GeolocationRestClient /// The handler for diagnostic messaging in the client. /// The HTTP pipeline for sending and receiving REST requests and responses. /// server parameter. - /// 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. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. /// Api Version. /// , or is null. public GeolocationRestClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, Uri endpoint = null, string clientId = null, string apiVersion = "1.0") @@ -60,16 +60,15 @@ internal HttpMessage CreateGetLocationRequest(JsonFormat format, string ipAddres return message; } - /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// - /// This service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from. - /// + /// Use to get the ISO country code for a given IP address. /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The IP address. Both IPv4 and IPv6 are allowed. /// The cancellation token to use. /// is null. + /// + /// + /// The `Get IP To Location` API is an HTTP `GET` request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from. + /// public async Task> GetLocationAsync(JsonFormat format, string ipAddress, CancellationToken cancellationToken = default) { if (ipAddress == null) @@ -93,16 +92,15 @@ public async Task> GetLocationAsync(JsonFormat for } } - /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// - /// This service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from. - /// + /// Use to get the ISO country code for a given IP address. /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The IP address. Both IPv4 and IPv6 are allowed. /// The cancellation token to use. /// is null. + /// + /// + /// The `Get IP To Location` API is an HTTP `GET` request that, given an IP address, returns the ISO country code from which that IP address is located. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from. + /// public Response GetLocation(JsonFormat format, string ipAddress, CancellationToken cancellationToken = default) { if (ipAddress == null) diff --git a/sdk/maps/Azure.Maps.Geolocation/src/MapsGeolocationClient.cs b/sdk/maps/Azure.Maps.Geolocation/src/MapsGeolocationClient.cs index 98dde768090b9..8ae5f48f46198 100644 --- a/sdk/maps/Azure.Maps.Geolocation/src/MapsGeolocationClient.cs +++ b/sdk/maps/Azure.Maps.Geolocation/src/MapsGeolocationClient.cs @@ -65,7 +65,7 @@ public MapsGeolocationClient(AzureKeyCredential credential, MapsGeolocationClien /// Initializes a new instance of MapsGeolocationClient. /// A credential used to authenticate to an Azure Maps Geolocation Service. - /// 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 for guidance. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following articles for guidance. /// or is null. public MapsGeolocationClient(TokenCredential credential, string clientId) { @@ -81,7 +81,7 @@ public MapsGeolocationClient(TokenCredential credential, string clientId) /// Initializes a new instance of MapsGeolocationClient. /// A credential used to authenticate to an Azure Maps Geolocation Service. - /// 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 for guidance. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following articles for guidance. /// The options for configuring the client. /// or is null. public MapsGeolocationClient(TokenCredential credential, string clientId, MapsGeolocationClientOptions options) diff --git a/sdk/maps/Azure.Maps.Geolocation/src/autorest.md b/sdk/maps/Azure.Maps.Geolocation/src/autorest.md index cc8bc685db0a2..1f73b03938af1 100644 --- a/sdk/maps/Azure.Maps.Geolocation/src/autorest.md +++ b/sdk/maps/Azure.Maps.Geolocation/src/autorest.md @@ -7,7 +7,7 @@ Run `dotnet build /t:GenerateCode` to generate code. ``` yaml input-file: -- https://github.com/Azure/azure-rest-api-specs/blob/e686ed79e9b0bbc10355fd8d7ba36d1a07e4ba28/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json +- https://github.com/Azure/azure-rest-api-specs/blob/3e81da30a1358b6ffcbc7ff222aae5f483971d32/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json title: MapsGeolocationClient openapi-type: data-plane tag: 1.0 diff --git a/sdk/maps/Azure.Maps.Rendering/src/Generated/Models/MapTileIndex.cs b/sdk/maps/Azure.Maps.Rendering/src/Generated/Models/MapTileIndex.cs index 05475f9f2646b..464f1302f4613 100644 --- a/sdk/maps/Azure.Maps.Rendering/src/Generated/Models/MapTileIndex.cs +++ b/sdk/maps/Azure.Maps.Rendering/src/Generated/Models/MapTileIndex.cs @@ -13,7 +13,7 @@ public partial class MapTileIndex /// /// Zoom level for the desired tile. /// - /// Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details. + /// Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. /// public int Z { get; } /// diff --git a/sdk/maps/Azure.Maps.Rendering/src/Generated/RenderRestClient.cs b/sdk/maps/Azure.Maps.Rendering/src/Generated/RenderRestClient.cs index 3a774c598ab76..bd4d92cfa3a30 100644 --- a/sdk/maps/Azure.Maps.Rendering/src/Generated/RenderRestClient.cs +++ b/sdk/maps/Azure.Maps.Rendering/src/Generated/RenderRestClient.cs @@ -31,7 +31,7 @@ internal partial class RenderRestClient /// The handler for diagnostic messaging in the client. /// The HTTP pipeline for sending and receiving REST requests and responses. /// server parameter. - /// 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. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. /// Api Version. /// , or is null. public RenderRestClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, Uri endpoint = null, string clientId = null, string apiVersion = "2022-08-01") @@ -82,11 +82,11 @@ internal HttpMessage CreateGetMapTileRequest(MapTileSetId tilesetId, MapTileInde } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// Parameter group. /// /// The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below. @@ -130,11 +130,11 @@ public async Task> GetMapTi } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// Parameter group. /// /// The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below. @@ -197,11 +197,11 @@ internal HttpMessage CreateGetMapTilesetRequest(MapTileSetId tilesetId) } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The Get Map Tileset API allows users to request metadata for a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// The cancellation token to use. public async Task> GetMapTilesetAsync(MapTileSetId tilesetId, CancellationToken cancellationToken = default) { @@ -222,11 +222,11 @@ public async Task> GetMapTilesetAsync(MapTileSetId tilesetI } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The Get Map Tileset API allows users to request metadata for a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// The cancellation token to use. public Response GetMapTileset(MapTileSetId tilesetId, CancellationToken cancellationToken = default) { @@ -271,11 +271,11 @@ internal HttpMessage CreateGetMapAttributionRequest(MapTileSetId tilesetId, int } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// Zoom level for the desired map attribution. /// 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]`. /// The cancellation token to use. @@ -304,11 +304,11 @@ public async Task> GetMapAttributionAsync(MapTileSetId } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// Zoom level for the desired map attribution. /// 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]`. /// The cancellation token to use. @@ -359,7 +359,7 @@ internal HttpMessage CreateGetMapStateTileRequest(string statesetId, MapTileInde } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid)) /// @@ -394,7 +394,7 @@ public async Task> Get } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid)) /// @@ -448,7 +448,7 @@ internal HttpMessage CreateGetCopyrightCaptionRequest(ResponseFormat format) } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Copyrights API is designed to serve copyright information for Render Tile /// service. In addition to basic copyright for the whole map, API is serving @@ -478,7 +478,7 @@ public async Task> GetCopyrightCaptionAsync(ResponseF } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Copyrights API is designed to serve copyright information for Render Tile /// service. In addition to basic copyright for the whole map, API is serving @@ -577,7 +577,7 @@ internal HttpMessage CreateGetMapStaticImageRequest(RasterTileFormat format, Map } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. /// @@ -864,7 +864,7 @@ public async Task> G } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. /// @@ -1182,7 +1182,7 @@ internal HttpMessage CreateGetCopyrightFromBoundingBoxRequest(ResponseFormat for } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates /// @@ -1215,7 +1215,7 @@ public async Task> GetCopyrightFromBoundingBoxAsync(Re } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates /// @@ -1274,7 +1274,7 @@ internal HttpMessage CreateGetCopyrightForTileRequest(ResponseFormat format, Map } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions. /// Returns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid). @@ -1308,7 +1308,7 @@ public async Task> GetCopyrightForTileAsync(ResponseFo } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions. /// Returns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid). @@ -1365,7 +1365,7 @@ internal HttpMessage CreateGetCopyrightForWorldRequest(ResponseFormat format, In } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions. /// Returns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box. @@ -1392,7 +1392,7 @@ public async Task> GetCopyrightForWorldAsync(ResponseF } /// - /// **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// **Applies to:** see [pricing tiers](https://aka.ms/AzureMapsPricingTier). /// /// Copyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions. /// Returns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box. diff --git a/sdk/maps/Azure.Maps.Rendering/src/MapsRenderingClient.cs b/sdk/maps/Azure.Maps.Rendering/src/MapsRenderingClient.cs index 7a94b89fe0b49..cc6dc0b8bd3f9 100644 --- a/sdk/maps/Azure.Maps.Rendering/src/MapsRenderingClient.cs +++ b/sdk/maps/Azure.Maps.Rendering/src/MapsRenderingClient.cs @@ -64,7 +64,7 @@ public MapsRenderingClient(AzureKeyCredential credential, MapsRenderingClientOpt /// Initializes a new instance of MapsRenderingClient. /// A credential used to authenticate to an Azure Maps Render Service. - /// 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 for guidance. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following articles for guidance. public MapsRenderingClient(TokenCredential credential, string clientId) { Argument.AssertNotNull(credential, nameof(credential)); @@ -79,7 +79,7 @@ public MapsRenderingClient(TokenCredential credential, string clientId) /// Initializes a new instance of MapsRenderingClient. /// A credential used to authenticate to an Azure Maps Render Service. - /// 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 for guidance. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following articles for guidance. /// The options for configuring the client. public MapsRenderingClient(TokenCredential credential, string clientId, MapsRenderingClientOptions options) { @@ -126,7 +126,7 @@ public MapsRenderingClient(AzureSasCredential credential, MapsRenderingClientOpt /// The handler for diagnostic messaging in the client. /// The HTTP pipeline for sending and receiving REST requests and responses. /// server parameter. - /// 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 for guidance. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following articles for guidance. /// Api Version. /// or is null. internal MapsRenderingClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, Uri endpoint = null, string clientId = null, MapsRenderingClientOptions.ServiceVersion apiVersion = MapsRenderingClientOptions.LatestVersion) @@ -418,7 +418,7 @@ public virtual Response GetMapTile(GetMapTileOptions options, Cancellati /// /// The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// Zoom level for the desired map attribution. Available values are 0 to 22. /// The that represents the rectangular area of a bounding box. /// The cancellation token to use. @@ -454,7 +454,7 @@ public virtual async Task>> GetMapCopyrightAttrib /// /// The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// Zoom level for the desired map attribution. Available values are 0 to 22. /// The that represents the rectangular area of a bounding box. /// The cancellation token to use. @@ -489,7 +489,7 @@ public virtual Response> GetMapCopyrightAttribution(MapTil /// /// The Get Map Tileset API allows users to request metadata for a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// The cancellation token to use. /// is null. public virtual async Task> GetMapTileSetAsync(MapTileSetId tileSetId, CancellationToken cancellationToken = default) @@ -514,7 +514,7 @@ public virtual async Task> GetMapTileSetAsync(MapTileSetId /// /// The Get Map Tileset API allows users to request metadata for a tileset. /// - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. /// The cancellation token to use. /// is null. public virtual Response GetMapTileSet(MapTileSetId tileSetId, CancellationToken cancellationToken = default) diff --git a/sdk/maps/Azure.Maps.Rendering/src/Models/MapTileIndex.cs b/sdk/maps/Azure.Maps.Rendering/src/Models/MapTileIndex.cs index 1675d671ec457..1fc81a13039f4 100644 --- a/sdk/maps/Azure.Maps.Rendering/src/Models/MapTileIndex.cs +++ b/sdk/maps/Azure.Maps.Rendering/src/Models/MapTileIndex.cs @@ -14,15 +14,15 @@ public partial class MapTileIndex /// Initializes a new instance of MapTileIndex. /// /// X coordinate of the tile on zoom grid. Value must be in the range [0, (2^zoom)-1]]. - /// Please see Zoom Levels and Tile Grid for details. + /// Please see Zoom Levels and Tile Grid for details. /// /// /// Y coordinate of the tile on zoom grid. Value must be in the range [0, (2^zoom)-1]]. - /// Please see Zoom Levels and Tile Grid for details. + /// Please see Zoom Levels and Tile Grid for details. /// /// /// Zoom level for the desired tile. - /// Please see Zoom Levels and Tile Grid for details. + /// Please see Zoom Levels and Tile Grid for details. /// public MapTileIndex(int x, int y, int z) { diff --git a/sdk/maps/Azure.Maps.Rendering/src/Models/Options/GetMapTileOptions.cs b/sdk/maps/Azure.Maps.Rendering/src/Models/Options/GetMapTileOptions.cs index 0e3b73c9033b5..e1d63a10f1352 100644 --- a/sdk/maps/Azure.Maps.Rendering/src/Models/Options/GetMapTileOptions.cs +++ b/sdk/maps/Azure.Maps.Rendering/src/Models/Options/GetMapTileOptions.cs @@ -25,7 +25,7 @@ public GetMapTileOptions(MapTileSetId mapTileSetId, MapTileIndex mapTileIndex) MapTileIndex = mapTileIndex; } - /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. + /// A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a to use when making requests. The for tilesets created using Azure Maps Creator are generated through the Tileset Create API. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. public MapTileSetId MapTileSetId { get; } /// /// Zoom level, and coordinate of the tile on zoom grid. diff --git a/sdk/maps/Azure.Maps.Rendering/src/autorest.md b/sdk/maps/Azure.Maps.Rendering/src/autorest.md index 3b6a0388d2721..35048568a4233 100644 --- a/sdk/maps/Azure.Maps.Rendering/src/autorest.md +++ b/sdk/maps/Azure.Maps.Rendering/src/autorest.md @@ -8,7 +8,7 @@ Run `dotnet build /t:GenerateCode` to generate code. ``` yaml input-file: -- https://raw.githubusercontent.com/Azure/azure-rest-api-specs/ca95eb5342d848ab71387be54048c509f9c63b70/specification/maps/data-plane/Render/stable/2022-08-01/render.json +- https://raw.githubusercontent.com/Azure/azure-rest-api-specs/3e81da30a1358b6ffcbc7ff222aae5f483971d32/specification/maps/data-plane/Render/stable/2022-08-01/render.json title: MapsRenderingClient openapi-type: data-plane tag: 2.0 diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/MapsRoutingModelFactory.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/MapsRoutingModelFactory.cs index 03f9df9e98a76..aa05c8ec18a8f 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/MapsRoutingModelFactory.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/MapsRoutingModelFactory.cs @@ -30,8 +30,8 @@ public static RouteMatrixResult RouteMatrixResult(string formatVersion = null, I /// Length In Meters property. /// Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data. /// Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. - /// The estimated departure time for the route or leg. - /// The estimated arrival time for the route or leg. + /// The estimated departure time for the route or leg. Time is in UTC. + /// The estimated arrival time for the route or leg. Time is in UTC. /// Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query. /// Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query. /// Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query. diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/ResponseSectionType.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/ResponseSectionType.cs index f27843507a9b5..934296bc4a0a9 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/ResponseSectionType.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/ResponseSectionType.cs @@ -37,7 +37,7 @@ public ResponseSectionType(string value) /// Sections of the route that are cars or trains. public static ResponseSectionType CarOrTrain { get; } = new ResponseSectionType(CarOrTrainValue); - /// Sections indicating which countries the route is in. + /// Sections indicating which countries/regions the route is in. public static ResponseSectionType Country { get; } = new ResponseSectionType(CountryValue); /// Sections of the route that are ferries. public static ResponseSectionType Ferry { get; } = new ResponseSectionType(FerryValue); diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteDirectionParameters.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteDirectionParameters.cs index eef041b286be4..6d2842bad7b30 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteDirectionParameters.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteDirectionParameters.cs @@ -26,8 +26,8 @@ public partial class RouteDirectionParameters /// ignored for the calculation of the reference route's travel time and traffic delay. /// Please refer to [Supporting Points](https://docs.microsoft.com/azure/azure-maps/how-to-use-best-practices-for-routing#calculate-and-bias-alternative-routes-using-supporting-points) for details. /// - /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. - /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. + /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries/regions not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. + /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries/regions X is equivalent to specifying **avoidVignette** with all countries/regions but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. /// A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude. internal RouteDirectionParameters(GeoJsonGeometryCollection geoJsonSupportingPoints, IList avoidVignette, IList allowVignette, GeoJsonMultiPolygon geoJsonAvoidAreas) { @@ -36,9 +36,9 @@ internal RouteDirectionParameters(GeoJsonGeometryCollection geoJsonSupportingPoi AllowVignette = allowVignette; _GeoJsonAvoidAreas = geoJsonAvoidAreas; } - /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. + /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which all toll roads with vignettes are to be avoided, e.g. "AUS,CHE". Toll roads with vignettes in countries/regions not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**. public IList AvoidVignette { get; } - /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. + /// This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries/regions in which toll roads with vignettes are allowed, e.g. "AUS,CHE". Specifying **allowVignette** with some countries/regions X is equivalent to specifying **avoidVignette** with all countries/regions but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**. public IList AllowVignette { get; } } } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteInstruction.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteInstruction.cs index 24bfa4971016d..0969b8e18a219 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteInstruction.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteInstruction.cs @@ -37,7 +37,7 @@ internal RouteInstruction() public string SignpostText { get; } /// 3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code. E.g. USA. public string CountryCode { get; } - /// A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries like the US, Canada, and Mexico. + /// A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries/regions like the US, Canada, and Mexico. public string StateCode { get; } /// The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout. public JunctionType? JunctionType { get; } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteLegSummary.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteLegSummary.cs index 0dd41314f9f29..74f888a6f3b09 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteLegSummary.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteLegSummary.cs @@ -21,8 +21,8 @@ internal RouteLegSummary() /// Length In Meters property. /// Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data. /// Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. - /// The estimated departure time for the route or leg. - /// The estimated arrival time for the route or leg. + /// The estimated departure time for the route or leg. Time is in UTC. + /// The estimated arrival time for the route or leg. Time is in UTC. /// Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query. /// Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query. /// Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query. @@ -48,9 +48,9 @@ internal RouteLegSummary(int? lengthInMeters, int? travelTimeInSeconds, int? tra public int? TravelTimeInSeconds { get; } /// Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. public int? TrafficDelayInSeconds { get; } - /// The estimated departure time for the route or leg. + /// The estimated departure time for the route or leg. Time is in UTC. public DateTimeOffset? DepartureTime { get; } - /// The estimated arrival time for the route or leg. + /// The estimated arrival time for the route or leg. Time is in UTC. public DateTimeOffset? ArrivalTime { get; } /// Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query. public int? NoTrafficTravelTimeInSeconds { get; } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteSummary.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteSummary.cs index 45d15e9fa8872..865694feee227 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteSummary.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/RouteSummary.cs @@ -19,9 +19,9 @@ internal RouteSummary() /// Length In Meters property. public int? LengthInMeters { get; } - /// The estimated departure time for the route or leg. + /// The estimated departure time for the route or leg. Time is in UTC. public DateTimeOffset? DepartureTime { get; } - /// The estimated arrival time for the route or leg. + /// The estimated arrival time for the route or leg. Time is in UTC. public DateTimeOffset? ArrivalTime { get; } } } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/SectionType.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/SectionType.cs index 605c9c8cb5177..47c2df2cb9a86 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/Models/SectionType.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/Models/SectionType.cs @@ -37,7 +37,7 @@ public SectionType(string value) /// Sections of the route that are cars or trains. public static SectionType CarOrTrain { get; } = new SectionType(CarOrTrainValue); - /// Sections indicating which countries the route is in. + /// Sections indicating which countries/regions the route is in. public static SectionType Country { get; } = new SectionType(CountryValue); /// Sections of the route that are ferries. public static SectionType Ferry { get; } = new SectionType(FerryValue); diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteDirectionsBatchHeaders.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteDirectionsBatchHeaders.cs index 3f7ec1752f755..b8cb92fb9a1fa 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteDirectionsBatchHeaders.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteDirectionsBatchHeaders.cs @@ -16,7 +16,7 @@ public RouteGetRouteDirectionsBatchHeaders(Response response) { _response = response; } - /// New URL to check for the results of the long running process. + /// New URL to check for the results of the long-running operation. public string Location => _response.Headers.TryGetValue("Location", out string value) ? value : null; } } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteMatrixHeaders.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteMatrixHeaders.cs index a8b714a6d5b64..aa8d236ad463c 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteMatrixHeaders.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteGetRouteMatrixHeaders.cs @@ -16,7 +16,7 @@ public RouteGetRouteMatrixHeaders(Response response) { _response = response; } - /// New URL to check for the results of the long running process. + /// New URL to check for the results of the long-running operation. public string Location => _response.Headers.TryGetValue("Location", out string value) ? value : null; } } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteDirectionsBatchHeaders.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteDirectionsBatchHeaders.cs index 0deb60eee76fc..72749fc4f02c4 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteDirectionsBatchHeaders.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteDirectionsBatchHeaders.cs @@ -16,7 +16,7 @@ public RouteRequestRouteDirectionsBatchHeaders(Response response) { _response = response; } - /// New URL to check for the results of the long running process. + /// New URL to check for the results of the long-running operation. public string Location => _response.Headers.TryGetValue("Location", out string value) ? value : null; } } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteMatrixHeaders.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteMatrixHeaders.cs index 57122c5e394e1..de7709222efe6 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteMatrixHeaders.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRequestRouteMatrixHeaders.cs @@ -16,7 +16,7 @@ public RouteRequestRouteMatrixHeaders(Response response) { _response = response; } - /// New URL to check for the results of the long running process. + /// New URL to check for the results of the long-running operation. public string Location => _response.Headers.TryGetValue("Location", out string value) ? value : null; } } diff --git a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRestClient.cs b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRestClient.cs index 1aad0bc463ab9..744914f892daf 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRestClient.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Generated/RouteRestClient.cs @@ -31,7 +31,7 @@ internal partial class RouteRestClient /// The handler for diagnostic messaging in the client. /// The HTTP pipeline for sending and receiving REST requests and responses. /// server parameter. - /// 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. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. /// Api Version. /// , or is null. public RouteRestClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, Uri endpoint = null, string clientId = null, string apiVersion = "1.0") @@ -141,11 +141,43 @@ internal HttpMessage CreateRequestRouteMatrixRequest(JsonFormat format, RouteMat return message; } - /// + /// Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request. + /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. + /// The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. + /// Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. + /// Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. + /// Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car. + /// The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime. + /// The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00). + /// Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. + /// Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. + /// Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. + /// Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. + /// + /// Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. /// - /// The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. + /// * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. + /// + /// Weight of the vehicle in kilograms. + /// Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. + /// Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. + /// The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In **calculateReachableRange** requests, the values bicycle and pedestrian must not be used. + /// Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used. + /// + /// Possible values: + /// * true - Do consider all available traffic information during routing + /// * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored + /// during routing, the effect of historic traffic on effective road speeds is still incorporated. + /// + /// The type of route requested. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// The cancellation token to use. + /// is null. + /// + /// + /// The `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. /// /// /// For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. @@ -211,7 +243,28 @@ internal HttpMessage CreateRequestRouteMatrixRequest(JsonFormat format, RouteMat /// > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time. /// /// > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results. - /// + /// + public async Task> RequestRouteMatrixAsync(JsonFormat format, RouteMatrixQuery routeMatrixQuery, bool? waitForResults = null, TravelTimeType? computeTravelTime = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, CancellationToken cancellationToken = default) + { + if (routeMatrixQuery == null) + { + throw new ArgumentNullException(nameof(routeMatrixQuery)); + } + + using var message = CreateRequestRouteMatrixRequest(format, routeMatrixQuery, waitForResults, computeTravelTime, filterSectionType, arriveAt, departAt, vehicleAxleWeight, vehicleLength, vehicleHeight, vehicleWidth, vehicleMaxSpeed, vehicleWeight, windingness, inclineLevel, travelMode, avoid, useTrafficData, routeType, vehicleLoadType); + await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); + var headers = new RouteRequestRouteMatrixHeaders(message.Response); + switch (message.Response.Status) + { + case 200: + case 202: + return ResponseWithHeaders.FromValue(headers, message.Response); + default: + throw new RequestFailedException(message.Response); + } + } + + /// Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request. /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. /// Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. @@ -242,34 +295,12 @@ internal HttpMessage CreateRequestRouteMatrixRequest(JsonFormat format, RouteMat /// during routing, the effect of historic traffic on effective road speeds is still incorporated. /// /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// The cancellation token to use. /// is null. - public async Task> RequestRouteMatrixAsync(JsonFormat format, RouteMatrixQuery routeMatrixQuery, bool? waitForResults = null, TravelTimeType? computeTravelTime = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, CancellationToken cancellationToken = default) - { - if (routeMatrixQuery == null) - { - throw new ArgumentNullException(nameof(routeMatrixQuery)); - } - - using var message = CreateRequestRouteMatrixRequest(format, routeMatrixQuery, waitForResults, computeTravelTime, filterSectionType, arriveAt, departAt, vehicleAxleWeight, vehicleLength, vehicleHeight, vehicleWidth, vehicleMaxSpeed, vehicleWeight, windingness, inclineLevel, travelMode, avoid, useTrafficData, routeType, vehicleLoadType); - await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); - var headers = new RouteRequestRouteMatrixHeaders(message.Response); - switch (message.Response.Status) - { - case 200: - case 202: - return ResponseWithHeaders.FromValue(headers, message.Response); - default: - throw new RequestFailedException(message.Response); - } - } - - /// + /// /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. + /// The `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. /// /// /// For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. @@ -335,40 +366,7 @@ public async Task> RequestRo /// > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time. /// /// > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results. - /// - /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. - /// The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. - /// Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. - /// Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. - /// Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car. - /// The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime. - /// The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00). - /// Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. - /// Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. - /// Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. - /// Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. - /// - /// Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. - /// - /// * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. - /// - /// * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. - /// - /// Weight of the vehicle in kilograms. - /// Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. - /// Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. - /// The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In **calculateReachableRange** requests, the values bicycle and pedestrian must not be used. - /// Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used. - /// - /// Possible values: - /// * true - Do consider all available traffic information during routing - /// * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored - /// during routing, the effect of historic traffic on effective road speeds is still incorporated. - /// - /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. - /// The cancellation token to use. - /// is null. + /// public ResponseWithHeaders RequestRouteMatrix(JsonFormat format, RouteMatrixQuery routeMatrixQuery, bool? waitForResults = null, TravelTimeType? computeTravelTime = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, CancellationToken cancellationToken = default) { if (routeMatrixQuery == null) @@ -408,10 +406,58 @@ internal HttpMessage CreateGetRouteMatrixRequest(string matrixId) return message; } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations. + /// Matrix id received after the Matrix Route request was accepted successfully. + /// The cancellation token to use. + /// is null. + /// + /// + /// The `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing). + /// + /// For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. + /// + /// + /// For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. + /// + /// + /// The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations). + /// + /// + /// + /// ### Submit Synchronous Route Matrix Request + /// If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square). + /// + /// ``` + /// GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key} + /// ``` + /// + /// ### Submit Asynchronous Route Matrix Request + /// The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds. + /// + /// + /// The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square). + /// + /// + /// The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. + /// /// - /// If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following: + /// + /// + /// ``` + /// GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key} + /// ``` + /// + /// Here's a typical sequence of asynchronous operations: + /// 1. Client sends a Route Matrix GET request to Azure Maps + /// + /// 2. The server will respond with one of the following: + /// + /// > HTTP `202 Accepted` - Route Matrix request has been accepted. + /// + /// > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code. + /// + /// + /// 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following: /// /// ``` /// GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key} @@ -421,7 +467,7 @@ internal HttpMessage CreateGetRouteMatrixRequest(string matrixId) /// 4. Client issues a GET request on the download URL obtained in Step 3 to download the results /// /// ### Download Sync Results - /// When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later. + /// When you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later. /// /// ### Download Async Results /// When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following: @@ -434,10 +480,7 @@ internal HttpMessage CreateGetRouteMatrixRequest(string matrixId) /// > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time. /// /// > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results. - /// - /// Matrix id received after the Matrix Route request was accepted successfully. - /// The cancellation token to use. - /// is null. + /// public async Task> GetRouteMatrixAsync(string matrixId, CancellationToken cancellationToken = default) { if (matrixId == null) @@ -458,10 +501,58 @@ public async Task> GetRouteMatri } } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations. + /// Matrix id received after the Matrix Route request was accepted successfully. + /// The cancellation token to use. + /// is null. + /// + /// + /// The `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing). /// - /// If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following: + /// For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. + /// + /// + /// For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. + /// + /// + /// The maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations). + /// + /// + /// + /// ### Submit Synchronous Route Matrix Request + /// If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square). + /// + /// ``` + /// GET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key} + /// ``` + /// + /// ### Submit Asynchronous Route Matrix Request + /// The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds. + /// + /// + /// The maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square). + /// + /// + /// The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. + /// + /// + /// + /// + /// ``` + /// GET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key} + /// ``` + /// + /// Here's a typical sequence of asynchronous operations: + /// 1. Client sends a Route Matrix GET request to Azure Maps + /// + /// 2. The server will respond with one of the following: + /// + /// > HTTP `202 Accepted` - Route Matrix request has been accepted. + /// + /// > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code. + /// + /// + /// 3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following: /// /// ``` /// GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key} @@ -471,7 +562,7 @@ public async Task> GetRouteMatri /// 4. Client issues a GET request on the download URL obtained in Step 3 to download the results /// /// ### Download Sync Results - /// When you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later. + /// When you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later. /// /// ### Download Async Results /// When a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following: @@ -484,10 +575,7 @@ public async Task> GetRouteMatri /// > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time. /// /// > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results. - /// - /// Matrix id received after the Matrix Route request was accepted successfully. - /// The cancellation token to use. - /// is null. + /// public ResponseWithHeaders GetRouteMatrix(string matrixId, CancellationToken cancellationToken = default) { if (matrixId == null) @@ -606,11 +694,43 @@ internal HttpMessage CreateRequestRouteMatrixSyncRequest(JsonFormat format, Rout return message; } - /// + /// Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using a synchronous request. + /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. + /// The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. + /// Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. + /// Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. + /// Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car. + /// The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime. + /// The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00). + /// Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. + /// Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. + /// Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. + /// Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. + /// + /// Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. /// - /// The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. + /// * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. + /// + /// Weight of the vehicle in kilograms. + /// Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. + /// Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. + /// The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In **calculateReachableRange** requests, the values bicycle and pedestrian must not be used. + /// Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used. + /// + /// Possible values: + /// * true - Do consider all available traffic information during routing + /// * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored + /// during routing, the effect of historic traffic on effective road speeds is still incorporated. + /// + /// The type of route requested. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// The cancellation token to use. + /// is null. + /// + /// + /// The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. /// /// /// For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. @@ -676,7 +796,31 @@ internal HttpMessage CreateRequestRouteMatrixSyncRequest(JsonFormat format, Rout /// > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time. /// /// > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results. - /// + /// + public async Task> RequestRouteMatrixSyncAsync(JsonFormat format, RouteMatrixQuery routeMatrixQuery, bool? waitForResults = null, TravelTimeType? computeTravelTime = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, CancellationToken cancellationToken = default) + { + if (routeMatrixQuery == null) + { + throw new ArgumentNullException(nameof(routeMatrixQuery)); + } + + using var message = CreateRequestRouteMatrixSyncRequest(format, routeMatrixQuery, waitForResults, computeTravelTime, filterSectionType, arriveAt, departAt, vehicleAxleWeight, vehicleLength, vehicleHeight, vehicleWidth, vehicleMaxSpeed, vehicleWeight, windingness, inclineLevel, travelMode, avoid, useTrafficData, routeType, vehicleLoadType); + await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); + switch (message.Response.Status) + { + case 200: + { + RouteMatrixResult value = default; + using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); + value = RouteMatrixResult.DeserializeRouteMatrixResult(document.RootElement); + return Response.FromValue(value, message.Response); + } + default: + throw new RequestFailedException(message.Response); + } + } + + /// Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using a synchronous request. /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. /// Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. @@ -707,37 +851,12 @@ internal HttpMessage CreateRequestRouteMatrixSyncRequest(JsonFormat format, Rout /// during routing, the effect of historic traffic on effective road speeds is still incorporated. /// /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// The cancellation token to use. /// is null. - public async Task> RequestRouteMatrixSyncAsync(JsonFormat format, RouteMatrixQuery routeMatrixQuery, bool? waitForResults = null, TravelTimeType? computeTravelTime = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, CancellationToken cancellationToken = default) - { - if (routeMatrixQuery == null) - { - throw new ArgumentNullException(nameof(routeMatrixQuery)); - } - - using var message = CreateRequestRouteMatrixSyncRequest(format, routeMatrixQuery, waitForResults, computeTravelTime, filterSectionType, arriveAt, departAt, vehicleAxleWeight, vehicleLength, vehicleHeight, vehicleWidth, vehicleMaxSpeed, vehicleWeight, windingness, inclineLevel, travelMode, avoid, useTrafficData, routeType, vehicleLoadType); - await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); - switch (message.Response.Status) - { - case 200: - { - RouteMatrixResult value = default; - using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); - value = RouteMatrixResult.DeserializeRouteMatrixResult(document.RootElement); - return Response.FromValue(value, message.Response); - } - default: - throw new RequestFailedException(message.Response); - } - } - - /// - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// /// - /// The Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. + /// The `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API. /// /// /// For each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. @@ -803,40 +922,7 @@ public async Task> RequestRouteMatrixSyncAsync(JsonF /// > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time. /// /// > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results. - /// - /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. - /// The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API. - /// Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**. - /// Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. - /// Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car. - /// The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime. - /// The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00). - /// Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. - /// Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. - /// Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. - /// Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. - /// - /// Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. - /// - /// * A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. - /// - /// * A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour. - /// - /// Weight of the vehicle in kilograms. - /// Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. - /// Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling. - /// The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be "other". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In **calculateReachableRange** requests, the values bicycle and pedestrian must not be used. - /// Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used. - /// - /// Possible values: - /// * true - Do consider all available traffic information during routing - /// * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored - /// during routing, the effect of historic traffic on effective road speeds is still incorporated. - /// - /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. - /// The cancellation token to use. - /// is null. + /// public Response RequestRouteMatrixSync(JsonFormat format, RouteMatrixQuery routeMatrixQuery, bool? waitForResults = null, TravelTimeType? computeTravelTime = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, CancellationToken cancellationToken = default) { if (routeMatrixQuery == null) @@ -1047,16 +1133,7 @@ internal HttpMessage CreateGetRouteDirectionsRequest(ResponseFormat format, stri return message; } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// - /// Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. - /// - /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. - /// - /// Routing service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved. - /// + /// Use to calculate a route between a specified origin and destination, passing through any specified waypoints. /// Desired format of the response. Value can be either _json_ or _xml_. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints. /// Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5. @@ -1130,7 +1207,7 @@ internal HttpMessage CreateGetRouteDirectionsRequest(ResponseFormat format, stri /// during routing, the effect of historic traffic on effective road speeds is still incorporated. /// /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. /// /// @@ -1257,6 +1334,14 @@ internal HttpMessage CreateGetRouteDirectionsRequest(ResponseFormat format, stri /// /// The cancellation token to use. /// is null. + /// + /// + /// The `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. + /// + /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. + /// + /// Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model). + /// public async Task> GetRouteDirectionsAsync(ResponseFormat format, string routePoints, int? maxAlternatives = null, AlternativeRouteType? alternativeType = null, int? minDeviationDistance = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? minDeviationTime = null, RouteInstructionsType? instructionsType = null, string language = null, bool? computeBestWaypointOrder = null, RouteRepresentationForBestOrder? routeRepresentationForBestOrder = null, TravelTimeType? computeTravelTime = null, int? vehicleHeading = null, Report? report = null, SectionType? filterSectionType = null, int? vehicleAxleWeight = null, double? vehicleWidth = null, double? vehicleHeight = null, double? vehicleLength = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, bool? isCommercialVehicle = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, VehicleEngineType? vehicleEngineType = null, string constantSpeedConsumptionInLitersPerHundredKm = null, double? currentFuelInLiters = null, double? auxiliaryPowerInLitersPerHour = null, double? fuelEnergyDensityInMegajoulesPerLiter = null, double? accelerationEfficiency = null, double? decelerationEfficiency = null, double? uphillEfficiency = null, double? downhillEfficiency = null, string constantSpeedConsumptionInKwHPerHundredKm = null, double? currentChargeInKwH = null, double? maxChargeInKwH = null, double? auxiliaryPowerInKw = null, CancellationToken cancellationToken = default) { if (routePoints == null) @@ -1280,16 +1365,7 @@ public async Task> GetRouteDirectionsAsync(ResponseFor } } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// - /// Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. - /// - /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. - /// - /// Routing service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved. - /// + /// Use to calculate a route between a specified origin and destination, passing through any specified waypoints. /// Desired format of the response. Value can be either _json_ or _xml_. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints. /// Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5. @@ -1363,7 +1439,7 @@ public async Task> GetRouteDirectionsAsync(ResponseFor /// during routing, the effect of historic traffic on effective road speeds is still incorporated. /// /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. /// /// @@ -1490,6 +1566,14 @@ public async Task> GetRouteDirectionsAsync(ResponseFor /// /// The cancellation token to use. /// is null. + /// + /// + /// The `Get Route Directions` API is an HTTP `GET` request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. + /// + /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. + /// + /// Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see [Consumption Model](/azure/azure-maps/consumption-model). + /// public Response GetRouteDirections(ResponseFormat format, string routePoints, int? maxAlternatives = null, AlternativeRouteType? alternativeType = null, int? minDeviationDistance = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? minDeviationTime = null, RouteInstructionsType? instructionsType = null, string language = null, bool? computeBestWaypointOrder = null, RouteRepresentationForBestOrder? routeRepresentationForBestOrder = null, TravelTimeType? computeTravelTime = null, int? vehicleHeading = null, Report? report = null, SectionType? filterSectionType = null, int? vehicleAxleWeight = null, double? vehicleWidth = null, double? vehicleHeight = null, double? vehicleLength = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, bool? isCommercialVehicle = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, VehicleEngineType? vehicleEngineType = null, string constantSpeedConsumptionInLitersPerHundredKm = null, double? currentFuelInLiters = null, double? auxiliaryPowerInLitersPerHour = null, double? fuelEnergyDensityInMegajoulesPerLiter = null, double? accelerationEfficiency = null, double? decelerationEfficiency = null, double? uphillEfficiency = null, double? downhillEfficiency = null, string constantSpeedConsumptionInKwHPerHundredKm = null, double? currentChargeInKwH = null, double? maxChargeInKwH = null, double? auxiliaryPowerInKw = null, CancellationToken cancellationToken = default) { if (routePoints == null) @@ -1704,16 +1788,7 @@ internal HttpMessage CreateGetRouteDirectionsWithAdditionalParametersRequest(Res return message; } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// - /// Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. - /// - /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. - /// - /// Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved. - /// + /// Use to calculate a route between a given origin and destination, passing through any specified waypoints. /// Desired format of the response. Value can be either _json_ or _xml_. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints. /// @@ -1794,7 +1869,7 @@ internal HttpMessage CreateGetRouteDirectionsWithAdditionalParametersRequest(Res /// during routing, the effect of historic traffic on effective road speeds is still incorporated. /// /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. /// /// @@ -1921,6 +1996,14 @@ internal HttpMessage CreateGetRouteDirectionsWithAdditionalParametersRequest(Res /// /// The cancellation token to use. /// or is null. + /// + /// + /// The `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. + /// + /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. + /// + /// Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved. + /// public async Task> GetRouteDirectionsWithAdditionalParametersAsync(ResponseFormat format, string routePoints, RouteDirectionParameters routeDirectionParameters, int? maxAlternatives = null, AlternativeRouteType? alternativeType = null, int? minDeviationDistance = null, int? minDeviationTime = null, RouteInstructionsType? instructionsType = null, string language = null, bool? computeBestWaypointOrder = null, RouteRepresentationForBestOrder? routeRepresentationForBestOrder = null, TravelTimeType? computeTravelTime = null, int? vehicleHeading = null, Report? report = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, bool? isCommercialVehicle = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, VehicleEngineType? vehicleEngineType = null, string constantSpeedConsumptionInLitersPerHundredKm = null, double? currentFuelInLiters = null, double? auxiliaryPowerInLitersPerHour = null, double? fuelEnergyDensityInMegajoulesPerLiter = null, double? accelerationEfficiency = null, double? decelerationEfficiency = null, double? uphillEfficiency = null, double? downhillEfficiency = null, string constantSpeedConsumptionInKwHPerHundredKm = null, double? currentChargeInKwH = null, double? maxChargeInKwH = null, double? auxiliaryPowerInKw = null, CancellationToken cancellationToken = default) { if (routePoints == null) @@ -1948,16 +2031,7 @@ public async Task> GetRouteDirectionsWithAdditionalPar } } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// - /// Returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. - /// - /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. - /// - /// Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved. - /// + /// Use to calculate a route between a given origin and destination, passing through any specified waypoints. /// Desired format of the response. Value can be either _json_ or _xml_. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints. /// @@ -2038,7 +2112,7 @@ public async Task> GetRouteDirectionsWithAdditionalPar /// during routing, the effect of historic traffic on effective road speeds is still incorporated. /// /// The type of route requested. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. /// /// @@ -2165,6 +2239,14 @@ public async Task> GetRouteDirectionsWithAdditionalPar /// /// The cancellation token to use. /// or is null. + /// + /// + /// The `Post Route Directions` API is an HTTP `POST` request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day. + /// + /// Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected. + /// + /// Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved. + /// public Response GetRouteDirectionsWithAdditionalParameters(ResponseFormat format, string routePoints, RouteDirectionParameters routeDirectionParameters, int? maxAlternatives = null, AlternativeRouteType? alternativeType = null, int? minDeviationDistance = null, int? minDeviationTime = null, RouteInstructionsType? instructionsType = null, string language = null, bool? computeBestWaypointOrder = null, RouteRepresentationForBestOrder? routeRepresentationForBestOrder = null, TravelTimeType? computeTravelTime = null, int? vehicleHeading = null, Report? report = null, SectionType? filterSectionType = null, DateTimeOffset? arriveAt = null, DateTimeOffset? departAt = null, int? vehicleAxleWeight = null, double? vehicleLength = null, double? vehicleHeight = null, double? vehicleWidth = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, bool? isCommercialVehicle = null, WindingnessLevel? windingness = null, InclineLevel? inclineLevel = null, TravelMode? travelMode = null, IEnumerable avoid = null, bool? useTrafficData = null, RouteType? routeType = null, VehicleLoadType? vehicleLoadType = null, VehicleEngineType? vehicleEngineType = null, string constantSpeedConsumptionInLitersPerHundredKm = null, double? currentFuelInLiters = null, double? auxiliaryPowerInLitersPerHour = null, double? fuelEnergyDensityInMegajoulesPerLiter = null, double? accelerationEfficiency = null, double? decelerationEfficiency = null, double? uphillEfficiency = null, double? downhillEfficiency = null, string constantSpeedConsumptionInKwHPerHundredKm = null, double? currentChargeInKwH = null, double? maxChargeInKwH = null, double? auxiliaryPowerInKw = null, CancellationToken cancellationToken = default) { if (routePoints == null) @@ -2346,16 +2428,7 @@ internal HttpMessage CreateGetRouteRangeRequest(ResponseFormat format, IEnumerab return message; } - /// - /// __Route Range (Isochrone) API__ - /// - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// This service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. - /// - /// The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone. - /// + /// Use to create a map that depicts the area accessible from a given point within a certain threshold based on time, distance or fuel capacity. /// Desired format of the response. Value can be either _json_ or _xml_. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The Coordinate from which the range calculation should start. /// Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model.<br> When fuelBudgetInLiters is used, it is mandatory to specify a detailed Combustion Consumption Model.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used. @@ -2399,7 +2472,7 @@ internal HttpMessage CreateGetRouteRangeRequest(ResponseFormat format, IEnumerab /// Sensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900 /// /// Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. /// /// @@ -2526,6 +2599,12 @@ internal HttpMessage CreateGetRouteRangeRequest(ResponseFormat format, IEnumerab /// /// The cancellation token to use. /// is null. + /// + /// + /// The `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. + /// + /// The returned polygon can be used for further processing such as [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to search for POIs within the provided isochrone. + /// public async Task> GetRouteRangeAsync(ResponseFormat format, IEnumerable query, double? fuelBudgetInLiters = null, double? energyBudgetInKwH = null, double? timeBudgetInSec = null, double? distanceBudgetInMeters = null, DateTimeOffset? departAt = null, RouteType? routeType = null, bool? useTrafficData = null, IEnumerable avoid = null, TravelMode? travelMode = null, InclineLevel? inclineLevel = null, WindingnessLevel? windingness = null, int? vehicleAxleWeight = null, double? vehicleWidth = null, double? vehicleHeight = null, double? vehicleLength = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, bool? isCommercialVehicle = null, VehicleLoadType? vehicleLoadType = null, VehicleEngineType? vehicleEngineType = null, string constantSpeedConsumptionInLitersPerHundredKm = null, double? currentFuelInLiters = null, double? auxiliaryPowerInLitersPerHour = null, double? fuelEnergyDensityInMegajoulesPerLiter = null, double? accelerationEfficiency = null, double? decelerationEfficiency = null, double? uphillEfficiency = null, double? downhillEfficiency = null, string constantSpeedConsumptionInKwHPerHundredKm = null, double? currentChargeInKwH = null, double? maxChargeInKwH = null, double? auxiliaryPowerInKw = null, CancellationToken cancellationToken = default) { if (query == null) @@ -2549,16 +2628,7 @@ public async Task> GetRouteRangeAsync(ResponseFormat } } - /// - /// __Route Range (Isochrone) API__ - /// - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// This service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. - /// - /// The returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone. - /// + /// Use to create a map that depicts the area accessible from a given point within a certain threshold based on time, distance or fuel capacity. /// Desired format of the response. Value can be either _json_ or _xml_. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. /// The Coordinate from which the range calculation should start. /// Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model.<br> When fuelBudgetInLiters is used, it is mandatory to specify a detailed Combustion Consumption Model.<br> Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used. @@ -2602,7 +2672,7 @@ public async Task> GetRouteRangeAsync(ResponseFormat /// Sensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900 /// /// Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**. /// /// @@ -2729,6 +2799,12 @@ public async Task> GetRouteRangeAsync(ResponseFormat /// /// The cancellation token to use. /// is null. + /// + /// + /// The `Get Route Range` (Isochrone) API is an HTTP `GET` request that will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. + /// + /// The returned polygon can be used for further processing such as [Search Inside Geometry](/rest/api/maps/search/post-search-inside-geometry) to search for POIs within the provided isochrone. + /// public Response GetRouteRange(ResponseFormat format, IEnumerable query, double? fuelBudgetInLiters = null, double? energyBudgetInKwH = null, double? timeBudgetInSec = null, double? distanceBudgetInMeters = null, DateTimeOffset? departAt = null, RouteType? routeType = null, bool? useTrafficData = null, IEnumerable avoid = null, TravelMode? travelMode = null, InclineLevel? inclineLevel = null, WindingnessLevel? windingness = null, int? vehicleAxleWeight = null, double? vehicleWidth = null, double? vehicleHeight = null, double? vehicleLength = null, int? vehicleMaxSpeed = null, int? vehicleWeight = null, bool? isCommercialVehicle = null, VehicleLoadType? vehicleLoadType = null, VehicleEngineType? vehicleEngineType = null, string constantSpeedConsumptionInLitersPerHundredKm = null, double? currentFuelInLiters = null, double? auxiliaryPowerInLitersPerHour = null, double? fuelEnergyDensityInMegajoulesPerLiter = null, double? accelerationEfficiency = null, double? decelerationEfficiency = null, double? uphillEfficiency = null, double? downhillEfficiency = null, string constantSpeedConsumptionInKwHPerHundredKm = null, double? currentChargeInKwH = null, double? maxChargeInKwH = null, double? auxiliaryPowerInKw = null, CancellationToken cancellationToken = default) { if (query == null) @@ -2775,15 +2851,15 @@ internal HttpMessage CreateRequestRouteDirectionsBatchRequest(JsonFormat format, return message; } - /// - /// **Route Directions Batch API** - /// - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// + /// Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request. + /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. + /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. + /// The cancellation token to use. + /// is null. + /// /// + /// The `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync). /// - /// The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. /// ### Submit Asynchronous Batch Request /// The Asynchronous API is appropriate for processing big volumes of relatively complex route requests /// - It allows the retrieval of results in a separate call (multiple downloads are possible). @@ -2793,7 +2869,7 @@ internal HttpMessage CreateRequestRouteDirectionsBatchRequest(JsonFormat format, /// When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. /// The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. /// - /// Please note that asynchronous batch request is a long-running request. Here's a typical sequence of operations: + /// Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: /// 1. Client sends a Route Directions Batch `POST` request to Azure Maps /// 2. The server will respond with one of the following: /// @@ -2925,11 +3001,7 @@ internal HttpMessage CreateRequestRouteDirectionsBatchRequest(JsonFormat format, /// ] /// } /// ``` - /// - /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. - /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. - /// The cancellation token to use. - /// is null. + /// public async Task> RequestRouteDirectionsBatchAsync(JsonFormat format, BatchRequest routeDirectionsBatchQueries, CancellationToken cancellationToken = default) { if (routeDirectionsBatchQueries == null) @@ -2950,15 +3022,15 @@ public async Task> } } - /// - /// **Route Directions Batch API** - /// - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// + /// Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request. + /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. + /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. + /// The cancellation token to use. + /// is null. + /// /// + /// The `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync). /// - /// The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. /// ### Submit Asynchronous Batch Request /// The Asynchronous API is appropriate for processing big volumes of relatively complex route requests /// - It allows the retrieval of results in a separate call (multiple downloads are possible). @@ -2968,7 +3040,7 @@ public async Task> /// When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. /// The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. /// - /// Please note that asynchronous batch request is a long-running request. Here's a typical sequence of operations: + /// Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: /// 1. Client sends a Route Directions Batch `POST` request to Azure Maps /// 2. The server will respond with one of the following: /// @@ -3100,11 +3172,7 @@ public async Task> /// ] /// } /// ``` - /// - /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. - /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. - /// The cancellation token to use. - /// is null. + /// public ResponseWithHeaders RequestRouteDirectionsBatch(JsonFormat format, BatchRequest routeDirectionsBatchQueries, CancellationToken cancellationToken = default) { if (routeDirectionsBatchQueries == null) @@ -3144,8 +3212,13 @@ internal HttpMessage CreateGetRouteDirectionsBatchRequest(string batchId) return message; } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request. + /// Batch id for querying the operation. + /// The cancellation token to use. + /// is null. + /// + /// + /// The `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. /// /// ### Download Asynchronous Batch Results /// To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: @@ -3244,10 +3317,7 @@ internal HttpMessage CreateGetRouteDirectionsBatchRequest(string batchId) /// ] /// } /// ``` - /// - /// Batch id for querying the operation. - /// The cancellation token to use. - /// is null. + /// public async Task> GetRouteDirectionsBatchAsync(string batchId, CancellationToken cancellationToken = default) { if (batchId == null) @@ -3268,8 +3338,13 @@ public async Task> GetR } } - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). + /// Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request. + /// Batch id for querying the operation. + /// The cancellation token to use. + /// is null. + /// + /// + /// The `Get Route Directions Batch` API is an HTTP `GET` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single request. You can call `Get Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. /// /// ### Download Asynchronous Batch Results /// To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: @@ -3368,10 +3443,7 @@ public async Task> GetR /// ] /// } /// ``` - /// - /// Batch id for querying the operation. - /// The cancellation token to use. - /// is null. + /// public ResponseWithHeaders GetRouteDirectionsBatch(string batchId, CancellationToken cancellationToken = default) { if (batchId == null) @@ -3415,15 +3487,14 @@ internal HttpMessage CreateRequestRouteDirectionsBatchSyncRequest(JsonFormat for return message; } - /// - /// **Route Directions Batch API** - /// - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// + /// Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single synchronous request. + /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. + /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. + /// The cancellation token to use. + /// is null. + /// /// - /// The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. + /// The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch). /// ### Submit Synchronous Batch Request /// The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. /// ``` @@ -3510,11 +3581,7 @@ internal HttpMessage CreateRequestRouteDirectionsBatchSyncRequest(JsonFormat for /// ] /// } /// ``` - /// - /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. - /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. - /// The cancellation token to use. - /// is null. + /// public async Task> RequestRouteDirectionsBatchSyncAsync(JsonFormat format, BatchRequest routeDirectionsBatchQueries, CancellationToken cancellationToken = default) { if (routeDirectionsBatchQueries == null) @@ -3538,15 +3605,14 @@ public async Task> RequestRouteDirectionsBa } } - /// - /// **Route Directions Batch API** - /// - /// - /// **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). - /// - /// + /// Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single synchronous request. + /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. + /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. + /// The cancellation token to use. + /// is null. + /// /// - /// The Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. + /// The `Post Route Directions Batch Sync` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single synchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a asynchronous request, see [Post Route Directions Batch](/rest/api/maps/route/post-route-directions-batch). /// ### Submit Synchronous Batch Request /// The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. /// ``` @@ -3633,11 +3699,7 @@ public async Task> RequestRouteDirectionsBa /// ] /// } /// ``` - /// - /// Desired format of the response. Only `json` format is supported. The default value is AutoRest.CSharp.Output.Models.Types.EnumTypeValue. - /// The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query. - /// The cancellation token to use. - /// is null. + /// public Response RequestRouteDirectionsBatchSync(JsonFormat format, BatchRequest routeDirectionsBatchQueries, CancellationToken cancellationToken = default) { if (routeDirectionsBatchQueries == null) diff --git a/sdk/maps/Azure.Maps.Routing/src/MapsRoutingClient.cs b/sdk/maps/Azure.Maps.Routing/src/MapsRoutingClient.cs index dee9e798bbd5c..85c3312cbf587 100644 --- a/sdk/maps/Azure.Maps.Routing/src/MapsRoutingClient.cs +++ b/sdk/maps/Azure.Maps.Routing/src/MapsRoutingClient.cs @@ -67,9 +67,9 @@ public MapsRoutingClient(AzureKeyCredential credential, MapsRoutingClientOptions /// Initializes a new instance of MapsRoutingClient. /// A credential used to authenticate to an Azure Maps Route Service. - /// Specifies which account is intended for usage in conjunction with the Azure AD security model. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 for guidance. + /// To use Microsoft Entra ID security in Azure Maps see the following articles for guidance. /// /// or is null. public MapsRoutingClient(TokenCredential credential, string clientId) @@ -86,9 +86,9 @@ public MapsRoutingClient(TokenCredential credential, string clientId) /// Initializes a new instance of MapsRoutingClient. /// A credential used to authenticate to an Azure Maps Route Service. - /// Specifies which account is intended for usage in conjunction with the Azure AD security model. + /// Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 for guidance. + /// To use Microsoft Entra ID security in Azure Maps see the following articles for guidance. /// /// The options for configuring the client. /// or is null. diff --git a/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteDirectionOptions.cs b/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteDirectionOptions.cs index 9586593efcc85..60222034f5d31 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteDirectionOptions.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteDirectionOptions.cs @@ -131,7 +131,7 @@ public RouteDirectionOptions() /// Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. public bool? IsCommercialVehicle { get; set; } - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. public VehicleLoadType? VehicleLoadType { get; set; } /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of vehicleEngineType. diff --git a/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteMatrixOptions.cs b/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteMatrixOptions.cs index be3ee6688778b..098ace55fb039 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteMatrixOptions.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteMatrixOptions.cs @@ -100,7 +100,7 @@ public RouteMatrixOptions(RouteMatrixQuery query) public RouteType? RouteType { get; set; } /// - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available VehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. VehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available VehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. VehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. /// Allowed values: VehicleLoadType.USHazmatClass1, VehicleLoadType.USHazmatClass2, VehicleLoadType.USHazmatClass3, VehicleLoadType.USHazmatClass4, VehicleLoadType.USHazmatClass5, VehicleLoadType.USHazmatClass6, VehicleLoadType.USHazmatClass7, VehicleLoadType.USHazmatClass8, VehicleLoadType.USHazmatClass9, VehicleLoadType.OtherHazmatExplosive, VehicleLoadType.OtherHazmatGeneral, or VehicleLoadType.OtherHazmatHarmfulToWater. /// public VehicleLoadType? VehicleLoadType { get; set; } diff --git a/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteRangeOptions.cs b/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteRangeOptions.cs index 7960639d15b6b..4f2148390cec0 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteRangeOptions.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Models/Options/RouteRangeOptions.cs @@ -121,7 +121,7 @@ public RouteRangeOptions(GeoPosition routeRangePoint) /// Whether the vehicle is used for commercial purposes. Commercial vehicles may not be allowed to drive on some roads. public bool? IsCommercialVehicle { get; set; } - /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. + /// Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries/regions. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries/regions. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. public VehicleLoadType? VehicleLoadType { get; set; } /// Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of vehicleEngineType. diff --git a/sdk/maps/Azure.Maps.Routing/src/Models/RouteSummary.cs b/sdk/maps/Azure.Maps.Routing/src/Models/RouteSummary.cs index 24ac206e8131d..fb2ae6f405e17 100644 --- a/sdk/maps/Azure.Maps.Routing/src/Models/RouteSummary.cs +++ b/sdk/maps/Azure.Maps.Routing/src/Models/RouteSummary.cs @@ -15,8 +15,8 @@ public partial class RouteSummary /// Length In Meters property. /// Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data. /// Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added. - /// The estimated departure time for the route or leg. - /// The estimated arrival time for the route or leg. + /// The estimated departure time for the route or leg. Time is in UTC. + /// The estimated arrival time for the route or leg. Time is in UTC. internal RouteSummary(int? lengthInMeters, int? travelTimeInSeconds, int? trafficDelayInSeconds, DateTimeOffset? departureTime, DateTimeOffset? arrivalTime) { LengthInMeters = lengthInMeters; diff --git a/sdk/maps/Azure.Maps.Routing/src/autorest.md b/sdk/maps/Azure.Maps.Routing/src/autorest.md index 878c424fa82a8..f9607d5bb32b6 100644 --- a/sdk/maps/Azure.Maps.Routing/src/autorest.md +++ b/sdk/maps/Azure.Maps.Routing/src/autorest.md @@ -7,7 +7,7 @@ Run `dotnet build /t:GenerateCode` to generate code. ``` yaml input-file: -- https://github.com/Azure/azure-rest-api-specs/blob/807be3531d94f102314595541ba826c64e69b3b6/specification/maps/data-plane/Route/preview/1.0/route.json +- https://github.com/Azure/azure-rest-api-specs/blob/3e81da30a1358b6ffcbc7ff222aae5f483971d32/specification/maps/data-plane/Route/preview/1.0/route.json title: RouteClient openapi-type: data-plane tag: 1.0