Azure.Core 1.24.0 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved

.NET 5.0 .NET Core 2.1 .NET Standard 2.0 .NET Framework 4.6.1
Install-Package Azure.Core -Version 1.24.0
dotnet add package Azure.Core --version 1.24.0
<PackageReference Include="Azure.Core" Version="1.24.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Core --version 1.24.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Azure.Core, 1.24.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Azure.Core as a Cake Addin
#addin nuget:?package=Azure.Core&version=1.24.0

// Install Azure.Core as a Cake Tool
#tool nuget:?package=Azure.Core&version=1.24.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Azure Core shared client library for .NET

Azure.Core provides shared primitives, abstractions, and helpers for modern .NET Azure SDK client libraries. These libraries follow the Azure SDK Design Guidelines for .NET and can be easily identified by package and namespaces names starting with 'Azure', e.g. Azure.Storage.Blobs. A more complete list of client libraries using Azure.Core can be found here.

Azure.Core allows client libraries to expose common functionality in a consistent fashion, so that once you learn how to use these APIs in one client library, you will know how to use them in other client libraries.

Source code | Package (NuGet) | API reference documentation

Getting started

Typically, you will not need to install Azure.Core; it will be installed for you when you install one of the client libraries using it. In case you want to install it explicitly (to implement your own client library, for example), you can find the NuGet package here.

Key concepts

The main shared concepts of Azure.Core (and so Azure SDK libraries using Azure.Core) include:

  • Configuring service clients, e.g. configuring retries, logging (ClientOptions).
  • Accessing HTTP response details (Response, Response<T>).
  • Calling long-running operations (Operation<T>).
  • Paging and asynchronous streams (AsyncPageable<T>).
  • Exceptions for reporting errors from service requests in a consistent fashion. (RequestFailedException).
  • Abstractions for representing Azure SDK credentials. (TokenCredentials).

Below, you will find sections explaining these shared concepts in more detail.

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

NOTE: Samples in this file apply only to packages that follow Azure SDK Design Guidelines. Names of such packages usually start with Azure.

Configuring Service Clients Using ClientOptions

Azure SDK client libraries typically expose one or more service client types that are the main starting points for calling corresponding Azure services. You can easily find these client types as their names end with the word Client. For example, BlockBlobClient can be used to call blob storage service, and KeyClient can be used to access Key Vault service cryptographic keys.

These client types can be instantiated by calling a simple constructor, or its overload that takes various configuration options. These options are passed as a parameter that extends ClientOptions class exposed by Azure.Core. Various service specific options are usually added to its subclasses, but a set of SDK-wide options are available directly on ClientOptions.

SecretClientOptions options = new SecretClientOptions()
{
    Retry =
    {
        Delay = TimeSpan.FromSeconds(2),
        MaxRetries = 10,
        Mode = RetryMode.Fixed
    },
    Diagnostics =
    {
        IsLoggingContentEnabled = true,
        ApplicationId = "myApplicationId"
    }
};

SecretClient client = new SecretClient(new Uri("http://example.com"), new DefaultAzureCredential(), options);

More on client configuration in client configuration samples

Accessing HTTP Response Details Using Response<T>

Service clients have methods that can be used to call Azure services. We refer to these client methods service methods. Service methods return a shared Azure.Core type Response<T> (in rare cases its non-generic sibling, a raw Response). This type provides access to both the deserialized result of the service call, and to the details of the HTTP response returned from the server.

// create a client
var client = new SecretClient(new Uri("http://example.com"), new DefaultAzureCredential());

// call a service method, which returns Response<T>
Response<KeyVaultSecret> response = await client.GetSecretAsync("SecretName");

// Response<T> has two main accessors.
// Value property for accessing the deserialized result of the call
KeyVaultSecret secret = response.Value;

// .. and GetRawResponse method for accessing all the details of the HTTP response
Response http = response.GetRawResponse();

// for example, you can access HTTP status
int status = http.Status;

// or the headers
foreach (HttpHeader header in http.Headers)
{
    Console.WriteLine($"{header.Name} {header.Value}");
}

More on response types in response samples

Setting up console logging

To create an Azure SDK log listener that outputs messages to console use AzureEventSourceListener.CreateConsoleLogger method.

// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();

More on logging in diagnostics samples

Reporting Errors RequestFailedException

When a service call fails Azure.RequestFailedException would get thrown. The exception type provides a Status property with an HTTP status code and an ErrorCode property with a service-specific error code.

try
{
    KeyVaultSecret secret = client.GetSecret("NonexistentSecret");
}
// handle exception with status code 404
catch (RequestFailedException e) when (e.Status == 404)
{
    // handle not found error
    Console.WriteLine("ErrorCode " + e.ErrorCode);
}

More on handling responses in response samples

Consuming Service Methods Returning AsyncPageable<T>

If a service call returns multiple values in pages, it would return Pageable<T>/AsyncPageable<T> as a result. You can iterate over AsyncPageable directly or in pages.

// call a service method, which returns AsyncPageable<T>
AsyncPageable<SecretProperties> allSecretProperties = client.GetPropertiesOfSecretsAsync();

await foreach (SecretProperties secretProperties in allSecretProperties)
{
    Console.WriteLine(secretProperties.Name);
}

For more information on paged responses, see Pagination with the Azure SDK for .NET.

Consuming Long-Running Operations Using Operation<T>

Some operations take long time to complete and require polling for their status. Methods starting long-running operations return *Operation<T> types.

The WaitForCompletionAsync method is an easy way to wait for operation completion and get the resulting value.

// create a client
SecretClient client = new SecretClient(new Uri("http://example.com"), new DefaultAzureCredential());

// Start the operation
DeleteSecretOperation operation = await client.StartDeleteSecretAsync("SecretName");

Response<DeletedSecret> response = await operation.WaitForCompletionAsync();
DeletedSecret value = response.Value;

Console.WriteLine(value.Name);
Console.WriteLine(value.ScheduledPurgeDate);

More on long-running operations in long-running operation samples

Mocking

One of the most important cross-cutting features of our new client libraries using Azure.Core is that they are designed for mocking. Mocking is enabled by:

  • providing a protected parameterless constructor on client types.
  • making service methods virtual.
  • providing APIs for constructing model types returned from virtual service methods. To find these factory methods look for types with the ModelFactory suffix, e.g. SecretModelFactory.

For example, the ConfigurationClient.Get method can be mocked (with Moq) as follows:

// Create a mock response
var mockResponse = new Mock<Response>();

// Create a mock value
var mockValue = SecretModelFactory.KeyVaultSecret(
    SecretModelFactory.SecretProperties(new Uri("http://example.com"))
);

// Create a client mock
var mock = new Mock<SecretClient>();

// Setup client method
mock.Setup(c => c.GetSecret("Name", null, default))
    .Returns(Response.FromValue(mockValue, mockResponse.Object));

// Use the client mock
SecretClient client = mock.Object;
KeyVaultSecret secret = client.GetSecret("Name");

More on mocking in mocking samples

Distributed tracing with Application Insights

Application Insights, a feature of Azure Monitor, is an extensible Application Performance Management (APM) service for developers and DevOps professionals. Use it to monitor your live applications. It will automatically detect performance anomalies, and includes powerful analytics tools to help you diagnose issues and to understand what users actually do with your app

If your application already uses ApplicationInsights, automatic collection of Azure SDK traces is supported since version 2.12.0.

To setup ApplicationInsights tracking for your application follow the Start Monitoring Application guide.

More on diagnostics in diagnostics samples.

Troubleshooting

Three main ways of troubleshooting failures are inspecting exceptions, enabling logging, and distributed tracing

Next steps

Explore and install available Azure SDK libraries.

Contributing

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 https://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 repositories 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 Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (161)

Showing the top 5 NuGet packages that depend on Azure.Core:

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

This is the implementation of the Azure SDK Client Library for Azure Identity

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

This client library enables working with the Microsoft Azure Storage services which include the blob and file services for storing binary and text data, and the queue service for storing messages that may be accessed by a client. For this release see notes - https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Common/README.md and https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Common/CHANGELOG.md in addition to the breaking changes https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Common/BreakingChanges.txt Microsoft Azure Storage quickstarts and tutorials - https://docs.microsoft.com/en-us/azure/storage/ Microsoft Azure Storage REST API Reference - https://docs.microsoft.com/en-us/rest/api/storageservices/

Azure.Security.KeyVault.Secrets The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This is the Microsoft Azure Key Vault Secrets client library

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

This client library enables client applications to connect to Azure Cosmos via the SQL API. Azure Cosmos is a globally distributed, multi-model database service. For more information, refer to http://azure.microsoft.com/services/cosmos-db/.

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

Azure Service Bus is a fully managed enterprise integration message broker. Service Bus can decouple applications and services. Service Bus offers a reliable and secure platform for asynchronous transfer of data and state. This client library allows for both sending and receiving messages using Azure Service Bus. For more information about Service Bus, see https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview

GitHub repositories (24)

Showing the top 5 popular GitHub repositories that depend on Azure.Core:

Repository Stars
dotnet/orleans
Cloud Native application framework for .NET
Azure/azure-sdk-for-net
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
Azure/azure-powershell
Microsoft Azure PowerShell
Azure/azure-functions-host
The host/runtime that powers Azure Functions
mspnp/cloud-design-patterns
Prescriptive Architecture Guidance for Cloud Applications
Version Downloads Last updated
1.24.0 947,374 4/5/2022
1.23.0 455,936 3/22/2022
1.22.0 3,716,985 1/13/2022
1.21.0 4,909,556 11/4/2021
1.20.0 8,936,942 10/4/2021
1.19.0 12,210,505 9/1/2021
1.18.0 1,974,259 8/19/2021
1.17.0 4,306,904 8/3/2021
1.16.0 3,279,961 7/1/2021
1.15.0 12,911,931 6/3/2021
1.14.0 11,166,575 5/6/2021
1.13.0 447,137 4/8/2021
1.12.0 471,084 3/31/2021
1.11.0 237,980 3/22/2021
1.10.0 3,376,725 3/8/2021
1.9.0 2,077,705 2/6/2021
1.8.1 13,306,467 1/11/2021
1.8.0 41,539 1/6/2021
1.7.0 505,865 12/14/2020
1.6.0 26,863,864 10/28/2020
1.5.1 405,230 10/1/2020
1.5.0 1,745,166 9/4/2020
1.4.1 14,209,618 8/18/2020
1.3.0 11,207,585 7/2/2020
1.2.2 4,979,536 6/4/2020
1.2.1 2,581,049 4/30/2020
1.2.0 1,238,468 4/3/2020
1.1.0 1,721,396 3/6/2020
1.0.2 24,490,917 2/10/2020
1.0.1 13,675,597 11/18/2019
1.0.0 3,010,503 10/29/2019
1.0.0-preview.9 21,036 10/7/2019
1.0.0-preview.8 13,260 9/9/2019
1.0.0-preview.7 7,960 8/5/2019
1.0.0-preview.6 4,034 6/27/2019
1.0.0-preview.5 12,309 5/3/2019