NetworkFabrics interface

Package:

@azure/arm-managednetworkfabric

Interface representing a NetworkFabrics.

Methods

beginCommitConfiguration(string, string, NetworkFabricsCommitConfigurationOptionalParams)	Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.
beginCommitConfigurationAndWait(string, string, NetworkFabricsCommitConfigurationOptionalParams)	Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.
beginCreate(string, string, NetworkFabric, NetworkFabricsCreateOptionalParams)	Create Network Fabric resource.
beginCreateAndWait(string, string, NetworkFabric, NetworkFabricsCreateOptionalParams)	Create Network Fabric resource.
beginDelete(string, string, NetworkFabricsDeleteOptionalParams)	Delete Network Fabric resource.
beginDeleteAndWait(string, string, NetworkFabricsDeleteOptionalParams)	Delete Network Fabric resource.
beginDeprovision(string, string, NetworkFabricsDeprovisionOptionalParams)	Deprovisions the underlying resources in the given Network Fabric instance.
beginDeprovisionAndWait(string, string, NetworkFabricsDeprovisionOptionalParams)	Deprovisions the underlying resources in the given Network Fabric instance.
beginGetTopology(string, string, NetworkFabricsGetTopologyOptionalParams)	Gets Topology of the underlying resources in the given Network Fabric instance.
beginGetTopologyAndWait(string, string, NetworkFabricsGetTopologyOptionalParams)	Gets Topology of the underlying resources in the given Network Fabric instance.
beginProvision(string, string, NetworkFabricsProvisionOptionalParams)	Provisions the underlying resources in the given Network Fabric instance.
beginProvisionAndWait(string, string, NetworkFabricsProvisionOptionalParams)	Provisions the underlying resources in the given Network Fabric instance.
beginRefreshConfiguration(string, string, NetworkFabricsRefreshConfigurationOptionalParams)	Refreshes the configuration of the underlying resources in the given Network Fabric instance.
beginRefreshConfigurationAndWait(string, string, NetworkFabricsRefreshConfigurationOptionalParams)	Refreshes the configuration of the underlying resources in the given Network Fabric instance.
beginUpdate(string, string, NetworkFabricPatch, NetworkFabricsUpdateOptionalParams)	Update certain properties of the Network Fabric resource.
beginUpdateAndWait(string, string, NetworkFabricPatch, NetworkFabricsUpdateOptionalParams)	Update certain properties of the Network Fabric resource.
beginUpdateInfraManagementBfdConfiguration(string, string, UpdateAdministrativeState, NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams)	Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.
beginUpdateInfraManagementBfdConfigurationAndWait(string, string, UpdateAdministrativeState, NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams)	Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.
beginUpdateWorkloadManagementBfdConfiguration(string, string, UpdateAdministrativeState, NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams)	Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.
beginUpdateWorkloadManagementBfdConfigurationAndWait(string, string, UpdateAdministrativeState, NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams)	Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.
beginUpgrade(string, string, UpdateVersion, NetworkFabricsUpgradeOptionalParams)	Upgrades the version of the underlying resources in the given Network Fabric instance.
beginUpgradeAndWait(string, string, UpdateVersion, NetworkFabricsUpgradeOptionalParams)	Upgrades the version of the underlying resources in the given Network Fabric instance.
beginValidateConfiguration(string, string, ValidateConfigurationProperties, NetworkFabricsValidateConfigurationOptionalParams)	Validates the configuration of the underlying resources in the given Network Fabric instance.
beginValidateConfigurationAndWait(string, string, ValidateConfigurationProperties, NetworkFabricsValidateConfigurationOptionalParams)	Validates the configuration of the underlying resources in the given Network Fabric instance.
get(string, string, NetworkFabricsGetOptionalParams)	Get Network Fabric resource details.
listByResourceGroup(string, NetworkFabricsListByResourceGroupOptionalParams)	List all the Network Fabric resources in the given resource group.
listBySubscription(NetworkFabricsListBySubscriptionOptionalParams)	List all the Network Fabric resources in the given subscription.

Method Details

beginCommitConfiguration(string, string, NetworkFabricsCommitConfigurationOptionalParams)

Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.

function beginCommitConfiguration(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsCommitConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsCommitConfigurationOptionalParams

The options parameters.

Returns

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

beginCommitConfigurationAndWait(string, string, NetworkFabricsCommitConfigurationOptionalParams)

Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.

function beginCommitConfigurationAndWait(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsCommitConfigurationOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsCommitConfigurationOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginCreate(string, string, NetworkFabric, NetworkFabricsCreateOptionalParams)

Create Network Fabric resource.

function beginCreate(resourceGroupName: string, networkFabricName: string, body: NetworkFabric, options?: NetworkFabricsCreateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkFabric>, NetworkFabric>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

NetworkFabric

Request payload.

options

NetworkFabricsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, NetworkFabric, NetworkFabricsCreateOptionalParams)

Create Network Fabric resource.

function beginCreateAndWait(resourceGroupName: string, networkFabricName: string, body: NetworkFabric, options?: NetworkFabricsCreateOptionalParams): Promise<NetworkFabric>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

NetworkFabric

Request payload.

options

NetworkFabricsCreateOptionalParams

The options parameters.

Returns

Promise<NetworkFabric>

beginDelete(string, string, NetworkFabricsDeleteOptionalParams)

Delete Network Fabric resource.

function beginDelete(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<NetworkFabricsDeleteHeaders>, NetworkFabricsDeleteHeaders>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, NetworkFabricsDeleteOptionalParams)

Delete Network Fabric resource.

function beginDeleteAndWait(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsDeleteOptionalParams): Promise<NetworkFabricsDeleteHeaders>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsDeleteOptionalParams

The options parameters.

Returns

Promise<NetworkFabricsDeleteHeaders>

beginDeprovision(string, string, NetworkFabricsDeprovisionOptionalParams)

Deprovisions the underlying resources in the given Network Fabric instance.

function beginDeprovision(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsDeprovisionOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForDeviceUpdate>, CommonPostActionResponseForDeviceUpdate>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsDeprovisionOptionalParams

The options parameters.

Returns

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

beginDeprovisionAndWait(string, string, NetworkFabricsDeprovisionOptionalParams)

Deprovisions the underlying resources in the given Network Fabric instance.

function beginDeprovisionAndWait(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsDeprovisionOptionalParams): Promise<CommonPostActionResponseForDeviceUpdate>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsDeprovisionOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForDeviceUpdate>

beginGetTopology(string, string, NetworkFabricsGetTopologyOptionalParams)

Gets Topology of the underlying resources in the given Network Fabric instance.

function beginGetTopology(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsGetTopologyOptionalParams): Promise<SimplePollerLike<OperationState<ValidateConfigurationResponse>, ValidateConfigurationResponse>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsGetTopologyOptionalParams

The options parameters.

Returns

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

beginGetTopologyAndWait(string, string, NetworkFabricsGetTopologyOptionalParams)

Gets Topology of the underlying resources in the given Network Fabric instance.

function beginGetTopologyAndWait(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsGetTopologyOptionalParams): Promise<ValidateConfigurationResponse>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsGetTopologyOptionalParams

The options parameters.

Returns

Promise<ValidateConfigurationResponse>

beginProvision(string, string, NetworkFabricsProvisionOptionalParams)

Provisions the underlying resources in the given Network Fabric instance.

function beginProvision(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsProvisionOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForDeviceUpdate>, CommonPostActionResponseForDeviceUpdate>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsProvisionOptionalParams

The options parameters.

Returns

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

beginProvisionAndWait(string, string, NetworkFabricsProvisionOptionalParams)

Provisions the underlying resources in the given Network Fabric instance.

function beginProvisionAndWait(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsProvisionOptionalParams): Promise<CommonPostActionResponseForDeviceUpdate>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsProvisionOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForDeviceUpdate>

beginRefreshConfiguration(string, string, NetworkFabricsRefreshConfigurationOptionalParams)

Refreshes the configuration of the underlying resources in the given Network Fabric instance.

function beginRefreshConfiguration(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsRefreshConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsRefreshConfigurationOptionalParams

The options parameters.

Returns

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

beginRefreshConfigurationAndWait(string, string, NetworkFabricsRefreshConfigurationOptionalParams)

Refreshes the configuration of the underlying resources in the given Network Fabric instance.

function beginRefreshConfigurationAndWait(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsRefreshConfigurationOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsRefreshConfigurationOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginUpdate(string, string, NetworkFabricPatch, NetworkFabricsUpdateOptionalParams)

Update certain properties of the Network Fabric resource.

function beginUpdate(resourceGroupName: string, networkFabricName: string, body: NetworkFabricPatch, options?: NetworkFabricsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkFabric>, NetworkFabric>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

NetworkFabricPatch

Network Fabric properties to update.

options

NetworkFabricsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, NetworkFabricPatch, NetworkFabricsUpdateOptionalParams)

Update certain properties of the Network Fabric resource.

function beginUpdateAndWait(resourceGroupName: string, networkFabricName: string, body: NetworkFabricPatch, options?: NetworkFabricsUpdateOptionalParams): Promise<NetworkFabric>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

NetworkFabricPatch

Network Fabric properties to update.

options

NetworkFabricsUpdateOptionalParams

The options parameters.

Returns

Promise<NetworkFabric>

beginUpdateInfraManagementBfdConfiguration(string, string, UpdateAdministrativeState, NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams)

Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.

function beginUpdateInfraManagementBfdConfiguration(resourceGroupName: string, networkFabricName: string, body: UpdateAdministrativeState, options?: NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

UpdateAdministrativeState

Request payload.

options

NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams

The options parameters.

Returns

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

beginUpdateInfraManagementBfdConfigurationAndWait(string, string, UpdateAdministrativeState, NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams)

Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.

function beginUpdateInfraManagementBfdConfigurationAndWait(resourceGroupName: string, networkFabricName: string, body: UpdateAdministrativeState, options?: NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

UpdateAdministrativeState

Request payload.

options

NetworkFabricsUpdateInfraManagementBfdConfigurationOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginUpdateWorkloadManagementBfdConfiguration(string, string, UpdateAdministrativeState, NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams)

Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.

function beginUpdateWorkloadManagementBfdConfiguration(resourceGroupName: string, networkFabricName: string, body: UpdateAdministrativeState, options?: NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

UpdateAdministrativeState

Request payload.

options

NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams

The options parameters.

Returns

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

beginUpdateWorkloadManagementBfdConfigurationAndWait(string, string, UpdateAdministrativeState, NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams)

Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.

function beginUpdateWorkloadManagementBfdConfigurationAndWait(resourceGroupName: string, networkFabricName: string, body: UpdateAdministrativeState, options?: NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

UpdateAdministrativeState

Request payload.

options

NetworkFabricsUpdateWorkloadManagementBfdConfigurationOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginUpgrade(string, string, UpdateVersion, NetworkFabricsUpgradeOptionalParams)

Upgrades the version of the underlying resources in the given Network Fabric instance.

function beginUpgrade(resourceGroupName: string, networkFabricName: string, body: UpdateVersion, options?: NetworkFabricsUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<CommonPostActionResponseForStateUpdate>, CommonPostActionResponseForStateUpdate>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

UpdateVersion

Network Fabric properties to update.

options

NetworkFabricsUpgradeOptionalParams

The options parameters.

Returns

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

beginUpgradeAndWait(string, string, UpdateVersion, NetworkFabricsUpgradeOptionalParams)

Upgrades the version of the underlying resources in the given Network Fabric instance.

function beginUpgradeAndWait(resourceGroupName: string, networkFabricName: string, body: UpdateVersion, options?: NetworkFabricsUpgradeOptionalParams): Promise<CommonPostActionResponseForStateUpdate>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

UpdateVersion

Network Fabric properties to update.

options

NetworkFabricsUpgradeOptionalParams

The options parameters.

Returns

Promise<CommonPostActionResponseForStateUpdate>

beginValidateConfiguration(string, string, ValidateConfigurationProperties, NetworkFabricsValidateConfigurationOptionalParams)

Validates the configuration of the underlying resources in the given Network Fabric instance.

function beginValidateConfiguration(resourceGroupName: string, networkFabricName: string, body: ValidateConfigurationProperties, options?: NetworkFabricsValidateConfigurationOptionalParams): Promise<SimplePollerLike<OperationState<ValidateConfigurationResponse>, ValidateConfigurationResponse>>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

ValidateConfigurationProperties

Validate configuration properties.

options

NetworkFabricsValidateConfigurationOptionalParams

The options parameters.

Returns

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

beginValidateConfigurationAndWait(string, string, ValidateConfigurationProperties, NetworkFabricsValidateConfigurationOptionalParams)

Validates the configuration of the underlying resources in the given Network Fabric instance.

function beginValidateConfigurationAndWait(resourceGroupName: string, networkFabricName: string, body: ValidateConfigurationProperties, options?: NetworkFabricsValidateConfigurationOptionalParams): Promise<ValidateConfigurationResponse>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

body

ValidateConfigurationProperties

Validate configuration properties.

options

NetworkFabricsValidateConfigurationOptionalParams

The options parameters.

Returns

Promise<ValidateConfigurationResponse>

get(string, string, NetworkFabricsGetOptionalParams)

Get Network Fabric resource details.

function get(resourceGroupName: string, networkFabricName: string, options?: NetworkFabricsGetOptionalParams): Promise<NetworkFabric>

Parameters

resourceGroupName

string

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

networkFabricName

string

Name of the Network Fabric.

options

NetworkFabricsGetOptionalParams

The options parameters.

Returns

Promise<NetworkFabric>

listByResourceGroup(string, NetworkFabricsListByResourceGroupOptionalParams)

List all the Network Fabric resources in the given resource group.

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

Parameters

resourceGroupName

string

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

options

NetworkFabricsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkFabric, NetworkFabric[], PageSettings>

listBySubscription(NetworkFabricsListBySubscriptionOptionalParams)

List all the Network Fabric resources in the given subscription.

function listBySubscription(options?: NetworkFabricsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetworkFabric, NetworkFabric[], PageSettings>

Parameters

options

NetworkFabricsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NetworkFabric, NetworkFabric[], PageSettings>