ConnectionAnalyzerEndpoint Class

Definition

Namespace:

Azure.ResourceManager.Network.Models

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.17.0

Source:

ConnectionAnalyzerEndpoint.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 class ConnectionAnalyzerEndpoint : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Network.Models.ConnectionAnalyzerEndpoint>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Network.Models.ConnectionAnalyzerEndpoint>

type ConnectionAnalyzerEndpoint = class
    interface IJsonModel<ConnectionAnalyzerEndpoint>
    interface IPersistableModel<ConnectionAnalyzerEndpoint>

Public Class ConnectionAnalyzerEndpoint
Implements IJsonModel(Of ConnectionAnalyzerEndpoint), IPersistableModel(Of ConnectionAnalyzerEndpoint)

Inheritance

Object

ConnectionAnalyzerEndpoint

Implements

IJsonModel<ConnectionAnalyzerEndpoint> IPersistableModel<ConnectionAnalyzerEndpoint> IPersistableModel<T>

Constructors

Name	Description
ConnectionAnalyzerEndpoint(ConnectionAnalyzerEndpointType)	Initializes a new instance of ConnectionAnalyzerEndpoint.

Properties

Name	Description
Address	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	Port to use for the endpoint (0-65535).
ResourceId	ARM resource ID of the endpoint resource. Required when type is VM, VMSS, BastionHost, or ApplicationGateway. Not used when type is ExternalAddress.
Type	The type of the endpoint. Determines which of resourceId and address are required; see the model-level documentation for the per-type contract.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<ConnectionAnalyzerEndpoint>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ConnectionAnalyzerEndpoint>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ConnectionAnalyzerEndpoint>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ConnectionAnalyzerEndpoint>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ConnectionAnalyzerEndpoint>.Write(ModelReaderWriterOptions)