NetworkInterfaces interface

Package:

@azure/arm-network

Interface representing a NetworkInterfaces.

Methods

beginCreateOrUpdate(string, string, NetworkInterface, NetworkInterfacesCreateOrUpdateOptionalParams)	Creates or updates a network interface.
beginCreateOrUpdateAndWait(string, string, NetworkInterface, NetworkInterfacesCreateOrUpdateOptionalParams)	Creates or updates a network interface.
beginDelete(string, string, NetworkInterfacesDeleteOptionalParams)	Deletes the specified network interface.
beginDeleteAndWait(string, string, NetworkInterfacesDeleteOptionalParams)	Deletes the specified network interface.
beginGetEffectiveRouteTable(string, string, NetworkInterfacesGetEffectiveRouteTableOptionalParams)	Gets all route tables applied to a network interface.
beginGetEffectiveRouteTableAndWait(string, string, NetworkInterfacesGetEffectiveRouteTableOptionalParams)	Gets all route tables applied to a network interface.
beginListEffectiveNetworkSecurityGroups(string, string, NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams)	Gets all network security groups applied to a network interface.
beginListEffectiveNetworkSecurityGroupsAndWait(string, string, NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams)	Gets all network security groups applied to a network interface.
get(string, string, NetworkInterfacesGetOptionalParams)	Gets information about the specified network interface.
getCloudServiceNetworkInterface(string, string, string, string, NetworkInterfacesGetCloudServiceNetworkInterfaceOptionalParams)	Get the specified network interface in a cloud service.
getVirtualMachineScaleSetIpConfiguration(string, string, string, string, string, NetworkInterfacesGetVirtualMachineScaleSetIpConfigurationOptionalParams)	Get the specified network interface ip configuration in a virtual machine scale set.
getVirtualMachineScaleSetNetworkInterface(string, string, string, string, NetworkInterfacesGetVirtualMachineScaleSetNetworkInterfaceOptionalParams)	Get the specified network interface in a virtual machine scale set.
list(string, NetworkInterfacesListOptionalParams)	Gets all network interfaces in a resource group.
listAll(NetworkInterfacesListAllOptionalParams)	Gets all network interfaces in a subscription.
listCloudServiceNetworkInterfaces(string, string, NetworkInterfacesListCloudServiceNetworkInterfacesOptionalParams)	Gets all network interfaces in a cloud service.
listCloudServiceRoleInstanceNetworkInterfaces(string, string, string, NetworkInterfacesListCloudServiceRoleInstanceNetworkInterfacesOptionalParams)	Gets information about all network interfaces in a role instance in a cloud service.
listVirtualMachineScaleSetIpConfigurations(string, string, string, string, NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsOptionalParams)	Get the specified network interface ip configuration in a virtual machine scale set.
listVirtualMachineScaleSetNetworkInterfaces(string, string, NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesOptionalParams)	Gets all network interfaces in a virtual machine scale set.
listVirtualMachineScaleSetVMNetworkInterfaces(string, string, string, NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesOptionalParams)	Gets information about all network interfaces in a virtual machine in a virtual machine scale set.
updateTags(string, string, TagsObject, NetworkInterfacesUpdateTagsOptionalParams)	Updates a network interface tags.

Method Details

beginCreateOrUpdate(string, string, NetworkInterface, NetworkInterfacesCreateOrUpdateOptionalParams)

Creates or updates a network interface.

function beginCreateOrUpdate(resourceGroupName: string, networkInterfaceName: string, parameters: NetworkInterface, options?: NetworkInterfacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkInterface>, NetworkInterface>>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

parameters

NetworkInterface

Parameters supplied to the create or update network interface operation.

options

NetworkInterfacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<NetworkInterface>, NetworkInterface>>

beginCreateOrUpdateAndWait(string, string, NetworkInterface, NetworkInterfacesCreateOrUpdateOptionalParams)

Creates or updates a network interface.

function beginCreateOrUpdateAndWait(resourceGroupName: string, networkInterfaceName: string, parameters: NetworkInterface, options?: NetworkInterfacesCreateOrUpdateOptionalParams): Promise<NetworkInterface>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

parameters

NetworkInterface

Parameters supplied to the create or update network interface operation.

options

NetworkInterfacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>

beginDelete(string, string, NetworkInterfacesDeleteOptionalParams)

Deletes the specified network interface.

function beginDelete(resourceGroupName: string, networkInterfaceName: string, options?: NetworkInterfacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, NetworkInterfacesDeleteOptionalParams)

Deletes the specified network interface.

function beginDeleteAndWait(resourceGroupName: string, networkInterfaceName: string, options?: NetworkInterfacesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginGetEffectiveRouteTable(string, string, NetworkInterfacesGetEffectiveRouteTableOptionalParams)

Gets all route tables applied to a network interface.

function beginGetEffectiveRouteTable(resourceGroupName: string, networkInterfaceName: string, options?: NetworkInterfacesGetEffectiveRouteTableOptionalParams): Promise<SimplePollerLike<OperationState<EffectiveRouteListResult>, EffectiveRouteListResult>>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesGetEffectiveRouteTableOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<EffectiveRouteListResult>, EffectiveRouteListResult>>

beginGetEffectiveRouteTableAndWait(string, string, NetworkInterfacesGetEffectiveRouteTableOptionalParams)

Gets all route tables applied to a network interface.

function beginGetEffectiveRouteTableAndWait(resourceGroupName: string, networkInterfaceName: string, options?: NetworkInterfacesGetEffectiveRouteTableOptionalParams): Promise<EffectiveRouteListResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesGetEffectiveRouteTableOptionalParams

The options parameters.

Returns

Promise<EffectiveRouteListResult>

beginListEffectiveNetworkSecurityGroups(string, string, NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams)

Gets all network security groups applied to a network interface.

function beginListEffectiveNetworkSecurityGroups(resourceGroupName: string, networkInterfaceName: string, options?: NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams): Promise<SimplePollerLike<OperationState<EffectiveNetworkSecurityGroupListResult>, EffectiveNetworkSecurityGroupListResult>>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<EffectiveNetworkSecurityGroupListResult>, EffectiveNetworkSecurityGroupListResult>>

beginListEffectiveNetworkSecurityGroupsAndWait(string, string, NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams)

Gets all network security groups applied to a network interface.

function beginListEffectiveNetworkSecurityGroupsAndWait(resourceGroupName: string, networkInterfaceName: string, options?: NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams): Promise<EffectiveNetworkSecurityGroupListResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesListEffectiveNetworkSecurityGroupsOptionalParams

The options parameters.

Returns

Promise<EffectiveNetworkSecurityGroupListResult>

get(string, string, NetworkInterfacesGetOptionalParams)

Gets information about the specified network interface.

function get(resourceGroupName: string, networkInterfaceName: string, options?: NetworkInterfacesGetOptionalParams): Promise<NetworkInterface>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesGetOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>

getCloudServiceNetworkInterface(string, string, string, string, NetworkInterfacesGetCloudServiceNetworkInterfaceOptionalParams)

Get the specified network interface in a cloud service.

function getCloudServiceNetworkInterface(resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, networkInterfaceName: string, options?: NetworkInterfacesGetCloudServiceNetworkInterfaceOptionalParams): Promise<NetworkInterface>

Parameters

resourceGroupName

string

The name of the resource group.

cloudServiceName

string

The name of the cloud service.

roleInstanceName

string

The name of role instance.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesGetCloudServiceNetworkInterfaceOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>

getVirtualMachineScaleSetIpConfiguration(string, string, string, string, string, NetworkInterfacesGetVirtualMachineScaleSetIpConfigurationOptionalParams)

Get the specified network interface ip configuration in a virtual machine scale set.

function getVirtualMachineScaleSetIpConfiguration(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, ipConfigurationName: string, options?: NetworkInterfacesGetVirtualMachineScaleSetIpConfigurationOptionalParams): Promise<NetworkInterfaceIPConfiguration>

Parameters

resourceGroupName

string

The name of the resource group.

virtualMachineScaleSetName

string

The name of the virtual machine scale set.

virtualmachineIndex

string

The virtual machine index.

networkInterfaceName

string

The name of the network interface.

ipConfigurationName

string

The name of the ip configuration.

options

NetworkInterfacesGetVirtualMachineScaleSetIpConfigurationOptionalParams

The options parameters.

Returns

Promise<NetworkInterfaceIPConfiguration>

getVirtualMachineScaleSetNetworkInterface(string, string, string, string, NetworkInterfacesGetVirtualMachineScaleSetNetworkInterfaceOptionalParams)

Get the specified network interface in a virtual machine scale set.

function getVirtualMachineScaleSetNetworkInterface(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, options?: NetworkInterfacesGetVirtualMachineScaleSetNetworkInterfaceOptionalParams): Promise<NetworkInterface>

Parameters

resourceGroupName

string

The name of the resource group.

virtualMachineScaleSetName

string

The name of the virtual machine scale set.

virtualmachineIndex

string

The virtual machine index.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesGetVirtualMachineScaleSetNetworkInterfaceOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>

list(string, NetworkInterfacesListOptionalParams)

Gets all network interfaces in a resource group.

function list(resourceGroupName: string, options?: NetworkInterfacesListOptionalParams): PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

NetworkInterfacesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

listAll(NetworkInterfacesListAllOptionalParams)

Gets all network interfaces in a subscription.

function listAll(options?: NetworkInterfacesListAllOptionalParams): PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

Parameters

options

NetworkInterfacesListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

listCloudServiceNetworkInterfaces(string, string, NetworkInterfacesListCloudServiceNetworkInterfacesOptionalParams)

Gets all network interfaces in a cloud service.

function listCloudServiceNetworkInterfaces(resourceGroupName: string, cloudServiceName: string, options?: NetworkInterfacesListCloudServiceNetworkInterfacesOptionalParams): PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

cloudServiceName

string

The name of the cloud service.

options

NetworkInterfacesListCloudServiceNetworkInterfacesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

listCloudServiceRoleInstanceNetworkInterfaces(string, string, string, NetworkInterfacesListCloudServiceRoleInstanceNetworkInterfacesOptionalParams)

Gets information about all network interfaces in a role instance in a cloud service.

function listCloudServiceRoleInstanceNetworkInterfaces(resourceGroupName: string, cloudServiceName: string, roleInstanceName: string, options?: NetworkInterfacesListCloudServiceRoleInstanceNetworkInterfacesOptionalParams): PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

cloudServiceName

string

The name of the cloud service.

roleInstanceName

string

The name of role instance.

options

NetworkInterfacesListCloudServiceRoleInstanceNetworkInterfacesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

listVirtualMachineScaleSetIpConfigurations(string, string, string, string, NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsOptionalParams)

Get the specified network interface ip configuration in a virtual machine scale set.

function listVirtualMachineScaleSetIpConfigurations(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, networkInterfaceName: string, options?: NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsOptionalParams): PagedAsyncIterableIterator<NetworkInterfaceIPConfiguration, NetworkInterfaceIPConfiguration[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualMachineScaleSetName

string

The name of the virtual machine scale set.

virtualmachineIndex

string

The virtual machine index.

networkInterfaceName

string

The name of the network interface.

options

NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterfaceIPConfiguration, NetworkInterfaceIPConfiguration[], PageSettings>

listVirtualMachineScaleSetNetworkInterfaces(string, string, NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesOptionalParams)

Gets all network interfaces in a virtual machine scale set.

function listVirtualMachineScaleSetNetworkInterfaces(resourceGroupName: string, virtualMachineScaleSetName: string, options?: NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesOptionalParams): PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualMachineScaleSetName

string

The name of the virtual machine scale set.

options

NetworkInterfacesListVirtualMachineScaleSetNetworkInterfacesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

listVirtualMachineScaleSetVMNetworkInterfaces(string, string, string, NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesOptionalParams)

Gets information about all network interfaces in a virtual machine in a virtual machine scale set.

function listVirtualMachineScaleSetVMNetworkInterfaces(resourceGroupName: string, virtualMachineScaleSetName: string, virtualmachineIndex: string, options?: NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesOptionalParams): PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualMachineScaleSetName

string

The name of the virtual machine scale set.

virtualmachineIndex

string

The virtual machine index.

options

NetworkInterfacesListVirtualMachineScaleSetVMNetworkInterfacesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

updateTags(string, string, TagsObject, NetworkInterfacesUpdateTagsOptionalParams)

Updates a network interface tags.

function updateTags(resourceGroupName: string, networkInterfaceName: string, parameters: TagsObject, options?: NetworkInterfacesUpdateTagsOptionalParams): Promise<NetworkInterface>

Parameters

resourceGroupName

string

The name of the resource group.

networkInterfaceName

string

The name of the network interface.

parameters

TagsObject

Parameters supplied to update network interface tags.

options

NetworkInterfacesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>