pulumi-azure-native-kotlin/com.pulumi.azurenative.network.kotlin/Subnet

Subnet

class Subnet : KotlinCustomResource

Subnet in a virtual network resource. Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create subnet

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:      pulumi.String("10.0.0.0/16"),
			ResourceGroupName:  pulumi.String("subnet-test"),
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with a delegation

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:      pulumi.String("10.0.0.0/16"),
			ResourceGroupName:  pulumi.String("subnet-test"),
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with service endpoints

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        ServiceEndpoints = new[]
        {
            new AzureNative.Network.Inputs.ServiceEndpointPropertiesFormatArgs
            {
                Service = "Microsoft.Storage",
            },
        },
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:     pulumi.String("10.0.0.0/16"),
			ResourceGroupName: pulumi.String("subnet-test"),
			ServiceEndpoints: network.ServiceEndpointPropertiesFormatArray{
				&network.ServiceEndpointPropertiesFormatArgs{
					Service: pulumi.String("Microsoft.Storage"),
				},
			},
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
import com.pulumi.azurenative.network.inputs.ServiceEndpointPropertiesFormatArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .serviceEndpoints(ServiceEndpointPropertiesFormatArgs.builder()
                .service("Microsoft.Storage")
                .build())
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with service endpoints with network identifier

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        ServiceEndpoints = new[]
        {
            new AzureNative.Network.Inputs.ServiceEndpointPropertiesFormatArgs
            {
                NetworkIdentifier = new AzureNative.Network.Inputs.SubResourceArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip",
                },
                Service = "Microsoft.Storage",
            },
        },
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:     pulumi.String("10.0.0.0/16"),
			ResourceGroupName: pulumi.String("subnet-test"),
			ServiceEndpoints: network.ServiceEndpointPropertiesFormatArray{
				&network.ServiceEndpointPropertiesFormatArgs{
					NetworkIdentifier: &network.SubResourceArgs{
						Id: pulumi.String("/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip"),
					},
					Service: pulumi.String("Microsoft.Storage"),
				},
			},
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
import com.pulumi.azurenative.network.inputs.ServiceEndpointPropertiesFormatArgs;
import com.pulumi.azurenative.network.inputs.SubResourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .serviceEndpoints(ServiceEndpointPropertiesFormatArgs.builder()
                .networkIdentifier(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip")
                    .build())
                .service("Microsoft.Storage")
                .build())
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Create subnet with sharing scope

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var subnet = new AzureNative.Network.Subnet("subnet", new()
    {
        AddressPrefix = "10.0.0.0/16",
        ResourceGroupName = "subnet-test",
        SubnetName = "subnet1",
        VirtualNetworkName = "vnetname",
    });
});
Content copied to clipboard
package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
			AddressPrefix:      pulumi.String("10.0.0.0/16"),
			ResourceGroupName:  pulumi.String("subnet-test"),
			SubnetName:         pulumi.String("subnet1"),
			VirtualNetworkName: pulumi.String("vnetname"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.Subnet;
import com.pulumi.azurenative.network.SubnetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var subnet = new Subnet("subnet", SubnetArgs.builder()
            .addressPrefix("10.0.0.0/16")
            .resourceGroupName("subnet-test")
            .subnetName("subnet1")
            .virtualNetworkName("vnetname")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:Subnet subnet1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}
Content copied to clipboard

Properties

Link copied to clipboard
val addressPrefix: Output<String>?

The address prefix for the subnet.

Link copied to clipboard
val addressPrefixes: Output<List<String>>?

List of address prefixes for the subnet.

Link copied to clipboard
val applicationGatewayIPConfigurations: Output<List<ApplicationGatewayIPConfigurationResponse>>?

Application gateway IP configurations of virtual network resource.

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val defaultOutboundAccess: Output<Boolean>?

Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet.

Link copied to clipboard
val delegations: Output<List<DelegationResponse>>?

An array of references to the delegations on the subnet.

Link copied to clipboard
val etag: Output<String>

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val ipAllocations: Output<List<SubResourceResponse>>?

Array of IpAllocation which reference this subnet.

Link copied to clipboard
val ipamPoolPrefixAllocations: Output<List<IpamPoolPrefixAllocationResponse>>?

A list of IPAM Pools for allocating IP address prefixes.

Link copied to clipboard
val ipConfigurationProfiles: Output<List<IPConfigurationProfileResponse>>

Array of IP configuration profiles which reference this subnet.

Link copied to clipboard
val ipConfigurations: Output<List<IPConfigurationResponse>>

An array of references to the network interface IP configurations using subnet.

Link copied to clipboard
val name: Output<String>?

The name of the resource that is unique within a resource group. This name can be used to access the resource.

Link copied to clipboard
val natGateway: Output<SubResourceResponse>?

Nat gateway associated with this subnet.

Link copied to clipboard
val networkSecurityGroup: Output<NetworkSecurityGroupResponse>?

The reference to the NetworkSecurityGroup resource.

Link copied to clipboard
val privateEndpointNetworkPolicies: Output<String>?

Enable or Disable apply network policies on private end point in the subnet.

Link copied to clipboard
val privateEndpoints: Output<List<PrivateEndpointResponse>>

An array of references to private endpoints.

Link copied to clipboard
val privateLinkServiceNetworkPolicies: Output<String>?

Enable or Disable apply network policies on private link service in the subnet.

Link copied to clipboard
val provisioningState: Output<String>

The provisioning state of the subnet resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val purpose: Output<String>

A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties.

Link copied to clipboard
val resourceNavigationLinks: Output<List<ResourceNavigationLinkResponse>>

An array of references to the external resources using subnet.

Link copied to clipboard
val routeTable: Output<RouteTableResponse>?

The reference to the RouteTable resource.

Link copied to clipboard
val serviceAssociationLinks: Output<List<ServiceAssociationLinkResponse>>

An array of references to services injecting into this subnet.

Link copied to clipboard
val serviceEndpointPolicies: Output<List<ServiceEndpointPolicyResponse>>?

An array of service endpoint policies.

Link copied to clipboard
val serviceEndpoints: Output<List<ServiceEndpointPropertiesFormatResponse>>?

An array of service endpoints.

Link copied to clipboard
val sharingScope: Output<String>?

Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.

Link copied to clipboard
val type: Output<String>?

Resource type.

Link copied to clipboard
val urn: Output<String>