NetworkInterfaces interface

Package:

@azure/arm-managednetworkfabric

Interface representing a NetworkInterfaces.

Methods

beginCreate(string, string, string, NetworkInterface, NetworkInterfacesCreateOptionalParams)	Create a Network Interface resource.
beginCreateAndWait(string, string, string, NetworkInterface, NetworkInterfacesCreateOptionalParams)	Create a Network Interface resource.
beginDelete(string, string, string, NetworkInterfacesDeleteOptionalParams)	Delete the Network Interface resource.
beginDeleteAndWait(string, string, string, NetworkInterfacesDeleteOptionalParams)	Delete the Network Interface resource.
beginUpdate(string, string, string, NetworkInterfacePatch, NetworkInterfacesUpdateOptionalParams)	Update certain properties of the Network Interface resource.
beginUpdateAdministrativeState(string, string, string, UpdateAdministrativeState, NetworkInterfacesUpdateAdministrativeStateOptionalParams)	Update the admin state of the Network Interface.
beginUpdateAdministrativeStateAndWait(string, string, string, UpdateAdministrativeState, NetworkInterfacesUpdateAdministrativeStateOptionalParams)	Update the admin state of the Network Interface.
beginUpdateAndWait(string, string, string, NetworkInterfacePatch, NetworkInterfacesUpdateOptionalParams)	Update certain properties of the Network Interface resource.
get(string, string, string, NetworkInterfacesGetOptionalParams)	Get the Network Interface resource details.
listByNetworkDevice(string, string, NetworkInterfacesListByNetworkDeviceOptionalParams)	List all the Network Interface resources in a given resource group.

Method Details

beginCreate(string, string, string, NetworkInterface, NetworkInterfacesCreateOptionalParams)

Create a Network Interface resource.

function beginCreate(resourceGroupName: string, networkDeviceName: string, networkInterfaceName: string, body: NetworkInterface, options?: NetworkInterfacesCreateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkInterface>, NetworkInterface>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

body

NetworkInterface

Request payload.

options

NetworkInterfacesCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NetworkInterface>, NetworkInterface>>

beginCreateAndWait(string, string, string, NetworkInterface, NetworkInterfacesCreateOptionalParams)

Create a Network Interface resource.

function beginCreateAndWait(resourceGroupName: string, networkDeviceName: string, networkInterfaceName: string, body: NetworkInterface, options?: NetworkInterfacesCreateOptionalParams): Promise<NetworkInterface>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

body

NetworkInterface

Request payload.

options

NetworkInterfacesCreateOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>

beginDelete(string, string, string, NetworkInterfacesDeleteOptionalParams)

Delete the Network Interface resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

options

NetworkInterfacesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, NetworkInterfacesDeleteOptionalParams)

Delete the Network Interface resource.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

options

NetworkInterfacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, NetworkInterfacePatch, NetworkInterfacesUpdateOptionalParams)

Update certain properties of the Network Interface resource.

function beginUpdate(resourceGroupName: string, networkDeviceName: string, networkInterfaceName: string, body: NetworkInterfacePatch, options?: NetworkInterfacesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkInterface>, NetworkInterface>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

body

NetworkInterfacePatch

NetworkInterface properties to update. Only tags are supported.

options

NetworkInterfacesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NetworkInterface>, NetworkInterface>>

beginUpdateAdministrativeState(string, string, string, UpdateAdministrativeState, NetworkInterfacesUpdateAdministrativeStateOptionalParams)

Update the admin state of the Network Interface.

function beginUpdateAdministrativeState(resourceGroupName: string, networkDeviceName: string, networkInterfaceName: string, body: UpdateAdministrativeState, options?: NetworkInterfacesUpdateAdministrativeStateOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

body

UpdateAdministrativeState

Request payload.

options

NetworkInterfacesUpdateAdministrativeStateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

beginUpdateAdministrativeStateAndWait(string, string, string, UpdateAdministrativeState, NetworkInterfacesUpdateAdministrativeStateOptionalParams)

Update the admin state of the Network Interface.

function beginUpdateAdministrativeStateAndWait(resourceGroupName: string, networkDeviceName: string, networkInterfaceName: string, body: UpdateAdministrativeState, options?: NetworkInterfacesUpdateAdministrativeStateOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

body

UpdateAdministrativeState

Request payload.

options

NetworkInterfacesUpdateAdministrativeStateOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginUpdateAndWait(string, string, string, NetworkInterfacePatch, NetworkInterfacesUpdateOptionalParams)

Update certain properties of the Network Interface resource.

function beginUpdateAndWait(resourceGroupName: string, networkDeviceName: string, networkInterfaceName: string, body: NetworkInterfacePatch, options?: NetworkInterfacesUpdateOptionalParams): Promise<NetworkInterface>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

body

NetworkInterfacePatch

NetworkInterface properties to update. Only tags are supported.

options

NetworkInterfacesUpdateOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>

get(string, string, string, NetworkInterfacesGetOptionalParams)

Get the Network Interface resource details.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

networkInterfaceName

string

Name of the Network Interface.

options

NetworkInterfacesGetOptionalParams

The options parameters.

Returns

Promise<NetworkInterface>

listByNetworkDevice(string, string, NetworkInterfacesListByNetworkDeviceOptionalParams)

List all the Network Interface resources in a given resource group.

function listByNetworkDevice(resourceGroupName: string, networkDeviceName: string, options?: NetworkInterfacesListByNetworkDeviceOptionalParams): PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

networkDeviceName

string

Name of the Network Device.

options

NetworkInterfacesListByNetworkDeviceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkInterface, NetworkInterface[], PageSettings>