ArmPeeringModelFactory.PeeringConnectivityProbe Method

Definition

Represents a connectivity probe, a configuration peers can add to direct and exchange peerings to create ping tests. These ping tests will allow us to generate availability, jitter, and latency data for traffic (using ICMP or TCP) from Azure to an endpoint IP address given by the customer. This data will be emitted such that the peer can view these metrics in the Azure portal in the Connectivity probe blade of their peering.

public static Azure.ResourceManager.Peering.Models.PeeringConnectivityProbe PeeringConnectivityProbe(string endpoint = default, string azureRegion = default, Azure.ResourceManager.Peering.Models.PeeringProtocol? protocol = default, System.Collections.Generic.IEnumerable<string> prefixesToAccesslist = default);
static member PeeringConnectivityProbe : string * string * Nullable<Azure.ResourceManager.Peering.Models.PeeringProtocol> * seq<string> -> Azure.ResourceManager.Peering.Models.PeeringConnectivityProbe
Public Shared Function PeeringConnectivityProbe (Optional endpoint As String = Nothing, Optional azureRegion As String = Nothing, Optional protocol As Nullable(Of PeeringProtocol) = Nothing, Optional prefixesToAccesslist As IEnumerable(Of String) = Nothing) As PeeringConnectivityProbe

Parameters

endpoint
String

The endpoint IP address where traffic will be sent to from Azure for the connectivity probe.

azureRegion
String

The Azure region where traffic will originate from for the connectivity probe.

protocol
Nullable<PeeringProtocol>

The protocol of the traffic that will be sent for the connectivity probe.

prefixesToAccesslist
IEnumerable<String>

Set to contain the prefixes that agents in Azure will send traffic from. For peers to allow into their network the connectivity probe traffic can reach their endpoint for the connectivity probe.

Returns

A new PeeringConnectivityProbe instance for mocking.

Applies to