Skip to content
DocsTry Aspire
DocsTry

AzureUserAssignedIdentityExtensions Methods

ClassMethods2 members
Provides extension methods for working with Azure user‑assigned identities.
AddAzureUserAssignedIdentity(IDistributedApplicationBuilder, string)Section titled AddAzureUserAssignedIdentity(IDistributedApplicationBuilder, string)extensionIResourceBuilder<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)
{
// ...
}
}
builderIDistributedApplicationBuilderThe builder for the distributed application.
namestringThe name of the resource.
IResourceBuilder<AzureUserAssignedIdentityResource>A reference to the ApplicationModel.IResourceBuilder`1 builder.
ArgumentNullExceptionThrown when builder is null.
ArgumentExceptionThrown 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>)extensionIResourceBuilder<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)
{
// ...
}
}
builderIResourceBuilder<T>The builder for the ApplicationModel.IComputeResource the identity will be associated with.
identityResourceBuilderIResourceBuilder<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);