Share via


VirtualNetworkPeeringCollection.CreateOrUpdate Method

Definition

Creates or updates a peering in the specified virtual network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}
  • Operation Id: VirtualNetworkPeerings_CreateOrUpdate
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.VirtualNetworkPeeringResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string virtualNetworkPeeringName, Azure.ResourceManager.Network.VirtualNetworkPeeringData data, Azure.ResourceManager.Network.Models.SyncRemoteAddressSpace? syncRemoteAddressSpace = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.Network.VirtualNetworkPeeringData * Nullable<Azure.ResourceManager.Network.Models.SyncRemoteAddressSpace> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.VirtualNetworkPeeringResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.Network.VirtualNetworkPeeringData * Nullable<Azure.ResourceManager.Network.Models.SyncRemoteAddressSpace> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Network.VirtualNetworkPeeringResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, virtualNetworkPeeringName As String, data As VirtualNetworkPeeringData, Optional syncRemoteAddressSpace As Nullable(Of SyncRemoteAddressSpace) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of VirtualNetworkPeeringResource)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

virtualNetworkPeeringName
String

The name of the peering.

data
VirtualNetworkPeeringData

Parameters supplied to the create or update virtual network peering operation.

syncRemoteAddressSpace
Nullable<SyncRemoteAddressSpace>

Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

virtualNetworkPeeringName is an empty string, and was expected to be non-empty.

virtualNetworkPeeringName or data is null.

Applies to