Share via


VirtualNetworkPeeringCollection Class

Definition

A class representing a collection of VirtualNetworkPeeringResource and their operations. Each VirtualNetworkPeeringResource in the collection will belong to the same instance of VirtualNetworkResource. To get a VirtualNetworkPeeringCollection instance call the GetVirtualNetworkPeerings method from an instance of VirtualNetworkResource.

public class VirtualNetworkPeeringCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Network.VirtualNetworkPeeringResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Network.VirtualNetworkPeeringResource>
Inheritance
VirtualNetworkPeeringCollection
Implements

Constructors

VirtualNetworkPeeringCollection()

Initializes a new instance of the VirtualNetworkPeeringCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, VirtualNetworkPeeringData, Nullable<SyncRemoteAddressSpace>, CancellationToken)

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
CreateOrUpdateAsync(WaitUntil, String, VirtualNetworkPeeringData, Nullable<SyncRemoteAddressSpace>, CancellationToken)

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
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}
  • Operation Id: VirtualNetworkPeerings_Get
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}
  • Operation Id: VirtualNetworkPeerings_Get
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
Get(String, CancellationToken)

Gets the specified virtual network peering.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}
  • Operation Id: VirtualNetworkPeerings_Get
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
GetAll(CancellationToken)

Gets all virtual network peerings in a virtual network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings
  • Operation Id: VirtualNetworkPeerings_List
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
GetAllAsync(CancellationToken)

Gets all virtual network peerings in a virtual network.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings
  • Operation Id: VirtualNetworkPeerings_List
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
GetAsync(String, CancellationToken)

Gets the specified virtual network peering.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}
  • Operation Id: VirtualNetworkPeerings_Get
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}
  • Operation Id: VirtualNetworkPeerings_Get
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}
  • Operation Id: VirtualNetworkPeerings_Get
  • Default Api Version: 2024-03-01
  • Resource: VirtualNetworkPeeringResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<VirtualNetworkPeeringResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<VirtualNetworkPeeringResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to

Product Versions
Azure SDK for .NET Latest, Preview