Microsoft.Extensions.Azure provides shared primitives to integrate Azure clients with ASP.NET Coredependency injection andconfiguration systems.

Source code |Package (NuGet)

Getting started

Install the package

Install the ASP.NET Core integration library usingNuGet:

dotnet add package Microsoft.Extensions.Azure

Register clients

Make a call toAddAzureClients in your app'sConfigureServices method. You can use the provided builder to register client instances with your dependency injection container.

public void ConfigureServices(IServiceCollection services){    // Registering policy to use in ConfigureDefaults later    services.AddSingleton<DependencyInjectionEnabledPolicy>();    services.AddAzureClients(builder => {        // Register blob service client and initialize it using the KeyVault section of configuration        builder.AddSecretClient(Configuration.GetSection("KeyVault"))            // Set the name for this client registration            .WithName("NamedBlobClient")            // Set the credential for this client registration            .WithCredential(new ClientSecretCredential("<tenant_id>", "<client_id>", "<client_secret>"))            // Configure the client options            .ConfigureOptions(options => options.Retry.MaxRetries = 10);        // Adds a secret client using the provided endpoint and default credential set later        builder.AddSecretClient(new Uri("http://my.keyvault.com"));        // Configures environment credential to be used by default for all clients that require TokenCredential        // and doesn't override it on per registration level        builder.UseCredential(new EnvironmentCredential());        // This would use configuration for auth and client settings        builder.ConfigureDefaults(Configuration.GetSection("Default"));        // Configure global retry mode        builder.ConfigureDefaults(options => options.Retry.Mode = RetryMode.Exponential);        // Advanced configure global defaults        builder.ConfigureDefaults((options, provider) => options.AddPolicy(provider.GetService<DependencyInjectionEnabledPolicy>(), HttpPipelinePosition.PerCall));        // Register blob service client and initialize it using the Storage section of configuration        builder.AddBlobServiceClient(Configuration.GetSection("Storage"))                .WithVersion(BlobClientOptions.ServiceVersion.V2019_02_02);    });}

Inject clients

To use the client request the client type from any place that supports Dependency Injection (constructors, Configure calls,@inject razor definitions etc.)

public void Configure(IApplicationBuilder app, SecretClient secretClient, IAzureClientFactory<BlobServiceClient> blobClientFactory)

Create named instances

If client is registered as a named client injectIAzureClientFactory<T> and callCreateClient passing the name:

BlobServiceClient blobServiceClient = blobClientFactory.CreateClient("NamedBlobClient");

Configuration file used in the sample above:

{  "Logging": {    "LogLevel": {      "Default": "Debug"    }  },  "AllowedHosts": "*",  "Default": {    "ClientId": "<client_id>",    "ClientSecret": "<client_secret>",    "TenantId": "<tenant_id>",    "TelemetryPolicy": {      "ApplicationId": "AppId"    }  },  "KeyVault": {    "VaultUri": "<vault_uri>"  },  "Storage": {    "serviceUri": "<service_uri>",    "credential": {      "accountName": "<account_name>",      "accountKey": "<account_key>"    }  }}

Registering a custom client factory

If you want to take control over how the client instance is created or need to use other dependencies during the client construction use theAddClient<TClient, TOptions> method.

Here's and example of how to useIOptions<T> instance to construct the client:

public class MyApplicationOptions{    public Uri KeyVaultEndpoint { get; set; }}public void ConfigureServices(IServiceCollection services){    // Configure a custom options instance    services.Configure<MyApplicationOptions>(options => options.KeyVaultEndpoint = new Uri("http://localhost/"));    services.AddAzureClients(builder =>    {        // Register a client using MyApplicationOptions to get constructor parameters        builder.AddClient<SecretClient, SecretClientOptions>((options, credential, provider) =>        {            var appOptions = provider.GetService<IOptions<MyApplicationOptions>>();            return new SecretClient(appOptions.Value.KeyVaultEndpoint, credential, options);        });    });}

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, visithttps://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 theMicrosoft Open Source Code of Conduct. For more information see theCode of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.