Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azurestackhci
  5. getNetworkInterface
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.azurestackhci.getNetworkInterface

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a network interface Azure REST API version: 2022-12-15-preview.

Other available API versions: 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.

Using getNetworkInterface

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNetworkInterface(args: GetNetworkInterfaceArgs, opts?: InvokeOptions): Promise<GetNetworkInterfaceResult>
function getNetworkInterfaceOutput(args: GetNetworkInterfaceOutputArgs, opts?: InvokeOptions): Output<GetNetworkInterfaceResult>
Copy
def get_network_interface(network_interface_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNetworkInterfaceResult
def get_network_interface_output(network_interface_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNetworkInterfaceResult]
Copy
func LookupNetworkInterface(ctx *Context, args *LookupNetworkInterfaceArgs, opts ...InvokeOption) (*LookupNetworkInterfaceResult, error)
func LookupNetworkInterfaceOutput(ctx *Context, args *LookupNetworkInterfaceOutputArgs, opts ...InvokeOption) LookupNetworkInterfaceResultOutput
Copy

> Note: This function is named LookupNetworkInterface in the Go SDK.

public static class GetNetworkInterface 
{
    public static Task<GetNetworkInterfaceResult> InvokeAsync(GetNetworkInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkInterfaceResult> Invoke(GetNetworkInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworkInterfaceResult> getNetworkInterface(GetNetworkInterfaceArgs args, InvokeOptions options)
public static Output<GetNetworkInterfaceResult> getNetworkInterface(GetNetworkInterfaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azurestackhci:getNetworkInterface
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkInterfaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the network interface
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
NetworkInterfaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the network interface
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
networkInterfaceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the network interface
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
networkInterfaceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the network interface
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
network_interface_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the network interface
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.
networkInterfaceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the network interface
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getNetworkInterface Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
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"
DnsSettings Pulumi.AzureNative.AzureStackHCI.Outputs.InterfaceDNSSettingsResponse
DNS Settings for the interface
ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse
The extendedLocation of the resource.
IpConfigurations List<Pulumi.AzureNative.AzureStackHCI.Outputs.IPConfigurationResponse>
IPConfigurations - A list of IPConfigurations of the network interface.
MacAddress string
MacAddress - The MAC address of the network interface.
Tags Dictionary<string, string>
Resource tags.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
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"
DnsSettings InterfaceDNSSettingsResponse
DNS Settings for the interface
ExtendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
IpConfigurations []IPConfigurationResponse
IPConfigurations - A list of IPConfigurations of the network interface.
MacAddress string
MacAddress - The MAC address of the network interface.
Tags map[string]string
Resource tags.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
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"
dnsSettings InterfaceDNSSettingsResponse
DNS Settings for the interface
extendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
ipConfigurations List<IPConfigurationResponse>
IPConfigurations - A list of IPConfigurations of the network interface.
macAddress String
MacAddress - The MAC address of the network interface.
tags Map<String,String>
Resource tags.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
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"
dnsSettings InterfaceDNSSettingsResponse
DNS Settings for the interface
extendedLocation ExtendedLocationResponse
The extendedLocation of the resource.
ipConfigurations IPConfigurationResponse[]
IPConfigurations - A list of IPConfigurations of the network interface.
macAddress string
MacAddress - The MAC address of the network interface.
tags {[key: string]: string}
Resource tags.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
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"
dns_settings InterfaceDNSSettingsResponse
DNS Settings for the interface
extended_location ExtendedLocationResponse
The extendedLocation of the resource.
ip_configurations Sequence[IPConfigurationResponse]
IPConfigurations - A list of IPConfigurations of the network interface.
mac_address str
MacAddress - The MAC address of the network interface.
tags Mapping[str, str]
Resource tags.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
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"
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.
macAddress String
MacAddress - The MAC address of the network interface.
tags Map<String>
Resource tags.

Supporting Types

ExtendedLocationResponse

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.

IPConfigurationResponse

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.IPConfigurationResponseProperties
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 IPConfigurationResponseProperties
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 IPConfigurationResponseProperties
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 IPConfigurationResponseProperties
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 IPConfigurationResponseProperties
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.

IPConfigurationResponseProperties

PrefixLength string
prefixLength for network interface
PrivateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
PrivateIPAllocationMethod string
PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic'
Subnet Pulumi.AzureNative.AzureStackHCI.Inputs.IPConfigurationResponseSubnet
Subnet - Name of Subnet bound to the IP configuration.
PrefixLength string
prefixLength for network interface
PrivateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
PrivateIPAllocationMethod string
PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic'
Subnet IPConfigurationResponseSubnet
Subnet - Name of Subnet bound to the IP configuration.
prefixLength String
prefixLength for network interface
privateIPAddress String
PrivateIPAddress - Private IP address of the IP configuration.
privateIPAllocationMethod String
PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic'
subnet IPConfigurationResponseSubnet
Subnet - Name of Subnet bound to the IP configuration.
prefixLength string
prefixLength for network interface
privateIPAddress string
PrivateIPAddress - Private IP address of the IP configuration.
privateIPAllocationMethod string
PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic'
subnet IPConfigurationResponseSubnet
Subnet - Name of Subnet bound to the IP configuration.
prefix_length str
prefixLength for network interface
private_ip_address str
PrivateIPAddress - Private IP address of the IP configuration.
private_ip_allocation_method str
PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic'
subnet IPConfigurationResponseSubnet
Subnet - Name of Subnet bound to the IP configuration.
prefixLength String
prefixLength for network interface
privateIPAddress String
PrivateIPAddress - Private IP address of the IP configuration.
privateIPAllocationMethod String
PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic'
subnet Property Map
Subnet - Name of Subnet bound to the IP configuration.

IPConfigurationResponseSubnet

Id string
ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
Id string
ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id String
ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id string
ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id str
ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id String
ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

InterfaceDNSSettingsResponse

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

NetworkInterfaceStatusResponse

ErrorCode string
NetworkInterface provisioning error code
ErrorMessage string
Descriptive error message
ProvisioningStatus NetworkInterfaceStatusResponseProvisioningStatus
errorCode String
NetworkInterface provisioning error code
errorMessage String
Descriptive error message
provisioningStatus NetworkInterfaceStatusResponseProvisioningStatus
errorCode string
NetworkInterface provisioning error code
errorMessage string
Descriptive error message
provisioningStatus NetworkInterfaceStatusResponseProvisioningStatus
error_code str
NetworkInterface provisioning error code
error_message str
Descriptive error message
provisioning_status NetworkInterfaceStatusResponseProvisioningStatus
errorCode String
NetworkInterface provisioning error code
errorMessage String
Descriptive error message
provisioningStatus Property Map

NetworkInterfaceStatusResponseProvisioningStatus

OperationId string
The ID of the operation performed on the network interface
Status 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 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 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 string
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 str
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 String
The status of the operation performed on the network interface [Succeeded, Failed, InProgress]

SystemDataResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native