Skip to content
Docs Try Aspire

AzureUserAssignedIdentityExtensions Methods

Class Methods 2 members
Provides extension methods for working with Azure user‑assigned identities.
AddAzureUserAssignedIdentity(IDistributedApplicationBuilder, string) Section titled AddAzureUserAssignedIdentity(IDistributedApplicationBuilder, string) extension IResourceBuilder<AzureUserAssignedIdentityResource>
Adds an Azure user‑assigned identity resource to the application model.
public static class AzureUserAssignedIdentityExtensions
{
public static IResourceBuilder<AzureUserAssignedIdentityResource> AddAzureUserAssignedIdentity(
this IDistributedApplicationBuilder builder,
string name)
{
// ...
}
}
builder IDistributedApplicationBuilder The builder for the distributed application.
name string The name of the resource.
IResourceBuilder<AzureUserAssignedIdentityResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.
ArgumentNullException Thrown when builder is null.
ArgumentException Thrown when name is null or empty.
This method adds an Azure user‑assigned identity resource to the application model. It configures the infrastructure for the resource and returns a builder for the resource. The resource is added to the infrastructure only if the application is not in run mode.
WithAzureUserAssignedIdentity(IResourceBuilder<T>, IResourceBuilder<AzureUserAssignedIdentityResource>) Section titled WithAzureUserAssignedIdentity(IResourceBuilder<T>, IResourceBuilder<AzureUserAssignedIdentityResource>) extension IResourceBuilder<T>
Attaches an existing AzureUserAssignedIdentityResource to a compute resource, setting it as the target identity for the builder.
public static class AzureUserAssignedIdentityExtensions
{
public static IResourceBuilder<T> WithAzureUserAssignedIdentity<T>(
this IResourceBuilder<T> builder,
IResourceBuilder<AzureUserAssignedIdentityResource> identityResourceBuilder)
{
// ...
}
}
builder IResourceBuilder<T> The builder for the ApplicationModel.IComputeResource the identity will be associated with.
identityResourceBuilder IResourceBuilder<AzureUserAssignedIdentityResource> The builder for the AzureUserAssignedIdentityResource.
IResourceBuilder<T> A reference to the ApplicationModel.IResourceBuilder`1 builder.
var identity = builder.AddAzureUserAssignedIdentity("myIdentity");
var app = builder.AddProject("myApp")
.WithAzureUserAssignedIdentity(identity);