NetworkDevicesOperations interface

Package:

@azure/arm-managednetworkfabric

Interface representing a NetworkDevices operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginReboot
beginRebootAndWait
beginRefreshConfiguration
beginRefreshConfigurationAndWait
beginRunRoCommand
beginRunRoCommandAndWait
beginRunRwCommand
beginRunRwCommandAndWait
beginUpdate
beginUpdateAdministrativeState
beginUpdateAdministrativeStateAndWait
beginUpdateAndWait
beginUpgrade
beginUpgradeAndWait
create	Create a Network Device resource
delete
get	Gets the Network Device resource details.
listByResourceGroup	List all the Network Device resources in a given resource group.
listBySubscription	List all the Network Device resources in a given subscription.
reboot	Reboot the Network Device.
refreshConfiguration	Refreshes the configuration the Network Device.
runRoCommand	Run the RO Command on the Network Device.
runRwCommand	Run the RW Command on the Network Device.
update	Update certain properties of the Network Device resource.
updateAdministrativeState	Updates the Administrative state of the Network Device.
upgrade	Upgrades the version of the Network Device.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams) => Promise<NetworkDevice>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams) => Promise<NetworkDevice>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams) => Promise<void>

beginReboot

Warning

This API is now deprecated.

use reboot instead

beginReboot: (resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

beginRebootAndWait

Warning

This API is now deprecated.

use reboot instead

beginRebootAndWait: (resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

beginRefreshConfiguration

Warning

This API is now deprecated.

use refreshConfiguration instead

beginRefreshConfiguration: (resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Property Value

(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

beginRefreshConfigurationAndWait

Warning

This API is now deprecated.

use refreshConfiguration instead

beginRefreshConfigurationAndWait: (resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

beginRunRoCommand

Warning

This API is now deprecated.

use runRoCommand instead

beginRunRoCommand: (resourceGroupName: string, networkDeviceName: string, body: DeviceRoCommand, options?: NetworkDevicesRunRoCommandOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForDeviceROCommandsOperationStatusResult>, CommonPostActionResponseForDeviceROCommandsOperationStatusResult>>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: DeviceRoCommand, options?: NetworkDevicesRunRoCommandOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForDeviceROCommandsOperationStatusResult>, CommonPostActionResponseForDeviceROCommandsOperationStatusResult>>

beginRunRoCommandAndWait

Warning

This API is now deprecated.

use runRoCommand instead

beginRunRoCommandAndWait: (resourceGroupName: string, networkDeviceName: string, body: DeviceRoCommand, options?: NetworkDevicesRunRoCommandOptionalParams) => Promise<CommonPostActionResponseForDeviceROCommandsOperationStatusResult>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: DeviceRoCommand, options?: NetworkDevicesRunRoCommandOptionalParams) => Promise<CommonPostActionResponseForDeviceROCommandsOperationStatusResult>

beginRunRwCommand

Warning

This API is now deprecated.

use runRwCommand instead

beginRunRwCommand: (resourceGroupName: string, networkDeviceName: string, body: DeviceRwCommand, options?: NetworkDevicesRunRwCommandOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForDeviceRWCommands>, CommonPostActionResponseForDeviceRWCommands>>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: DeviceRwCommand, options?: NetworkDevicesRunRwCommandOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForDeviceRWCommands>, CommonPostActionResponseForDeviceRWCommands>>

beginRunRwCommandAndWait

Warning

This API is now deprecated.

use runRwCommand instead

beginRunRwCommandAndWait: (resourceGroupName: string, networkDeviceName: string, body: DeviceRwCommand, options?: NetworkDevicesRunRwCommandOptionalParams) => Promise<CommonPostActionResponseForDeviceRWCommands>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: DeviceRwCommand, options?: NetworkDevicesRunRwCommandOptionalParams) => Promise<CommonPostActionResponseForDeviceRWCommands>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>

beginUpdateAdministrativeState

Warning

This API is now deprecated.

use updateAdministrativeState instead

beginUpdateAdministrativeState: (resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

beginUpdateAdministrativeStateAndWait

Warning

This API is now deprecated.

use updateAdministrativeState instead

beginUpdateAdministrativeStateAndWait: (resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams) => Promise<NetworkDevice>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams) => Promise<NetworkDevice>

beginUpgrade

Warning

This API is now deprecated.

use upgrade instead

beginUpgrade: (resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams) => Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

beginUpgradeAndWait

Warning

This API is now deprecated.

use upgrade instead

beginUpgradeAndWait: (resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams) => Promise<CommonPostActionResponseForStateUpdate>

create

Create a Network Device resource

create: (resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams) => PollerLike<OperationState<NetworkDevice>, NetworkDevice>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams) => PollerLike<OperationState<NetworkDevice>, NetworkDevice>

delete

delete: (resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the Network Device resource details.

get: (resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesGetOptionalParams) => Promise<NetworkDevice>

Property Value

(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesGetOptionalParams) => Promise<NetworkDevice>

listByResourceGroup

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

listByResourceGroup: (resourceGroupName: string, options?: NetworkDevicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<NetworkDevice, NetworkDevice[], PageSettings>

Property Value

(resourceGroupName: string, options?: NetworkDevicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<NetworkDevice, NetworkDevice[], PageSettings>

listBySubscription

List all the Network Device resources in a given subscription.

listBySubscription: (options?: NetworkDevicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<NetworkDevice, NetworkDevice[], PageSettings>

Property Value

(options?: NetworkDevicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<NetworkDevice, NetworkDevice[], PageSettings>

reboot

Reboot the Network Device.

reboot: (resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>

refreshConfiguration

Refreshes the configuration the Network Device.

refreshConfiguration: (resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>

runRoCommand

Run the RO Command on the Network Device.

runRoCommand: (resourceGroupName: string, networkDeviceName: string, body: DeviceRoCommand, options?: NetworkDevicesRunRoCommandOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForDeviceROCommandsOperationStatusResult>, CommonPostActionResponseForDeviceROCommandsOperationStatusResult>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: DeviceRoCommand, options?: NetworkDevicesRunRoCommandOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForDeviceROCommandsOperationStatusResult>, CommonPostActionResponseForDeviceROCommandsOperationStatusResult>

runRwCommand

Run the RW Command on the Network Device.

runRwCommand: (resourceGroupName: string, networkDeviceName: string, body: DeviceRwCommand, options?: NetworkDevicesRunRwCommandOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForDeviceRWCommands>, CommonPostActionResponseForDeviceRWCommands>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: DeviceRwCommand, options?: NetworkDevicesRunRwCommandOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForDeviceRWCommands>, CommonPostActionResponseForDeviceRWCommands>

update

Update certain properties of the Network Device resource.

update: (resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams) => PollerLike<OperationState<NetworkDevice>, NetworkDevice>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams) => PollerLike<OperationState<NetworkDevice>, NetworkDevice>

updateAdministrativeState

Updates the Administrative state of the Network Device.

updateAdministrativeState: (resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>

upgrade

Upgrades the version of the Network Device.

upgrade: (resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>

Property Value

(resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams) => PollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>