AzureEnvironmentResource Constructors

Docs/Reference/Search C# APIs/Aspire.Hosting.Azure/AzureEnvironmentResource/Constructors

Constructors

Docs Reference Search C# APIs Aspire.Hosting.Azure AzureEnvironmentResource Constructors

ClassConstructors1 member

Represents the root Azure deployment target for an Aspire application. Manages deployment parameters and context for Azure resources.

Constructor(string, ParameterResource, ParameterResource, ParameterResource)

Initializes a new instance of the AzureEnvironmentResource class.

public sealed class AzureEnvironmentResource
{
    public AzureEnvironmentResource(
        string name,
        ParameterResource location,
        ParameterResource resourceGroupName,
        ParameterResource principalId)
    {
        // ...
    }
}

AzureEnvironmentResource.cs#L64-L180

Parameters

namestringThe name of the Azure environment resource.

locationParameterResourceThe Azure location that the resources will be deployed to.

resourceGroupNameParameterResourceThe Azure resource group name that the resources will be deployed to.

principalIdParameterResourceThe Azure principal ID that will be used to deploy the resources.

Exceptions

ArgumentNullExceptionThrown when the name is null or empty.

ArgumentExceptionThrown when the name is invalid.