ReferenceRoleAssignmentAnnotation

Docs/Reference/Search C# APIs/Aspire.Hosting.Azure/ReferenceRoleAssignmentAnnotation

ReferenceRoleAssignmentAnnotation

Docs Reference Search C# APIs Aspire.Hosting.Azure ReferenceRoleAssignmentAnnotation

Classsealednet10.0

📦 Aspire.Hosting.Azure v13.5.1

Declares that any compute resource referencing the annotated resource should be granted ReferenceRoleAssignmentAnnotation.Roles on the Azure resource ReferenceRoleAssignmentAnnotation.Target.

Experimental — ASPIREAZURE003 · Learn more

namespace Aspire.Hosting.Azure;

public sealed class ReferenceRoleAssignmentAnnotation
    : Aspire.Hosting.ApplicationModel.IResourceAnnotation
{
    // ...
}

IResourceAnnotation

Implements

• IResourceAnnotation

Source

Remarks

This annotation is applied to a resource that "fronts" an Azure resource without being an IAzureResource itself. For example, a Foundry hosted agent's node app is a plain compute resource, but invoking the agent requires the caller to hold a role on the owning Foundry account. The account is only a transitive dependency of a consumer, so Azure.AzureResourcePreparer 's normal reference walk — which only acts on direct IAzureResource dependencies — cannot reach it.

When a compute resource takes a direct dependency on a resource carrying this annotation, Azure.AzureResourcePreparer folds (Target, Roles) into the same role-assignment path used for direct Azure references, so the consumer gets a managed identity and the corresponding role assignment on ReferenceRoleAssignmentAnnotation.Target with no additional wiring.

Constructors1

ReferenceRoleAssignmentAnnotation(AzureProvisioningResource, IReadOnlySet<RoleDefinition>)

Declares that any compute resource referencing the annotated resource should be granted ReferenceRoleAssignmentAnnotation.Roles on the Azure resource ReferenceRoleAssignmentAnnotation.Target.

View all constructors

Properties2

Rolesget

IReadOnlySet<RoleDefinition>

Gets the set of roles that resources referencing the annotated resource should be assigned on ReferenceRoleAssignmentAnnotation.Target.

Targetget

AzureProvisioningResource

Gets the Azure resource that resources referencing the annotated resource should be granted roles on.

View all properties