Azure.Maps.Common 1.0.0-beta.4

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of Azure.Maps.Common.
dotnet add package Azure.Maps.Common --version 1.0.0-beta.4
NuGet\Install-Package Azure.Maps.Common -Version 1.0.0-beta.4
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Azure.Maps.Common" Version="1.0.0-beta.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Maps.Common --version 1.0.0-beta.4
#r "nuget: Azure.Maps.Common, 1.0.0-beta.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Azure.Maps.Common as a Cake Addin
#addin nuget:?package=Azure.Maps.Common&version=1.0.0-beta.4&prerelease

// Install Azure.Maps.Common as a Cake Tool
#tool nuget:?package=Azure.Maps.Common&version=1.0.0-beta.4&prerelease

Azure Maps Common client library for .NET

Azure Maps is a Microsoft-managed service providing maps service that is...

The Azure.Maps.Common library provides infrastructure shared across other Azure Maps client libraries.

Source code | API reference documentation | Product documentation

Getting started

Install the package

Install the Azure Maps client library for .NET you'd like to use with NuGet and the Azure.Maps.Common client library will be included. Choose the packages you want to install:

dotnet add package Azure.Maps.Search --prerelease
dotnet add package Azure.Maps.Routing --prerelease
dotnet add package Azure.Maps.Rendering --prerelease
dotnet add package Azure.Maps.Geolocation --prerelease

Prerequisites

You must have an Azure subscription and Azure Maps account.

To create a new Azure Maps account, you can use the Azure Portal, Azure PowerShell, or the Azure CLI. Here's an example using the Azure CLI:

az maps account create --kind "Gen2" --account-name "myMapAccountName" --resource-group "<resource group>" --sku "G2"

Authenticate the client

There are 2 ways to authenticate the client: Shared key authentication and Azure AD. Please refer to other Azure Maps packages for detailed description.

Key concepts

The Azure Maps Common client library contains shared infrastructure like LocalizedMapView and RequestFailedException.

Thread safety

We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.

Additional concepts

Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime

Examples

Please see the examples for Search, Routing, Rendering and Geolocation.

Troubleshooting

If instantiate a null LocalizedMapView, the program will throw a ArgumentNullException error.

Next steps

Get started with our Search, Routing, Rendering and Geolocation samples.

Contributing

See the CONTRIBUTING.md for details on building, testing, and contributing to this library.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <cla.microsoft.com>.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Azure.Maps.Common:

Package Downloads
Azure.Maps.Search The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Azure Maps Azure.Maps.Search

Azure.Maps.Rendering The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Azure Maps Azure.Maps.Rendering

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-beta.4 92,911 7/13/2023
1.0.0-beta.3 36,294 11/11/2022
1.0.0-beta.2 12,299 10/13/2022
1.0.0-beta.1 15,773 9/9/2022