ArmNetworkModelFactory.ConnectionAnalyzerEndpoint Method

Definition

Namespace:

Azure.ResourceManager.Network.Models

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.17.0

Source:

ArmNetworkModelFactory.cs

Describes a source or destination endpoint of a connection analyzer. The schema is intentionally permissive (a flat object) because the set of valid fields is determined by type and is enforced server-side by the Network Resource Provider. The required and allowed fields per type are:

• `VM`, `VMSS`, `BastionHost`, `ApplicationGateway`: `resourceId` is

required and must be the ARM resource ID of the corresponding resource (a virtual machine, virtual machine scale set or VMSS instance, Azure Bastion host, or Application Gateway, respectively); `address` is not used; `port` is optional.

• `ExternalAddress`: `address` is required and must be an IP address or

FQDN reachable from outside Azure; `resourceId` is not used; `port` is optional. Requests that supply fields not allowed for the chosen `type`, or omit a required field, are rejected by the service with a validation error. This follows the same convention used by `ConnectivitySource` and `ConnectivityDestination` on Network Watcher.

public static Azure.ResourceManager.Network.Models.ConnectionAnalyzerEndpoint ConnectionAnalyzerEndpoint(Azure.ResourceManager.Network.Models.ConnectionAnalyzerEndpointType type = default, Azure.Core.ResourceIdentifier resourceId = default, string address = default, int? port = default);

static member ConnectionAnalyzerEndpoint : Azure.ResourceManager.Network.Models.ConnectionAnalyzerEndpointType * Azure.Core.ResourceIdentifier * string * Nullable<int> -> Azure.ResourceManager.Network.Models.ConnectionAnalyzerEndpoint

Public Shared Function ConnectionAnalyzerEndpoint (Optional type As ConnectionAnalyzerEndpointType = Nothing, Optional resourceId As ResourceIdentifier = Nothing, Optional address As String = Nothing, Optional port As Nullable(Of Integer) = Nothing) As ConnectionAnalyzerEndpoint

Parameters

type

ConnectionAnalyzerEndpointType

The type of the endpoint. Determines which of resourceId and address are required; see the model-level documentation for the per-type contract.

resourceId

ResourceIdentifier

ARM resource ID of the endpoint resource. Required when type is VM, VMSS, BastionHost, or ApplicationGateway. Not used when type is ExternalAddress.

address

String

IP address or FQDN of the endpoint. Required when type is ExternalAddress. Not used for the resource-typed endpoint kinds (VM, VMSS, BastionHost, ApplicationGateway).

port

Nullable<Int32>

Port to use for the endpoint (0-65535).

Returns

ConnectionAnalyzerEndpoint

A new ConnectionAnalyzerEndpoint instance for mocking.