AzureVirtualNetworkExtensions Methods

Docs/Reference/Search C# APIs/Aspire.Hosting.Azure.Network/AzureVirtualNetworkExtensions/Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting.Azure.Network AzureVirtualNetworkExtensions Methods

ClassMethods11 members

Provides extension methods for adding Azure Virtual Network resources to the application model.

AddAzureVirtualNetwork(IDistributedApplicationBuilder, string, string?)extensionIResourceBuilder<AzureVirtualNetworkResource>

Adds an Azure Virtual Network resource to the application model.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureVirtualNetworkResource> AddAzureVirtualNetwork(
        this IDistributedApplicationBuilder builder,
        string name,
        string? addressPrefix = null)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs

Parameters

builderIDistributedApplicationBuilderThe builder for the distributed application.

namestringThe name of the Azure Virtual Network resource.

addressPrefixstring?optionalThe address prefix for the virtual network (e.g., "10.0.0.0/16"). If null, defaults to "10.0.0.0/16".

Returns

IResourceBuilder<AzureVirtualNetworkResource>A reference to the ApplicationModel.IResourceBuilder`1.

Examples

This example creates a virtual network with a subnet for private endpoints:

var vnet = builder.AddAzureVirtualNetwork("vnet");
var subnet = vnet.AddSubnet("pe-subnet", "10.0.1.0/24");

Ignored by ATS

Excluded from automatic Polyglot export.

AddAzureVirtualNetwork(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<AzureVirtualNetworkResource>

Adds an Azure Virtual Network resource to the application model with a parameterized address prefix.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureVirtualNetworkResource> AddAzureVirtualNetwork(
        this IDistributedApplicationBuilder builder,
        string name,
        IResourceBuilder<ParameterResource> addressPrefix)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs

Parameters

builderIDistributedApplicationBuilderThe builder for the distributed application.

namestringThe name of the Azure Virtual Network resource.

addressPrefixIResourceBuilder<ParameterResource>The parameter resource containing the address prefix for the virtual network (e.g., "10.0.0.0/16").

Returns

IResourceBuilder<AzureVirtualNetworkResource>A reference to the ApplicationModel.IResourceBuilder`1.

Examples

This example creates a virtual network with a parameterized address prefix:

var vnetPrefix = builder.AddParameter("vnetPrefix");
var vnet = builder.AddAzureVirtualNetwork("vnet", vnetPrefix);
var subnet = vnet.AddSubnet("pe-subnet", "10.0.1.0/24");

Ignored by ATS

Excluded from automatic Polyglot export.

AddSubnet(IResourceBuilder<AzureVirtualNetworkResource>, string, string, string?)extensionIResourceBuilder<AzureSubnetResource>

Adds an Azure Subnet to the Virtual Network.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> AddSubnet(
        this IResourceBuilder<AzureVirtualNetworkResource> builder,
        string name,
        string addressPrefix,
        string? subnetName = null)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs

Parameters

builderIResourceBuilder<AzureVirtualNetworkResource>The Virtual Network resource builder.

namestringThe name of the subnet resource.

addressPrefixstringThe address prefix for the subnet (e.g., "10.0.1.0/24").

subnetNamestring?optionalThe subnet name in Azure. If null, the resource name is used.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1.

Examples

This example adds a subnet to a virtual network:

var vnet = builder.AddAzureVirtualNetwork("vnet");
var subnet = vnet.AddSubnet("my-subnet", "10.0.1.0/24");

Ignored by ATS

Excluded from automatic Polyglot export.

AddSubnet(IResourceBuilder<AzureVirtualNetworkResource>, string, IResourceBuilder<ParameterResource>, string?)extensionIResourceBuilder<AzureSubnetResource>

Adds an Azure Subnet to the Virtual Network with a parameterized address prefix.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> AddSubnet(
        this IResourceBuilder<AzureVirtualNetworkResource> builder,
        string name,
        IResourceBuilder<ParameterResource> addressPrefix,
        string? subnetName = null)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs

Parameters

builderIResourceBuilder<AzureVirtualNetworkResource>The Virtual Network resource builder.

namestringThe name of the subnet resource.

addressPrefixIResourceBuilder<ParameterResource>The parameter resource containing the address prefix for the subnet (e.g., "10.0.1.0/24").

subnetNamestring?optionalThe subnet name in Azure. If null, the resource name is used.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1.

Examples

This example adds a subnet with a parameterized address prefix:

var subnetPrefix = builder.AddParameter("subnetPrefix");
var vnet = builder.AddAzureVirtualNetwork("vnet");
var subnet = vnet.AddSubnet("my-subnet", subnetPrefix);

Ignored by ATS

Excluded from automatic Polyglot export.

AllowInbound(IResourceBuilder<AzureSubnetResource>, string?, string?, string?, SecurityRuleProtocol?, int?, string?)extensionIResourceBuilder<AzureSubnetResource>

Adds an inbound allow rule to the subnet's Network Security Group.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> AllowInbound(
        this IResourceBuilder<AzureSubnetResource> builder,
        string? port = null,
        string? from = null,
        string? to = null,
        SecurityRuleProtocol? protocol = null,
        int? priority = null,
        string? name = null)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs#L431

Parameters

builderIResourceBuilder<AzureSubnetResource>The subnet resource builder.

portstring?optionalThe destination port range (e.g., "443", "80-443"). Defaults to "*" (any).

fromstring?optionalThe source address prefix (e.g., "AzureLoadBalancer", "Internet", "10.0.0.0/8"). Defaults to "*" (any).

tostring?optionalThe destination address prefix. Defaults to "*" (any).

protocolSecurityRuleProtocol?optionalThe network protocol. Defaults to SecurityRuleProtocol.Asterisk (any).

priorityint?optionalThe rule priority (100-4096). If not specified, auto-increments from 100 by 100.

namestring?optionalThe rule name. If not specified, auto-generated from parameters.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1 for chaining.

Remarks

If no Network Security Group has been associated with the subnet, one is automatically created.

Examples

This example allows HTTPS traffic from the Azure Load Balancer:

var subnet = vnet.AddSubnet("web", "10.0.1.0/24")
    .AllowInbound(port: "443", from: AzureServiceTags.AzureLoadBalancer, protocol: SecurityRuleProtocol.Tcp)
    .DenyInbound(from: AzureServiceTags.Internet);

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

AllowOutbound(IResourceBuilder<AzureSubnetResource>, string?, string?, string?, SecurityRuleProtocol?, int?, string?)extensionIResourceBuilder<AzureSubnetResource>

Adds an outbound allow rule to the subnet's Network Security Group.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> AllowOutbound(
        this IResourceBuilder<AzureSubnetResource> builder,
        string? port = null,
        string? from = null,
        string? to = null,
        SecurityRuleProtocol? protocol = null,
        int? priority = null,
        string? name = null)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs#L487

Parameters

builderIResourceBuilder<AzureSubnetResource>The subnet resource builder.

portstring?optionalThe destination port range (e.g., "443", "80-443"). Defaults to "*" (any).

fromstring?optionalThe source address prefix. Defaults to "*" (any).

tostring?optionalThe destination address prefix (e.g., "Internet", "VirtualNetwork"). Defaults to "*" (any).

protocolSecurityRuleProtocol?optionalThe network protocol. Defaults to SecurityRuleProtocol.Asterisk (any).

priorityint?optionalThe rule priority (100-4096). If not specified, auto-increments from 100 by 100.

namestring?optionalThe rule name. If not specified, auto-generated from parameters.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1 for chaining.

Remarks

If no Network Security Group has been associated with the subnet, one is automatically created.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

DenyInbound(IResourceBuilder<AzureSubnetResource>, string?, string?, string?, SecurityRuleProtocol?, int?, string?)extensionIResourceBuilder<AzureSubnetResource>

Adds an inbound deny rule to the subnet's Network Security Group.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> DenyInbound(
        this IResourceBuilder<AzureSubnetResource> builder,
        string? port = null,
        string? from = null,
        string? to = null,
        SecurityRuleProtocol? protocol = null,
        int? priority = null,
        string? name = null)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs#L459

Parameters

builderIResourceBuilder<AzureSubnetResource>The subnet resource builder.

portstring?optionalThe destination port range (e.g., "443", "80-443"). Defaults to "*" (any).

fromstring?optionalThe source address prefix (e.g., "Internet", "VirtualNetwork", "10.0.0.0/8"). Defaults to "*" (any).

tostring?optionalThe destination address prefix. Defaults to "*" (any).

protocolSecurityRuleProtocol?optionalThe network protocol. Defaults to SecurityRuleProtocol.Asterisk (any).

priorityint?optionalThe rule priority (100-4096). If not specified, auto-increments from 100 by 100.

namestring?optionalThe rule name. If not specified, auto-generated from parameters.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1 for chaining.

Remarks

If no Network Security Group has been associated with the subnet, one is automatically created.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

DenyOutbound(IResourceBuilder<AzureSubnetResource>, string?, string?, string?, SecurityRuleProtocol?, int?, string?)extensionIResourceBuilder<AzureSubnetResource>

Adds an outbound deny rule to the subnet's Network Security Group.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> DenyOutbound(
        this IResourceBuilder<AzureSubnetResource> builder,
        string? port = null,
        string? from = null,
        string? to = null,
        SecurityRuleProtocol? protocol = null,
        int? priority = null,
        string? name = null)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs#L515

Parameters

builderIResourceBuilder<AzureSubnetResource>The subnet resource builder.

portstring?optionalThe destination port range (e.g., "443", "80-443"). Defaults to "*" (any).

fromstring?optionalThe source address prefix. Defaults to "*" (any).

tostring?optionalThe destination address prefix (e.g., "Internet", "VirtualNetwork"). Defaults to "*" (any).

protocolSecurityRuleProtocol?optionalThe network protocol. Defaults to SecurityRuleProtocol.Asterisk (any).

priorityint?optionalThe rule priority (100-4096). If not specified, auto-increments from 100 by 100.

namestring?optionalThe rule name. If not specified, auto-generated from parameters.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1 for chaining.

Remarks

If no Network Security Group has been associated with the subnet, one is automatically created.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithDelegatedSubnet(IResourceBuilder<T>, IResourceBuilder<AzureSubnetResource>)extensionIResourceBuilder<T>

Configures the resource to use the specified subnet with appropriate service delegation.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<T> WithDelegatedSubnet<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<AzureSubnetResource> subnet)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs#L308-L322

Parameters

builderIResourceBuilder<T>The resource builder.

subnetIResourceBuilder<AzureSubnetResource>The subnet to associate with the resource.

Returns

IResourceBuilder<T>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This method automatically configures the subnet with the appropriate service delegation for the target resource type (e.g., "Microsoft.App/environments" for Azure Container Apps).

Examples

This example configures an Azure Container App Environment to use a subnet:

var vnet = builder.AddAzureVirtualNetwork("vnet");
var subnet = vnet.AddSubnet("aca-subnet", "10.0.0.0/23");

var env = builder.AddAzureContainerAppEnvironment("env")
    .WithDelegatedSubnet(subnet);

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithNatGateway(IResourceBuilder<AzureSubnetResource>, IResourceBuilder<AzureNatGatewayResource>)extensionIResourceBuilder<AzureSubnetResource>

Associates a NAT Gateway with the subnet.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> WithNatGateway(
        this IResourceBuilder<AzureSubnetResource> builder,
        IResourceBuilder<AzureNatGatewayResource> natGateway)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs#L350-L354

Parameters

builderIResourceBuilder<AzureSubnetResource>The subnet resource builder.

natGatewayIResourceBuilder<AzureNatGatewayResource>The NAT Gateway to associate with the subnet.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1 for chaining.

Remarks

A NAT Gateway provides outbound internet connectivity for resources in the subnet. A subnet can have at most one NAT Gateway.

Examples

This example creates a subnet with an associated NAT Gateway:

var natGateway = builder.AddNatGateway("nat");
var vnet = builder.AddAzureVirtualNetwork("vnet");
var subnet = vnet.AddSubnet("aca-subnet", "10.0.0.0/23")
    .WithNatGateway(natGateway);

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithNetworkSecurityGroup(IResourceBuilder<AzureSubnetResource>, IResourceBuilder<AzureNetworkSecurityGroupResource>)extensionIResourceBuilder<AzureSubnetResource>

Associates a Network Security Group with the subnet.

public static class AzureVirtualNetworkExtensions
{
    public static IResourceBuilder<AzureSubnetResource> WithNetworkSecurityGroup(
        this IResourceBuilder<AzureSubnetResource> builder,
        IResourceBuilder<AzureNetworkSecurityGroupResource> nsg)
    {
        // ...
    }
}

AzureVirtualNetworkExtensions.cs#L383-L395

Parameters

builderIResourceBuilder<AzureSubnetResource>The subnet resource builder.

nsgIResourceBuilder<AzureNetworkSecurityGroupResource>The Network Security Group to associate with the subnet.

Returns

IResourceBuilder<AzureSubnetResource>A reference to the ApplicationModel.IResourceBuilder`1 for chaining.

Exceptions

InvalidOperationException Thrown when the subnet already has security rules added via shorthand methods ( AzureVirtualNetworkExtensions.AllowInbound, AzureVirtualNetworkExtensions.DenyInbound, AzureVirtualNetworkExtensions.AllowOutbound, AzureVirtualNetworkExtensions.DenyOutbound). Use either shorthand methods or an explicit NSG, not both.

Examples

This example creates a subnet with an associated Network Security Group:

var nsg = builder.AddNetworkSecurityGroup("web-nsg");
var vnet = builder.AddAzureVirtualNetwork("vnet");
var subnet = vnet.AddSubnet("web-subnet", "10.0.1.0/24")
    .WithNetworkSecurityGroup(nsg);

ATS export

Available to Polyglot AppHosts through the Aspire Type System.