AzureEnvironmentResource Constructors

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

Constructors

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

Class Constructors 1 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#L56-L127

Parameters

name string The name of the Azure environment resource.

location ParameterResource The Azure location that the resources will be deployed to.

resourceGroupName ParameterResource The Azure resource group name that the resources will be deployed to.

principalId ParameterResource The Azure principal ID that will be used to deploy the resources.

Exceptions

ArgumentNullException Thrown when the name is null or empty.

ArgumentException Thrown when the name is invalid.