ExternalNetworks interface

Package:

@azure/arm-managednetworkfabric

Interface representing a ExternalNetworks.

Methods

beginCreate(string, string, string, ExternalNetwork, ExternalNetworksCreateOptionalParams)	Creates ExternalNetwork PUT method.
beginCreateAndWait(string, string, string, ExternalNetwork, ExternalNetworksCreateOptionalParams)	Creates ExternalNetwork PUT method.
beginDelete(string, string, string, ExternalNetworksDeleteOptionalParams)	Implements ExternalNetworks DELETE method.
beginDeleteAndWait(string, string, string, ExternalNetworksDeleteOptionalParams)	Implements ExternalNetworks DELETE method.
beginUpdate(string, string, string, ExternalNetworkPatch, ExternalNetworksUpdateOptionalParams)	API to update certain properties of the ExternalNetworks resource.
beginUpdateAdministrativeState(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateAdministrativeStateOptionalParams)	Executes update operation to enable or disable administrative State for externalNetwork.
beginUpdateAdministrativeStateAndWait(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateAdministrativeStateOptionalParams)	Executes update operation to enable or disable administrative State for externalNetwork.
beginUpdateAndWait(string, string, string, ExternalNetworkPatch, ExternalNetworksUpdateOptionalParams)	API to update certain properties of the ExternalNetworks resource.
beginUpdateStaticRouteBfdAdministrativeState(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams)	Update Static Route BFD for external Network.
beginUpdateStaticRouteBfdAdministrativeStateAndWait(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams)	Update Static Route BFD for external Network.
get(string, string, string, ExternalNetworksGetOptionalParams)	Implements ExternalNetworks GET method.
listByL3IsolationDomain(string, string, ExternalNetworksListByL3IsolationDomainOptionalParams)	Implements External Networks list by resource group GET method.

Method Details

beginCreate(string, string, string, ExternalNetwork, ExternalNetworksCreateOptionalParams)

Creates ExternalNetwork PUT method.

function beginCreate(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: ExternalNetwork, options?: ExternalNetworksCreateOptionalParams): Promise<SimplePollerLike<OperationState<ExternalNetwork>, ExternalNetwork>>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

ExternalNetwork

Request payload.

options

ExternalNetworksCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, ExternalNetwork, ExternalNetworksCreateOptionalParams)

Creates ExternalNetwork PUT method.

function beginCreateAndWait(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: ExternalNetwork, options?: ExternalNetworksCreateOptionalParams): Promise<ExternalNetwork>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

ExternalNetwork

Request payload.

options

ExternalNetworksCreateOptionalParams

The options parameters.

Returns

Promise<ExternalNetwork>

beginDelete(string, string, string, ExternalNetworksDeleteOptionalParams)

Implements ExternalNetworks DELETE method.

function beginDelete(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, options?: ExternalNetworksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

options

ExternalNetworksDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ExternalNetworksDeleteOptionalParams)

Implements ExternalNetworks DELETE method.

function beginDeleteAndWait(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, options?: ExternalNetworksDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

options

ExternalNetworksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, ExternalNetworkPatch, ExternalNetworksUpdateOptionalParams)

API to update certain properties of the ExternalNetworks resource.

function beginUpdate(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: ExternalNetworkPatch, options?: ExternalNetworksUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ExternalNetwork>, ExternalNetwork>>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

ExternalNetworkPatch

ExternalNetwork properties to update. Only annotations are supported.

options

ExternalNetworksUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAdministrativeState(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateAdministrativeStateOptionalParams)

Executes update operation to enable or disable administrative State for externalNetwork.

function beginUpdateAdministrativeState(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: UpdateAdministrativeState, options?: ExternalNetworksUpdateAdministrativeStateOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

UpdateAdministrativeState

Request payload.

options

ExternalNetworksUpdateAdministrativeStateOptionalParams

The options parameters.

Returns

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

beginUpdateAdministrativeStateAndWait(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateAdministrativeStateOptionalParams)

Executes update operation to enable or disable administrative State for externalNetwork.

function beginUpdateAdministrativeStateAndWait(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: UpdateAdministrativeState, options?: ExternalNetworksUpdateAdministrativeStateOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

UpdateAdministrativeState

Request payload.

options

ExternalNetworksUpdateAdministrativeStateOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginUpdateAndWait(string, string, string, ExternalNetworkPatch, ExternalNetworksUpdateOptionalParams)

API to update certain properties of the ExternalNetworks resource.

function beginUpdateAndWait(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: ExternalNetworkPatch, options?: ExternalNetworksUpdateOptionalParams): Promise<ExternalNetwork>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

ExternalNetworkPatch

ExternalNetwork properties to update. Only annotations are supported.

options

ExternalNetworksUpdateOptionalParams

The options parameters.

Returns

Promise<ExternalNetwork>

beginUpdateStaticRouteBfdAdministrativeState(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams)

Update Static Route BFD for external Network.

function beginUpdateStaticRouteBfdAdministrativeState(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: UpdateAdministrativeState, options?: ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

UpdateAdministrativeState

Request payload.

options

ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams

The options parameters.

Returns

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

beginUpdateStaticRouteBfdAdministrativeStateAndWait(string, string, string, UpdateAdministrativeState, ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams)

Update Static Route BFD for external Network.

function beginUpdateStaticRouteBfdAdministrativeStateAndWait(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, body: UpdateAdministrativeState, options?: ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

body

UpdateAdministrativeState

Request payload.

options

ExternalNetworksUpdateStaticRouteBfdAdministrativeStateOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

get(string, string, string, ExternalNetworksGetOptionalParams)

Implements ExternalNetworks GET method.

function get(resourceGroupName: string, l3IsolationDomainName: string, externalNetworkName: string, options?: ExternalNetworksGetOptionalParams): Promise<ExternalNetwork>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

externalNetworkName

string

Name of the External Network.

options

ExternalNetworksGetOptionalParams

The options parameters.

Returns

Promise<ExternalNetwork>

listByL3IsolationDomain(string, string, ExternalNetworksListByL3IsolationDomainOptionalParams)

Implements External Networks list by resource group GET method.

function listByL3IsolationDomain(resourceGroupName: string, l3IsolationDomainName: string, options?: ExternalNetworksListByL3IsolationDomainOptionalParams): PagedAsyncIterableIterator<ExternalNetwork, ExternalNetwork[], PageSettings>

Parameters

resourceGroupName

string

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

l3IsolationDomainName

string

Name of the L3 Isolation Domain.

options

ExternalNetworksListByL3IsolationDomainOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ExternalNetwork, ExternalNetwork[], PageSettings>