1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. NetworkInterface
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.azurestackhci.NetworkInterface

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

The network interface resource definition.

Uses Azure REST API version 2025-02-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-12-15-preview.

Other available API versions: 2022-12-15-preview, 2023-07-01-preview, 2023-09-01-preview, 2024-01-01, 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

Example Usage

CreateNetworkInterfaceFromLocal

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var networkInterface = new AzureNative.AzureStackHCI.NetworkInterface("networkInterface", new()
    {
        CreateFromLocal = true,
        ExtendedLocation = new AzureNative.AzureStackHCI.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
            Type = AzureNative.AzureStackHCI.ExtendedLocationTypes.CustomLocation,
        },
        IpConfigurations = new[]
        {
            new AzureNative.AzureStackHCI.Inputs.IPConfigurationArgs
            {
                Name = "ipconfig-sample",
                Properties = new AzureNative.AzureStackHCI.Inputs.IPConfigurationPropertiesArgs
                {
                    Subnet = new AzureNative.AzureStackHCI.Inputs.LogicalNetworkArmReferenceArgs
                    {
                        Id = "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet",
                    },
                },
            },
        },
        Location = "eastus",
        NetworkInterfaceName = "test-nic",
        ResourceGroupName = "test-rg",
    });

});
Copy
package main

import (
	azurestackhci "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azurestackhci.NewNetworkInterface(ctx, "networkInterface", &azurestackhci.NetworkInterfaceArgs{
			CreateFromLocal: pulumi.Bool(true),
			ExtendedLocation: &azurestackhci.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location"),
				Type: pulumi.String(azurestackhci.ExtendedLocationTypesCustomLocation),
			},
			IpConfigurations: azurestackhci.IPConfigurationArray{
				&azurestackhci.IPConfigurationArgs{
					Name: pulumi.String("ipconfig-sample"),
					Properties: &azurestackhci.IPConfigurationPropertiesArgs{
						Subnet: &azurestackhci.LogicalNetworkArmReferenceArgs{
							Id: pulumi.String("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet"),
						},
					},
				},
			},
			Location:             pulumi.String("eastus"),
			NetworkInterfaceName: pulumi.String("test-nic"),
			ResourceGroupName:    pulumi.String("test-rg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azurestackhci.NetworkInterface;
import com.pulumi.azurenative.azurestackhci.NetworkInterfaceArgs;
import com.pulumi.azurenative.azurestackhci.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.azurestackhci.inputs.IPConfigurationArgs;
import com.pulumi.azurenative.azurestackhci.inputs.IPConfigurationPropertiesArgs;
import com.pulumi.azurenative.azurestackhci.inputs.LogicalNetworkArmReferenceArgs;
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 networkInterface = new NetworkInterface("networkInterface", NetworkInterfaceArgs.builder()
            .createFromLocal(true)
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location")
                .type("CustomLocation")
                .build())
            .ipConfigurations(IPConfigurationArgs.builder()
                .name("ipconfig-sample")
                .properties(IPConfigurationPropertiesArgs.builder()
                    .subnet(LogicalNetworkArmReferenceArgs.builder()
                        .id("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet")
                        .build())
                    .build())
                .build())
            .location("eastus")
            .networkInterfaceName("test-nic")
            .resourceGroupName("test-rg")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const networkInterface = new azure_native.azurestackhci.NetworkInterface("networkInterface", {
    createFromLocal: true,
    extendedLocation: {
        name: "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        type: azure_native.azurestackhci.ExtendedLocationTypes.CustomLocation,
    },
    ipConfigurations: [{
        name: "ipconfig-sample",
        properties: {
            subnet: {
                id: "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet",
            },
        },
    }],
    location: "eastus",
    networkInterfaceName: "test-nic",
    resourceGroupName: "test-rg",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

network_interface = azure_native.azurestackhci.NetworkInterface("networkInterface",
    create_from_local=True,
    extended_location={
        "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": azure_native.azurestackhci.ExtendedLocationTypes.CUSTOM_LOCATION,
    },
    ip_configurations=[{
        "name": "ipconfig-sample",
        "properties": {
            "subnet": {
                "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet",
            },
        },
    }],
    location="eastus",
    network_interface_name="test-nic",
    resource_group_name="test-rg")
Copy
resources:
  networkInterface:
    type: azure-native:azurestackhci:NetworkInterface
    properties:
      createFromLocal: true
      extendedLocation:
        name: /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location
        type: CustomLocation
      ipConfigurations:
        - name: ipconfig-sample
          properties:
            subnet:
              id: /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet
      location: eastus
      networkInterfaceName: test-nic
      resourceGroupName: test-rg
Copy

PutNetworkInterface

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var networkInterface = new AzureNative.AzureStackHCI.NetworkInterface("networkInterface", new()
    {
        ExtendedLocation = new AzureNative.AzureStackHCI.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
            Type = AzureNative.AzureStackHCI.ExtendedLocationTypes.CustomLocation,
        },
        IpConfigurations = new[]
        {
            new AzureNative.AzureStackHCI.Inputs.IPConfigurationArgs
            {
                Name = "ipconfig-sample",
                Properties = new AzureNative.AzureStackHCI.Inputs.IPConfigurationPropertiesArgs
                {
                    Subnet = new AzureNative.AzureStackHCI.Inputs.LogicalNetworkArmReferenceArgs
                    {
                        Id = "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet",
                    },
                },
            },
        },
        Location = "eastus",
        NetworkInterfaceName = "test-nic",
        ResourceGroupName = "test-rg",
    });

});
Copy
package main

import (
	azurestackhci "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azurestackhci.NewNetworkInterface(ctx, "networkInterface", &azurestackhci.NetworkInterfaceArgs{
			ExtendedLocation: &azurestackhci.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location"),
				Type: pulumi.String(azurestackhci.ExtendedLocationTypesCustomLocation),
			},
			IpConfigurations: azurestackhci.IPConfigurationArray{
				&azurestackhci.IPConfigurationArgs{
					Name: pulumi.String("ipconfig-sample"),
					Properties: &azurestackhci.IPConfigurationPropertiesArgs{
						Subnet: &azurestackhci.LogicalNetworkArmReferenceArgs{
							Id: pulumi.String("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet"),
						},
					},
				},
			},
			Location:             pulumi.String("eastus"),
			NetworkInterfaceName: pulumi.String("test-nic"),
			ResourceGroupName:    pulumi.String("test-rg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.azurestackhci.NetworkInterface;
import com.pulumi.azurenative.azurestackhci.NetworkInterfaceArgs;
import com.pulumi.azurenative.azurestackhci.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.azurestackhci.inputs.IPConfigurationArgs;
import com.pulumi.azurenative.azurestackhci.inputs.IPConfigurationPropertiesArgs;
import com.pulumi.azurenative.azurestackhci.inputs.LogicalNetworkArmReferenceArgs;
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 networkInterface = new NetworkInterface("networkInterface", NetworkInterfaceArgs.builder()
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location")
                .type("CustomLocation")
                .build())
            .ipConfigurations(IPConfigurationArgs.builder()
                .name("ipconfig-sample")
                .properties(IPConfigurationPropertiesArgs.builder()
                    .subnet(LogicalNetworkArmReferenceArgs.builder()
                        .id("/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet")
                        .build())
                    .build())
                .build())
            .location("eastus")
            .networkInterfaceName("test-nic")
            .resourceGroupName("test-rg")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const networkInterface = new azure_native.azurestackhci.NetworkInterface("networkInterface", {
    extendedLocation: {
        name: "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        type: azure_native.azurestackhci.ExtendedLocationTypes.CustomLocation,
    },
    ipConfigurations: [{
        name: "ipconfig-sample",
        properties: {
            subnet: {
                id: "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet",
            },
        },
    }],
    location: "eastus",
    networkInterfaceName: "test-nic",
    resourceGroupName: "test-rg",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

network_interface = azure_native.azurestackhci.NetworkInterface("networkInterface",
    extended_location={
        "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": azure_native.azurestackhci.ExtendedLocationTypes.CUSTOM_LOCATION,
    },
    ip_configurations=[{
        "name": "ipconfig-sample",
        "properties": {
            "subnet": {
                "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet",
            },
        },
    }],
    location="eastus",
    network_interface_name="test-nic",
    resource_group_name="test-rg")
Copy
resources:
  networkInterface:
    type: azure-native:azurestackhci:NetworkInterface
    properties:
      extendedLocation:
        name: /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location
        type: CustomLocation
      ipConfigurations:
        - name: ipconfig-sample
          properties:
            subnet:
              id: /subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet
      location: eastus
      networkInterfaceName: test-nic
      resourceGroupName: test-rg
Copy

Create NetworkInterface Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NetworkInterface(name: string, args: NetworkInterfaceArgs, opts?: CustomResourceOptions);
@overload
def NetworkInterface(resource_name: str,
                     args: NetworkInterfaceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def NetworkInterface(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     resource_group_name: Optional[str] = None,
                     create_from_local: Optional[bool] = None,
                     dns_settings: Optional[InterfaceDNSSettingsArgs] = None,
                     extended_location: Optional[ExtendedLocationArgs] = None,
                     ip_configurations: Optional[Sequence[IPConfigurationArgs]] = None,
                     location: Optional[str] = None,
                     mac_address: Optional[str] = None,
                     network_interface_name: Optional[str] = None,
                     network_security_group: Optional[NetworkSecurityGroupArmReferenceArgs] = None,
                     tags: Optional[Mapping[str, str]] = None)
func NewNetworkInterface(ctx *Context, name string, args NetworkInterfaceArgs, opts ...ResourceOption) (*NetworkInterface, error)
public NetworkInterface(string name, NetworkInterfaceArgs args, CustomResourceOptions? opts = null)
public NetworkInterface(String name, NetworkInterfaceArgs args)
public NetworkInterface(String name, NetworkInterfaceArgs args, CustomResourceOptions options)
type: azure-native:azurestackhci:NetworkInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var networkInterfaceResource = new AzureNative.AzureStackHCI.NetworkInterface("networkInterfaceResource", new()
{
    ResourceGroupName = "string",
    CreateFromLocal = false,
    DnsSettings = new AzureNative.AzureStackHCI.Inputs.InterfaceDNSSettingsArgs
    {
        DnsServers = new[]
        {
            "string",
        },
    },
    ExtendedLocation = new AzureNative.AzureStackHCI.Inputs.ExtendedLocationArgs
    {
        Name = "string",
        Type = "string",
    },
    IpConfigurations = new[]
    {
        new AzureNative.AzureStackHCI.Inputs.IPConfigurationArgs
        {
            Name = "string",
            Properties = new AzureNative.AzureStackHCI.Inputs.IPConfigurationPropertiesArgs
            {
                PrivateIPAddress = "string",
                Subnet = new AzureNative.AzureStackHCI.Inputs.LogicalNetworkArmReferenceArgs
                {
                    Id = "string",
                },
            },
        },
    },
    Location = "string",
    MacAddress = "string",
    NetworkInterfaceName = "string",
    NetworkSecurityGroup = new AzureNative.AzureStackHCI.Inputs.NetworkSecurityGroupArmReferenceArgs
    {
        Id = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := azurestackhci.NewNetworkInterface(ctx, "networkInterfaceResource", &azurestackhci.NetworkInterfaceArgs{
	ResourceGroupName: pulumi.String("string"),
	CreateFromLocal:   pulumi.Bool(false),
	DnsSettings: &azurestackhci.InterfaceDNSSettingsArgs{
		DnsServers: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ExtendedLocation: &azurestackhci.ExtendedLocationArgs{
		Name: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	IpConfigurations: azurestackhci.IPConfigurationArray{
		&azurestackhci.IPConfigurationArgs{
			Name: pulumi.String("string"),
			Properties: &azurestackhci.IPConfigurationPropertiesArgs{
				PrivateIPAddress: pulumi.String("string"),
				Subnet: &azurestackhci.LogicalNetworkArmReferenceArgs{
					Id: pulumi.String("string"),
				},
			},
		},
	},
	Location:             pulumi.String("string"),
	MacAddress:           pulumi.String("string"),
	NetworkInterfaceName: pulumi.String("string"),
	NetworkSecurityGroup: &azurestackhci.NetworkSecurityGroupArmReferenceArgs{
		Id: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var networkInterfaceResource = new NetworkInterface("networkInterfaceResource", NetworkInterfaceArgs.builder()
    .resourceGroupName("string")
    .createFromLocal(false)
    .dnsSettings(InterfaceDNSSettingsArgs.builder()
        .dnsServers("string")
        .build())
    .extendedLocation(ExtendedLocationArgs.builder()
        .name("string")
        .type("string")
        .build())
    .ipConfigurations(IPConfigurationArgs.builder()
        .name("string")
        .properties(IPConfigurationPropertiesArgs.builder()
            .privateIPAddress("string")
            .subnet(LogicalNetworkArmReferenceArgs.builder()
                .id("string")
                .build())
            .build())
        .build())
    .location("string")
    .macAddress("string")
    .networkInterfaceName("string")
    .networkSecurityGroup(NetworkSecurityGroupArmReferenceArgs.builder()
        .id("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
network_interface_resource = azure_native.azurestackhci.NetworkInterface("networkInterfaceResource",
    resource_group_name="string",
    create_from_local=False,
    dns_settings={
        "dns_servers": ["string"],
    },
    extended_location={
        "name": "string",
        "type": "string",
    },
    ip_configurations=[{
        "name": "string",
        "properties": {
            "private_ip_address": "string",
            "subnet": {
                "id": "string",
            },
        },
    }],
    location="string",
    mac_address="string",
    network_interface_name="string",
    network_security_group={
        "id": "string",
    },
    tags={
        "string": "string",
    })
Copy
const networkInterfaceResource = new azure_native.azurestackhci.NetworkInterface("networkInterfaceResource", {
    resourceGroupName: "string",
    createFromLocal: false,
    dnsSettings: {
        dnsServers: ["string"],
    },
    extendedLocation: {
        name: "string",
        type: "string",
    },
    ipConfigurations: [{
        name: "string",
        properties: {
            privateIPAddress: "string",
            subnet: {
                id: "string",
            },
        },
    }],
    location: "string",
    macAddress: "string",
    networkInterfaceName: "string",
    networkSecurityGroup: {
        id: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:azurestackhci:NetworkInterface
properties:
    createFromLocal: false
    dnsSettings:
        dnsServers:
            - string
    extendedLocation:
        name: string
        type: string
    ipConfigurations:
        - name: string
          properties:
            privateIPAddress: string
            subnet:
                id: string
    location: string
    macAddress: string
    networkInterfaceName: string
    networkSecurityGroup:
        id: string
    resourceGroupName: string
    tags:
        string: string
Copy

NetworkInterface Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NetworkInterface resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CreateFromLocal bool
Boolean indicating whether this is a existing local network interface or if one should be created.
DnsSettings Pulumi.AzureNative.AzureStackHCI.Inputs.InterfaceDNSSettings
DNS Settings for the interface
ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Inputs.ExtendedLocation
The extendedLocation of the resource.
IpConfigurations List<Pulumi.AzureNative.AzureStackHCI.Inputs.IPConfiguration>
IPConfigurations - A list of IPConfigurations of the network interface.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
MacAddress string
MacAddress - The MAC address of the network interface.
NetworkInterfaceName Changes to this property will trigger replacement. string
Name of the network interface
NetworkSecurityGroup Pulumi.AzureNative.AzureStackHCI.Inputs.NetworkSecurityGroupArmReference
NetworkSecurityGroup - Network Security Group attached to the network interface.
Tags Dictionary<string, string>
Resource tags.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CreateFromLocal bool
Boolean indicating whether this is a existing local network interface or if one should be created.
DnsSettings InterfaceDNSSettingsArgs
DNS Settings for the interface
ExtendedLocation ExtendedLocationArgs
The extendedLocation of the resource.
IpConfigurations []IPConfigurationArgs
IPConfigurations - A list of IPConfigurations of the network interface.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
MacAddress string
MacAddress - The MAC address of the network interface.
NetworkInterfaceName Changes to this property will trigger replacement. string
Name of the network interface
NetworkSecurityGroup NetworkSecurityGroupArmReferenceArgs
NetworkSecurityGroup - Network Security Group attached to the network interface.
Tags map[string]string
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
createFromLocal Boolean
Boolean indicating whether this is a existing local network interface or if one should be created.
dnsSettings InterfaceDNSSettings
DNS Settings for the interface
extendedLocation ExtendedLocation
The extendedLocation of the resource.
ipConfigurations List<IPConfiguration>
IPConfigurations - A list of IPConfigurations of the network interface.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
macAddress String
MacAddress - The MAC address of the network interface.
networkInterfaceName Changes to this property will trigger replacement. String
Name of the network interface
networkSecurityGroup NetworkSecurityGroupArmReference
NetworkSecurityGroup - Network Security Group attached to the network interface.
tags Map<String,String>
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
createFromLocal boolean
Boolean indicating whether this is a existing local network interface or if one should be created.
dnsSettings InterfaceDNSSettings
DNS Settings for the interface
extendedLocation ExtendedLocation
The extendedLocation of the resource.
ipConfigurations IPConfiguration[]
IPConfigurations - A list of IPConfigurations of the network interface.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
macAddress string
MacAddress - The MAC address of the network interface.
networkInterfaceName Changes to this property will trigger replacement. string
Name of the network interface
networkSecurityGroup NetworkSecurityGroupArmReference
NetworkSecurityGroup - Network Security Group attached to the network interface.
tags {[key: string]: string}
Resource tags.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
create_from_local bool
Boolean indicating whether this is a existing local network interface or if one should be created.
dns_settings InterfaceDNSSettingsArgs
DNS Settings for the interface
extended_location ExtendedLocationArgs
The extendedLocation of the resource.
ip_configurations Sequence[IPConfigurationArgs]
IPConfigurations - A list of IPConfigurations of the network interface.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
mac_address str
MacAddress - The MAC address of the network interface.
network_interface_name Changes to this property will trigger replacement. str
Name of the network interface
network_security_group NetworkSecurityGroupArmReferenceArgs
NetworkSecurityGroup - Network Security Group attached to the network interface.
tags Mapping[str, str]
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
createFromLocal Boolean
Boolean indicating whether this is a existing local network interface or if one should be created.
dnsSettings Property Map
DNS Settings for the interface
extendedLocation Property Map
The extendedLocation of the resource.
ipConfigurations List<Property Map>
IPConfigurations - A list of IPConfigurations of the network interface.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
macAddress String
MacAddress - The MAC address of the network interface.
networkInterfaceName Changes to this property will trigger replacement. String
Name of the network interface
networkSecurityGroup Property Map
NetworkSecurityGroup - Network Security Group attached to the network interface.
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkInterface resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the network interface.
Status Pulumi.AzureNative.AzureStackHCI.Outputs.NetworkInterfaceStatusResponse
The observed state of network interfaces
SystemData Pulumi.AzureNative.AzureStackHCI.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the network interface.
Status NetworkInterfaceStatusResponse
The observed state of network interfaces
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the network interface.
status NetworkInterfaceStatusResponse
The observed state of network interfaces
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Provisioning state of the network interface.
status NetworkInterfaceStatusResponse
The observed state of network interfaces
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Provisioning state of the network interface.
status NetworkInterfaceStatusResponse
The observed state of network interfaces
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the network interface.
status Property Map
The observed state of network interfaces
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ExtendedLocation
, ExtendedLocationArgs

Name string
The name of the extended location.
Type string | Pulumi.AzureNative.AzureStackHCI.ExtendedLocationTypes
The type of the extended location.
Name string
The name of the extended location.
Type string | ExtendedLocationTypes
The type of the extended location.
name String
The name of the extended location.
type String | ExtendedLocationTypes
The type of the extended location.
name string
The name of the extended location.
type string | ExtendedLocationTypes
The type of the extended location.
name str
The name of the extended location.
type str | ExtendedLocationTypes
The type of the extended location.
name String
The name of the extended location.
type String | "CustomLocation"
The type of the extended location.

ExtendedLocationResponse
, ExtendedLocationResponseArgs

Name string
The name of the extended location.
Type string
The type of the extended location.
Name string
The name of the extended location.
Type string
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.
name string
The name of the extended location.
type string
The type of the extended location.
name str
The name of the extended location.
type str
The type of the extended location.
name String
The name of the extended location.
type String
The type of the extended location.

ExtendedLocationTypes
, ExtendedLocationTypesArgs

CustomLocation
CustomLocation
ExtendedLocationTypesCustomLocation
CustomLocation
CustomLocation
CustomLocation
CustomLocation
CustomLocation
CUSTOM_LOCATION
CustomLocation
"CustomLocation"
CustomLocation

IPConfiguration
, IPConfigurationArgs

Name string
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Properties Pulumi.AzureNative.AzureStackHCI.Inputs.IPConfigurationProperties
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
Name string
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Properties IPConfigurationProperties
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name String
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties IPConfigurationProperties
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name string
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties IPConfigurationProperties
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name str
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties IPConfigurationProperties
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name String
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties Property Map
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.

IPConfigurationProperties
, IPConfigurationPropertiesArgs

PrivateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
Subnet Pulumi.AzureNative.AzureStackHCI.Inputs.LogicalNetworkArmReference
Subnet - Name of Subnet bound to the IP configuration.
PrivateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
Subnet LogicalNetworkArmReference
Subnet - Name of Subnet bound to the IP configuration.
privateIPAddress String
PrivateIPAddress - Private IP address of the IP configuration.
subnet LogicalNetworkArmReference
Subnet - Name of Subnet bound to the IP configuration.
privateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
subnet LogicalNetworkArmReference
Subnet - Name of Subnet bound to the IP configuration.
private_ip_address str
PrivateIPAddress - Private IP address of the IP configuration.
subnet LogicalNetworkArmReference
Subnet - Name of Subnet bound to the IP configuration.
privateIPAddress String
PrivateIPAddress - Private IP address of the IP configuration.
subnet Property Map
Subnet - Name of Subnet bound to the IP configuration.

IPConfigurationPropertiesResponse
, IPConfigurationPropertiesResponseArgs

Gateway This property is required. string
Gateway for network interface
PrefixLength This property is required. string
prefixLength for network interface
PrivateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
Subnet Pulumi.AzureNative.AzureStackHCI.Inputs.LogicalNetworkArmReferenceResponse
Subnet - Name of Subnet bound to the IP configuration.
Gateway This property is required. string
Gateway for network interface
PrefixLength This property is required. string
prefixLength for network interface
PrivateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
Subnet LogicalNetworkArmReferenceResponse
Subnet - Name of Subnet bound to the IP configuration.
gateway This property is required. String
Gateway for network interface
prefixLength This property is required. String
prefixLength for network interface
privateIPAddress String
PrivateIPAddress - Private IP address of the IP configuration.
subnet LogicalNetworkArmReferenceResponse
Subnet - Name of Subnet bound to the IP configuration.
gateway This property is required. string
Gateway for network interface
prefixLength This property is required. string
prefixLength for network interface
privateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
subnet LogicalNetworkArmReferenceResponse
Subnet - Name of Subnet bound to the IP configuration.
gateway This property is required. str
Gateway for network interface
prefix_length This property is required. str
prefixLength for network interface
private_ip_address str
PrivateIPAddress - Private IP address of the IP configuration.
subnet LogicalNetworkArmReferenceResponse
Subnet - Name of Subnet bound to the IP configuration.
gateway This property is required. String
Gateway for network interface
prefixLength This property is required. String
prefixLength for network interface
privateIPAddress String
PrivateIPAddress - Private IP address of the IP configuration.
subnet Property Map
Subnet - Name of Subnet bound to the IP configuration.

IPConfigurationResponse
, IPConfigurationResponseArgs

Name string
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Properties Pulumi.AzureNative.AzureStackHCI.Inputs.IPConfigurationPropertiesResponse
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
Name string
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
Properties IPConfigurationPropertiesResponse
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name String
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties IPConfigurationPropertiesResponse
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name string
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties IPConfigurationPropertiesResponse
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name str
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties IPConfigurationPropertiesResponse
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.
name String
Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties Property Map
InterfaceIPConfigurationPropertiesFormat properties of IP configuration.

InterfaceDNSSettings
, InterfaceDNSSettingsArgs

DnsServers List<string>
List of DNS server IP Addresses for the interface
DnsServers []string
List of DNS server IP Addresses for the interface
dnsServers List<String>
List of DNS server IP Addresses for the interface
dnsServers string[]
List of DNS server IP Addresses for the interface
dns_servers Sequence[str]
List of DNS server IP Addresses for the interface
dnsServers List<String>
List of DNS server IP Addresses for the interface

InterfaceDNSSettingsResponse
, InterfaceDNSSettingsResponseArgs

DnsServers List<string>
List of DNS server IP Addresses for the interface
DnsServers []string
List of DNS server IP Addresses for the interface
dnsServers List<String>
List of DNS server IP Addresses for the interface
dnsServers string[]
List of DNS server IP Addresses for the interface
dns_servers Sequence[str]
List of DNS server IP Addresses for the interface
dnsServers List<String>
List of DNS server IP Addresses for the interface

LogicalNetworkArmReference
, LogicalNetworkArmReferenceArgs

Id string
The ARM ID for a Logical Network.
Id string
The ARM ID for a Logical Network.
id String
The ARM ID for a Logical Network.
id string
The ARM ID for a Logical Network.
id str
The ARM ID for a Logical Network.
id String
The ARM ID for a Logical Network.

LogicalNetworkArmReferenceResponse
, LogicalNetworkArmReferenceResponseArgs

Id string
The ARM ID for a Logical Network.
Id string
The ARM ID for a Logical Network.
id String
The ARM ID for a Logical Network.
id string
The ARM ID for a Logical Network.
id str
The ARM ID for a Logical Network.
id String
The ARM ID for a Logical Network.

NetworkInterfaceStatusProvisioningStatusResponse
, NetworkInterfaceStatusProvisioningStatusResponseArgs

Status This property is required. string
The status of the operation performed on the network interface [Succeeded, Failed, InProgress]
OperationId string
The ID of the operation performed on the network interface
Status This property is required. string
The status of the operation performed on the network interface [Succeeded, Failed, InProgress]
OperationId string
The ID of the operation performed on the network interface
status This property is required. String
The status of the operation performed on the network interface [Succeeded, Failed, InProgress]
operationId String
The ID of the operation performed on the network interface
status This property is required. string
The status of the operation performed on the network interface [Succeeded, Failed, InProgress]
operationId string
The ID of the operation performed on the network interface
status This property is required. str
The status of the operation performed on the network interface [Succeeded, Failed, InProgress]
operation_id str
The ID of the operation performed on the network interface
status This property is required. String
The status of the operation performed on the network interface [Succeeded, Failed, InProgress]
operationId String
The ID of the operation performed on the network interface

NetworkInterfaceStatusResponse
, NetworkInterfaceStatusResponseArgs

ErrorCode string
NetworkInterface provisioning error code
ErrorMessage string
Descriptive error message
ProvisioningStatus Pulumi.AzureNative.AzureStackHCI.Inputs.NetworkInterfaceStatusProvisioningStatusResponse
Network interface provisioning status
ErrorCode string
NetworkInterface provisioning error code
ErrorMessage string
Descriptive error message
ProvisioningStatus NetworkInterfaceStatusProvisioningStatusResponse
Network interface provisioning status
errorCode String
NetworkInterface provisioning error code
errorMessage String
Descriptive error message
provisioningStatus NetworkInterfaceStatusProvisioningStatusResponse
Network interface provisioning status
errorCode string
NetworkInterface provisioning error code
errorMessage string
Descriptive error message
provisioningStatus NetworkInterfaceStatusProvisioningStatusResponse
Network interface provisioning status
error_code str
NetworkInterface provisioning error code
error_message str
Descriptive error message
provisioning_status NetworkInterfaceStatusProvisioningStatusResponse
Network interface provisioning status
errorCode String
NetworkInterface provisioning error code
errorMessage String
Descriptive error message
provisioningStatus Property Map
Network interface provisioning status

NetworkSecurityGroupArmReference
, NetworkSecurityGroupArmReferenceArgs

Id string
The ARM ID for a Network Security Group.
Id string
The ARM ID for a Network Security Group.
id String
The ARM ID for a Network Security Group.
id string
The ARM ID for a Network Security Group.
id str
The ARM ID for a Network Security Group.
id String
The ARM ID for a Network Security Group.

NetworkSecurityGroupArmReferenceResponse
, NetworkSecurityGroupArmReferenceResponseArgs

Id string
The ARM ID for a Network Security Group.
Id string
The ARM ID for a Network Security Group.
id String
The ARM ID for a Network Security Group.
id string
The ARM ID for a Network Security Group.
id str
The ARM ID for a Network Security Group.
id String
The ARM ID for a Network Security Group.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

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

$ pulumi import azure-native:azurestackhci:NetworkInterface test-nic /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi