ConnectionAnalyzerEndpoint Class

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.

Constructor

ConnectionAnalyzerEndpoint(*args: Any, **kwargs: Any)

Variables

Name Description
type
str or ConnectionAnalyzerEndpointType

The type of the endpoint. Determines which of resourceId and address are required; see the model-level documentation for the per-type contract. Required. Known values are: "VM", "VMSS", "ExternalAddress", "BastionHost", and "ApplicationGateway".
resource_id
str

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

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
int

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

Attributes

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).

address: str | None

port

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

port: int | None

resource_id

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

resource_id: str | None

type

The type of the endpoint. Determines which of resourceId and address are required; see the model-level documentation for the per-type contract. Required. Known values are: "VM", "VMSS", "ExternalAddress", "BastionHost", and "ApplicationGateway".

type: str | _models.ConnectionAnalyzerEndpointType