Microsoft.Extensions.Azure 1.7.4

Azure 客户端库集成 ASP.NET Core

Microsoft.Extensions.Azure 提供共享原语以将 Azure 客户端与 ASP.NET Core 依赖注入 和 配置 系统集成。

源代码 | 包（NuGet）

入门

安装包

使用 NuGet 安装 ASP.NET Core 集成库

dotnet add package Microsoft.Extensions.Azure

注册客户端

在应用程序的 ConfigureServices 方法中调用 AddAzureClients。您可以使用提供的构建器将客户端实例注册到依赖注入容器中。

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);
    });
}

注入客户端

为了使用客户端，您可以从任何支持依赖注入（构造函数、Configure 调用、Razor 定义中的 @inject 等）的地方请求客户端类型。

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

创建命名实例

如果客户端以命名客户端注册，则注入 IAzureClientFactory<T> 并调用 CreateClient 时传入名称

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

上述示例中使用的配置文件

{
  "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>"
    }
  }
}

注册自定义客户端工厂

如果您想控制客户端实例的创建方式或在客户端构造过程中使用其他依赖项，请使用 AddClient<TClient, TOptions> 方法。

以下是如何使用 IOptions<T> 实例来构建客户端的示例

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("https://127.0.0.1/"));

    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);
        });
    });
}

贡献

本项目欢迎贡献和建议。大多数贡献都需要您同意贡献者许可协议（CLA），声明您有权并将实际将权利授予我们使用您的贡献。有关详细信息，请访问 https://cla.microsoft.com。

当您提交拉取请求时，CLA机器人将自动确定您是否需要提供CLA，并相应地标记（例如，标签或注释）拉取请求。只需按机器人提供的说明操作。您只需在整个使用我们的CLA的仓库中做一次。

本项目已采用 Microsoft 开源行为准则。有关更多信息，请参阅 行为准则常见问题解答 或通过 [email protected] 联系我们，提出任何其他问题或意见。