Share via

AzureCosmosExtensions.WithAccessKeyAuthentication Method

  • Reference

Definition

Namespace:
Aspire.Hosting
Assembly:
Aspire.Hosting.Azure.CosmosDB.dll
Package:
Aspire.Hosting.Azure.CosmosDB v9.1.0
Package:
Aspire.Hosting.Azure.CosmosDB v9.2.0
Package:
Aspire.Hosting.Azure.CosmosDB v9.3.0

Overloads

WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>)

Configures the resource to use access key authentication with Azure Cosmos DB.
WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>, IResourceBuilder<IAzureKeyVaultResource>)

Configures the resource to use access key authentication with Azure Cosmos DB.

WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>)

Source:
AzureCosmosDBExtensions.cs
Source:
AzureCosmosDBExtensions.cs
Source:
AzureCosmosDBExtensions.cs

Configures the resource to use access key authentication with Azure Cosmos DB.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource> WithAccessKeyAuthentication(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource> builder);
static member WithAccessKeyAuthentication : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource>
<Extension()>
Public Function WithAccessKeyAuthentication (builder As IResourceBuilder(Of AzureCosmosDBResource)) As IResourceBuilder(Of AzureCosmosDBResource)

Parameters

builder
IResourceBuilder<AzureCosmosDBResource>

The Azure Cosmos DB resource builder.

Returns

IResourceBuilder<AzureCosmosDBResource>

A reference to the IResourceBuilder<T> builder.

Examples

The following example creates an Azure Cosmos DB resource that uses access key authentication.

var builder = DistributedApplication.CreateBuilder(args);

var cosmosdb = builder.AddAzureCosmosDB("cache")
    .WithAccessKeyAuthentication();

builder.AddProject<Projects.ProductService>()
    .WithReference(cosmosdb);

builder.Build().Run();

Remarks

The following example creates an Azure Cosmos DB resource that uses access key authentication. 
var builder = DistributedApplication.CreateBuilder(args);

var cosmosdb = builder.AddAzureCosmosDB("cache")
    .WithAccessKeyAuthentication();

builder.AddProject<Projects.ProductService>()
    .WithReference(cosmosdb);

builder.Build().Run();

Applies to

WithAccessKeyAuthentication(IResourceBuilder<AzureCosmosDBResource>, IResourceBuilder<IAzureKeyVaultResource>)

Source:
AzureCosmosDBExtensions.cs
Source:
AzureCosmosDBExtensions.cs

Configures the resource to use access key authentication with Azure Cosmos DB.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource> WithAccessKeyAuthentication(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource> builder, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.IAzureKeyVaultResource> keyVaultBuilder);
static member WithAccessKeyAuthentication : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource> * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.IAzureKeyVaultResource> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AzureCosmosDBResource>
<Extension()>
Public Function WithAccessKeyAuthentication (builder As IResourceBuilder(Of AzureCosmosDBResource), keyVaultBuilder As IResourceBuilder(Of IAzureKeyVaultResource)) As IResourceBuilder(Of AzureCosmosDBResource)

Parameters

builder
IResourceBuilder<AzureCosmosDBResource>

The Azure Cosmos DB resource builder.

keyVaultBuilder
IResourceBuilder<IAzureKeyVaultResource>

The Azure Key Vault resource builder where the connection string used to connect to this AzureCosmosDBResource will be stored.

Returns

IResourceBuilder<AzureCosmosDBResource>

A reference to the IResourceBuilder<T> builder.

Applies to