From c777b39871abc4fb608d144e4ec42df394d2b18b Mon Sep 17 00:00:00 2001 From: Charlie Chen Date: Mon, 9 Dec 2024 23:05:33 +0800 Subject: [PATCH] Update Maps TimeZone configs and readme (#47466) * Update configs and readme * Update timezone changelog --- sdk/maps/Azure.Maps.TimeZones/CHANGELOG.md | 2 +- sdk/maps/Azure.Maps.TimeZones/README.md | 2 +- sdk/maps/README.md | 10 +++++----- sdk/maps/ci.yml | 2 ++ 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/sdk/maps/Azure.Maps.TimeZones/CHANGELOG.md b/sdk/maps/Azure.Maps.TimeZones/CHANGELOG.md index 3f2cb968cbeb1..db42dc1d57c6c 100644 --- a/sdk/maps/Azure.Maps.TimeZones/CHANGELOG.md +++ b/sdk/maps/Azure.Maps.TimeZones/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 1.0.0-beta.1 (Unreleased) +## 1.0.0-beta.1 (2024-12-10) ### Features Added diff --git a/sdk/maps/Azure.Maps.TimeZones/README.md b/sdk/maps/Azure.Maps.TimeZones/README.md index 80e6051e1647c..1b544e89a7d61 100644 --- a/sdk/maps/Azure.Maps.TimeZones/README.md +++ b/sdk/maps/Azure.Maps.TimeZones/README.md @@ -58,7 +58,7 @@ MapsTimeZoneClient client = new MapsTimeZoneClient(credential, clientId); Shared access signature (SAS) tokens are authentication tokens created using the JSON Web token (JWT) format and are cryptographically signed to prove authentication for an application to the Azure Maps REST API. -Before integrating SAS token authentication, we need to install `Azure.ResourceManager` and `Azure.ResourceManager.Maps` (version `1.1.0-beta.2` or higher): +Before integrating SAS token authentication, we need to install `Azure.ResourceManager` and `Azure.ResourceManager.Maps` (version `1.1.0` or higher): ```powershell dotnet add package Azure.ResourceManager diff --git a/sdk/maps/README.md b/sdk/maps/README.md index 7523c953fa391..165d93401a774 100644 --- a/sdk/maps/README.md +++ b/sdk/maps/README.md @@ -11,7 +11,7 @@ Below are the packages contained in Azure Maps: - [Azure.Maps.Routing][route] allows you to get the routing information for multiple origins and destinations. - [Azure.Maps.Search][search] supports many searching functionalities for entities, point of interests (POI) or streets, and also supports reverse geocode a coordinate to a place or an entity. - [Azure.Maps.Geolocation][geolocation] allows you to get the ISO country code for the provided IP address. -- [Azure.Maps.TimeZone][timezone] +- [Azure.Maps.TimeZones][timezone] allows you to get time zone information for the world. - [Azure.Maps.Weather][weather] allows you to get real-time, forecasted, and historical weather data. ### Install the package @@ -22,7 +22,7 @@ dotnet add package Azure.Maps.Rendering --prerelease dotnet add package Azure.Maps.Routing --prerelease dotnet add package Azure.Maps.Search --prerelease dotnet add package Azure.Maps.Geolocation --prerelease -dotnet add package Azure.Maps.TimeZone --prerelease +dotnet add package Azure.Maps.TimeZones --prerelease ``` Azure.Maps.Common will be automatically installed when you install other packages. @@ -39,7 +39,7 @@ az maps account create --kind "Gen2" --account-name "myMapAccountName" --resourc ### Authenticate the client -There are 2 ways to authenticate the client: Shared key authentication and Azure AD. Please refer to each package's README for details. +There are 3 ways to authenticate the client: Shared key authentication, Microsoft Entra and Shared Access Signature (SAS) Authentication. Please refer to each package's README for details. ## Key concepts @@ -75,7 +75,7 @@ using Azure.Maps.Routing; using Azure.Maps.Search; ``` -In the main function, instantiate `MapsSearchClient`, `MapsRoutingClient` and `MapsRenderingClient` either via AAD or subscription key authentication. Below is an example of instantiation via AAD: +In the main function, instantiate `MapsSearchClient`, `MapsRoutingClient` and `MapsRenderingClient` either via subscription key, Microsoft Entra, or SAS token authentication. Below is an example of instantiation via Microsoft Entra: ```C# // Create a MapsSearchClient and MapsRoutingClient that will authenticate through Active Directory @@ -221,7 +221,7 @@ additional questions or comments. [route]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/maps/Azure.Maps.Routing [geolocation]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/maps/Azure.Maps.Geolocation [search]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/maps/Azure.Maps.Search -[timezone]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/maps/Azure.Maps.TimeZone +[timezone]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/maps/Azure.Maps.TimeZones [weather]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/maps/Azure.Maps.Weather [cla]: https://cla.microsoft.com [coc]: https://opensource.microsoft.com/codeofconduct/ diff --git a/sdk/maps/ci.yml b/sdk/maps/ci.yml index 67555348e196a..ce98d66e27d2f 100644 --- a/sdk/maps/ci.yml +++ b/sdk/maps/ci.yml @@ -44,3 +44,5 @@ extends: safeName: AzureMapsSearch - name: Azure.Maps.Geolocation safeName: AzureMapsGeolocation + - name: Azure.Maps.TimeZones + safeName: AzureMapsTimeZones