VNetPeering interface

Interface representing a VNetPeering.

Methods

beginCreateOrUpdate(string, string, string, VirtualNetworkPeering, VNetPeeringCreateOrUpdateOptionalParams)

Creates vNet Peering for workspace.

beginCreateOrUpdateAndWait(string, string, string, VirtualNetworkPeering, VNetPeeringCreateOrUpdateOptionalParams)

Creates vNet Peering for workspace.

beginDelete(string, string, string, VNetPeeringDeleteOptionalParams)

Deletes the workspace vNetPeering.

beginDeleteAndWait(string, string, string, VNetPeeringDeleteOptionalParams)

Deletes the workspace vNetPeering.

get(string, string, string, VNetPeeringGetOptionalParams)

Gets the workspace vNet Peering.

listByWorkspace(string, string, VNetPeeringListByWorkspaceOptionalParams)

Lists the workspace vNet Peerings.

Method Details

beginCreateOrUpdate(string, string, string, VirtualNetworkPeering, VNetPeeringCreateOrUpdateOptionalParams)

Creates vNet Peering for workspace.

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, peeringName: string, virtualNetworkPeeringParameters: VirtualNetworkPeering, options?: VNetPeeringCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkPeering>, VirtualNetworkPeering>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

peeringName

string

The name of the workspace vNet peering.

virtualNetworkPeeringParameters
VirtualNetworkPeering

Parameters supplied to the create workspace vNet Peering.

options
VNetPeeringCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, VirtualNetworkPeering, VNetPeeringCreateOrUpdateOptionalParams)

Creates vNet Peering for workspace.

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, peeringName: string, virtualNetworkPeeringParameters: VirtualNetworkPeering, options?: VNetPeeringCreateOrUpdateOptionalParams): Promise<VirtualNetworkPeering>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

peeringName

string

The name of the workspace vNet peering.

virtualNetworkPeeringParameters
VirtualNetworkPeering

Parameters supplied to the create workspace vNet Peering.

options
VNetPeeringCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, string, VNetPeeringDeleteOptionalParams)

Deletes the workspace vNetPeering.

function beginDelete(resourceGroupName: string, workspaceName: string, peeringName: string, options?: VNetPeeringDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

peeringName

string

The name of the workspace vNet peering.

options
VNetPeeringDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, VNetPeeringDeleteOptionalParams)

Deletes the workspace vNetPeering.

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, peeringName: string, options?: VNetPeeringDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

peeringName

string

The name of the workspace vNet peering.

options
VNetPeeringDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, VNetPeeringGetOptionalParams)

Gets the workspace vNet Peering.

function get(resourceGroupName: string, workspaceName: string, peeringName: string, options?: VNetPeeringGetOptionalParams): Promise<VirtualNetworkPeering>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

peeringName

string

The name of the workspace vNet peering.

options
VNetPeeringGetOptionalParams

The options parameters.

Returns

listByWorkspace(string, string, VNetPeeringListByWorkspaceOptionalParams)

Lists the workspace vNet Peerings.

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: VNetPeeringListByWorkspaceOptionalParams): PagedAsyncIterableIterator<VirtualNetworkPeering, VirtualNetworkPeering[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options
VNetPeeringListByWorkspaceOptionalParams

The options parameters.

Returns