Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-AzNetworkInterface
- Module:
- Az.Network Module
Gets a network interface.
Syntax
NoExpandStandAloneNic (Default)
Get-AzNetworkInterface
[-Name <String>]
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ExpandStandAloneNic
Get-AzNetworkInterface
-Name <String>
-ResourceGroupName <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
NoExpandScaleSetNic
Get-AzNetworkInterface
-ResourceGroupName <String>
[-Name <String>]
[-VirtualMachineScaleSetName <String>]
[-VirtualMachineIndex <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ExpandScaleSetNic
Get-AzNetworkInterface
-Name <String>
-ResourceGroupName <String>
-VirtualMachineScaleSetName <String>
-VirtualMachineIndex <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdExpandParameterSet
Get-AzNetworkInterface
-ResourceId <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByResourceIdNoExpandParameterSet
Get-AzNetworkInterface
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzNetworkInterface cmdlet gets an Azure network interface or a list of Azure network interfaces in a resource group.
Examples
Example 1: Get all network interfaces
Get-AzNetworkInterface
Name : test1
ResourceGroupName : ResourceGroup1
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/providers/Micros
oft.Network/networkInterfaces/test1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
VirtualMachine : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide
rs/Microsoft.Compute/virtualMachines/test1"
}
IpConfigurations : [
{
"Name": "test1",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provi
ders/Microsoft.Network/networkInterfaces/test1/ipConfigurations/test1",
"PrivateIpAddress": "x.x.x.x",
"PrivateIpAllocationMethod": "Dynamic",
"Subnet": {
"Delegations": [],
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro
viders/Microsoft.Network/virtualNetworks/test1/subnets/test1",
"ServiceAssociationLinks": []
},
"PublicIpAddress": {
"IpTags": [],
"Zones": [],
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro
viders/Microsoft.Network/publicIPAddresses/test1"
},
"ProvisioningState": "Succeeded",
"PrivateIpAddressVersion": "IPv4",
"LoadBalancerBackendAddressPools": [],
"LoadBalancerInboundNatRules": [],
"Primary": true,
"ApplicationGatewayBackendAddressPools": [],
"ApplicationSecurityGroups": []
}
]
DnsSettings : {
"DnsServers": [],
"AppliedDnsServers": []
}
EnableIPForwarding : False
EnableAcceleratedNetworking : False
NetworkSecurityGroup : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide
rs/Microsoft.Network/networkSecurityGroups/test1"
}
Primary : True
MacAddress :
This command gets all network interfaces for the current subscription.
Example 2: Get all network interfaces with a specific provisioning state
Get-AzNetworkInterface -ResourceGroupName "ResourceGroup1" | Where-Object {$_.ProvisioningState -eq 'Succeeded'}
Name : test1
ResourceGroupName : ResourceGroup1
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/providers/Micros
oft.Network/networkInterfaces/test1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
VirtualMachine : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide
rs/Microsoft.Compute/virtualMachines/test1"
}
IpConfigurations : [
{
"Name": "test1",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provi
ders/Microsoft.Network/networkInterfaces/test1/ipConfigurations/test1",
"PrivateIpAddress": "x.x.x.x",
"PrivateIpAllocationMethod": "Dynamic",
"Subnet": {
"Delegations": [],
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro
viders/Microsoft.Network/virtualNetworks/test1/subnets/test1",
"ServiceAssociationLinks": []
},
"PublicIpAddress": {
"IpTags": [],
"Zones": [],
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro
viders/Microsoft.Network/publicIPAddresses/test1"
},
"ProvisioningState": "Succeeded",
"PrivateIpAddressVersion": "IPv4",
"LoadBalancerBackendAddressPools": [],
"LoadBalancerInboundNatRules": [],
"Primary": true,
"ApplicationGatewayBackendAddressPools": [],
"ApplicationSecurityGroups": []
}
]
DnsSettings : {
"DnsServers": [],
"AppliedDnsServers": []
}
EnableIPForwarding : False
EnableAcceleratedNetworking : False
NetworkSecurityGroup : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide
rs/Microsoft.Network/networkSecurityGroups/test1"
}
Primary : True
MacAddress :
This command gets all network interfaces in the resource group named ResourceGroup1 that has a provisioning state of succeeded.
Example 3: Get network interfaces using filtering
Get-AzNetworkInterface -Name test*
Name : test1
ResourceGroupName : ResourceGroup1
Location : eastus
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/providers/Micros
oft.Network/networkInterfaces/test1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
VirtualMachine : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide
rs/Microsoft.Compute/virtualMachines/test1"
}
IpConfigurations : [
{
"Name": "test1",
"Etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provi
ders/Microsoft.Network/networkInterfaces/test1/ipConfigurations/test1",
"PrivateIpAddress": "x.x.x.x",
"PrivateIpAllocationMethod": "Dynamic",
"Subnet": {
"Delegations": [],
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro
viders/Microsoft.Network/virtualNetworks/test1/subnets/test1",
"ServiceAssociationLinks": []
},
"PublicIpAddress": {
"IpTags": [],
"Zones": [],
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/pro
viders/Microsoft.Network/publicIPAddresses/test1"
},
"ProvisioningState": "Succeeded",
"PrivateIpAddressVersion": "IPv4",
"LoadBalancerBackendAddressPools": [],
"LoadBalancerInboundNatRules": [],
"Primary": true,
"ApplicationGatewayBackendAddressPools": [],
"ApplicationSecurityGroups": []
}
]
DnsSettings : {
"DnsServers": [],
"AppliedDnsServers": []
}
EnableIPForwarding : False
EnableAcceleratedNetworking : False
NetworkSecurityGroup : {
"Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup1/provide
rs/Microsoft.Network/networkSecurityGroups/test1"
}
Primary : True
MacAddress :
This command gets all network interfaces for the current subscription that start with "test".
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-ExpandResource
The Get-AzNetworkInterface cmdlet gets an Azure network interface or a list of Azure network interfaces in a resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Specifies the name of the network interface that this cmdlet gets.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Specifies the name of the resource group from which this cmdlet gets network interfaces.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
-ResourceId
The Azure resource manager id of the network interface.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VirtualMachineIndex
Specifies the virtual machine index of the virtual machine scale set from which this cmdlet gets network interfaces.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VirtualMachineScaleSetName
Specifies the name of the virtual machine scale set from which this cmdlet gets network interfaces.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
PSNetworkInterface
Related Links
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell
Feedback
Was this page helpful?