NetworkDevices interface
Interface representing a NetworkDevices.
Methods
Method Details
beginCreate(string, string, NetworkDevice, NetworkDevicesCreateOptionalParams)
Create a Network Device resource
function beginCreate(resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
- body
- NetworkDevice
Request payload.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>
beginCreateAndWait(string, string, NetworkDevice, NetworkDevicesCreateOptionalParams)
Create a Network Device resource
function beginCreateAndWait(resourceGroupName: string, networkDeviceName: string, body: NetworkDevice, options?: NetworkDevicesCreateOptionalParams): Promise<NetworkDevice>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
- body
- NetworkDevice
Request payload.
The options parameters.
Returns
Promise<NetworkDevice>
beginDelete(string, string, NetworkDevicesDeleteOptionalParams)
Delete the Network Device resource.
function beginDelete(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams): 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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, NetworkDevicesDeleteOptionalParams)
Delete the Network Device resource.
function beginDeleteAndWait(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
The options parameters.
Returns
Promise<void>
beginReboot(string, string, RebootProperties, NetworkDevicesRebootOptionalParams)
Reboot the Network Device.
function beginReboot(resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams): 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.
- body
- RebootProperties
Request payload.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>
beginRebootAndWait(string, string, RebootProperties, NetworkDevicesRebootOptionalParams)
Reboot the Network Device.
function beginRebootAndWait(resourceGroupName: string, networkDeviceName: string, body: RebootProperties, options?: NetworkDevicesRebootOptionalParams): Promise<CommonPostActionResponseForStateUpdate>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
- body
- RebootProperties
Request payload.
The options parameters.
Returns
beginRefreshConfiguration(string, string, NetworkDevicesRefreshConfigurationOptionalParams)
Refreshes the configuration the Network Device.
function beginRefreshConfiguration(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams): 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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>
beginRefreshConfigurationAndWait(string, string, NetworkDevicesRefreshConfigurationOptionalParams)
Refreshes the configuration the Network Device.
function beginRefreshConfigurationAndWait(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesRefreshConfigurationOptionalParams): Promise<CommonPostActionResponseForStateUpdate>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
The options parameters.
Returns
beginUpdate(string, string, NetworkDevicePatchParameters, NetworkDevicesUpdateOptionalParams)
Update certain properties of the Network Device resource.
function beginUpdate(resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
Network Device properties to update.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<NetworkDevice>, NetworkDevice>>
beginUpdateAdministrativeState(string, string, UpdateDeviceAdministrativeState, NetworkDevicesUpdateAdministrativeStateOptionalParams)
Updates the Administrative state of the Network Device.
function beginUpdateAdministrativeState(resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams): 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.
Request payload.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>
beginUpdateAdministrativeStateAndWait(string, string, UpdateDeviceAdministrativeState, NetworkDevicesUpdateAdministrativeStateOptionalParams)
Updates the Administrative state of the Network Device.
function beginUpdateAdministrativeStateAndWait(resourceGroupName: string, networkDeviceName: string, body: UpdateDeviceAdministrativeState, options?: NetworkDevicesUpdateAdministrativeStateOptionalParams): Promise<CommonPostActionResponseForStateUpdate>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
Request payload.
The options parameters.
Returns
beginUpdateAndWait(string, string, NetworkDevicePatchParameters, NetworkDevicesUpdateOptionalParams)
Update certain properties of the Network Device resource.
function beginUpdateAndWait(resourceGroupName: string, networkDeviceName: string, body: NetworkDevicePatchParameters, options?: NetworkDevicesUpdateOptionalParams): Promise<NetworkDevice>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
Network Device properties to update.
The options parameters.
Returns
Promise<NetworkDevice>
beginUpgrade(string, string, UpdateVersion, NetworkDevicesUpgradeOptionalParams)
Upgrades the version of the Network Device.
function beginUpgrade(resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams): 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.
- body
- UpdateVersion
Request payload.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>
beginUpgradeAndWait(string, string, UpdateVersion, NetworkDevicesUpgradeOptionalParams)
Upgrades the version of the Network Device.
function beginUpgradeAndWait(resourceGroupName: string, networkDeviceName: string, body: UpdateVersion, options?: NetworkDevicesUpgradeOptionalParams): Promise<CommonPostActionResponseForStateUpdate>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
- body
- UpdateVersion
Request payload.
The options parameters.
Returns
get(string, string, NetworkDevicesGetOptionalParams)
Gets the Network Device resource details.
function get(resourceGroupName: string, networkDeviceName: string, options?: NetworkDevicesGetOptionalParams): Promise<NetworkDevice>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- networkDeviceName
-
string
Name of the Network Device.
- options
- NetworkDevicesGetOptionalParams
The options parameters.
Returns
Promise<NetworkDevice>
listByResourceGroup(string, NetworkDevicesListByResourceGroupOptionalParams)
List all the Network Device resources in a given resource group.
function listByResourceGroup(resourceGroupName: string, options?: NetworkDevicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NetworkDevice, NetworkDevice[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(NetworkDevicesListBySubscriptionOptionalParams)
List all the Network Device resources in a given subscription.
function listBySubscription(options?: NetworkDevicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetworkDevice, NetworkDevice[], PageSettings>Parameters
The options parameters.