NetworkPacketBrokers interface

Package:

@azure/arm-managednetworkfabric

Interface representing a NetworkPacketBrokers.

Methods

beginCreate(string, string, NetworkPacketBroker, NetworkPacketBrokersCreateOptionalParams)	Creates a Network Packet Broker.
beginCreateAndWait(string, string, NetworkPacketBroker, NetworkPacketBrokersCreateOptionalParams)	Creates a Network Packet Broker.
beginDelete(string, string, NetworkPacketBrokersDeleteOptionalParams)	Deletes Network Packet Broker.
beginDeleteAndWait(string, string, NetworkPacketBrokersDeleteOptionalParams)	Deletes Network Packet Broker.
beginUpdate(string, string, NetworkPacketBrokerPatch, NetworkPacketBrokersUpdateOptionalParams)	API to update certain properties of the Network Packet Broker resource.
beginUpdateAndWait(string, string, NetworkPacketBrokerPatch, NetworkPacketBrokersUpdateOptionalParams)	API to update certain properties of the Network Packet Broker resource.
get(string, string, NetworkPacketBrokersGetOptionalParams)	Retrieves details of this Network Packet Broker.
listByResourceGroup(string, NetworkPacketBrokersListByResourceGroupOptionalParams)	Displays NetworkPacketBrokers list by resource group GET method.
listBySubscription(NetworkPacketBrokersListBySubscriptionOptionalParams)	Displays Network Packet Brokers list by subscription GET method.

Method Details

beginCreate(string, string, NetworkPacketBroker, NetworkPacketBrokersCreateOptionalParams)

Creates a Network Packet Broker.

function beginCreate(resourceGroupName: string, networkPacketBrokerName: string, body: NetworkPacketBroker, options?: NetworkPacketBrokersCreateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkPacketBroker>, NetworkPacketBroker>>

Parameters

resourceGroupName

string

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

networkPacketBrokerName

string

Name of the Network Packet Broker.

body

NetworkPacketBroker

Request payload.

options

NetworkPacketBrokersCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, NetworkPacketBroker, NetworkPacketBrokersCreateOptionalParams)

Creates a Network Packet Broker.

function beginCreateAndWait(resourceGroupName: string, networkPacketBrokerName: string, body: NetworkPacketBroker, options?: NetworkPacketBrokersCreateOptionalParams): Promise<NetworkPacketBroker>

Parameters

resourceGroupName

string

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

networkPacketBrokerName

string

Name of the Network Packet Broker.

body

NetworkPacketBroker

Request payload.

options

NetworkPacketBrokersCreateOptionalParams

The options parameters.

Returns

Promise<NetworkPacketBroker>

beginDelete(string, string, NetworkPacketBrokersDeleteOptionalParams)

Deletes Network Packet Broker.

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

Parameters

resourceGroupName

string

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

networkPacketBrokerName

string

Name of the Network Packet Broker.

options

NetworkPacketBrokersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, NetworkPacketBrokersDeleteOptionalParams)

Deletes Network Packet Broker.

function beginDeleteAndWait(resourceGroupName: string, networkPacketBrokerName: string, options?: NetworkPacketBrokersDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

networkPacketBrokerName

string

Name of the Network Packet Broker.

options

NetworkPacketBrokersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, NetworkPacketBrokerPatch, NetworkPacketBrokersUpdateOptionalParams)

API to update certain properties of the Network Packet Broker resource.

function beginUpdate(resourceGroupName: string, networkPacketBrokerName: string, body: NetworkPacketBrokerPatch, options?: NetworkPacketBrokersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkPacketBroker>, NetworkPacketBroker>>

Parameters

resourceGroupName

string

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

networkPacketBrokerName

string

Name of the Network Packet Broker.

body

NetworkPacketBrokerPatch

Network Packet Broker properties to update.

options

NetworkPacketBrokersUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, NetworkPacketBrokerPatch, NetworkPacketBrokersUpdateOptionalParams)

API to update certain properties of the Network Packet Broker resource.

function beginUpdateAndWait(resourceGroupName: string, networkPacketBrokerName: string, body: NetworkPacketBrokerPatch, options?: NetworkPacketBrokersUpdateOptionalParams): Promise<NetworkPacketBroker>

Parameters

resourceGroupName

string

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

networkPacketBrokerName

string

Name of the Network Packet Broker.

body

NetworkPacketBrokerPatch

Network Packet Broker properties to update.

options

NetworkPacketBrokersUpdateOptionalParams

The options parameters.

Returns

Promise<NetworkPacketBroker>

get(string, string, NetworkPacketBrokersGetOptionalParams)

Retrieves details of this Network Packet Broker.

function get(resourceGroupName: string, networkPacketBrokerName: string, options?: NetworkPacketBrokersGetOptionalParams): Promise<NetworkPacketBroker>

Parameters

resourceGroupName

string

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

networkPacketBrokerName

string

Name of the Network Packet Broker.

options

NetworkPacketBrokersGetOptionalParams

The options parameters.

Returns

Promise<NetworkPacketBroker>

listByResourceGroup(string, NetworkPacketBrokersListByResourceGroupOptionalParams)

Displays NetworkPacketBrokers list by resource group GET method.

function listByResourceGroup(resourceGroupName: string, options?: NetworkPacketBrokersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NetworkPacketBroker, NetworkPacketBroker[], PageSettings>

Parameters

resourceGroupName

string

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

options

NetworkPacketBrokersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkPacketBroker, NetworkPacketBroker[], PageSettings>

listBySubscription(NetworkPacketBrokersListBySubscriptionOptionalParams)

Displays Network Packet Brokers list by subscription GET method.

function listBySubscription(options?: NetworkPacketBrokersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetworkPacketBroker, NetworkPacketBroker[], PageSettings>

Parameters

options

NetworkPacketBrokersListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkPacketBroker, NetworkPacketBroker[], PageSettings>