ConnectionAnalyzerEndpoint interface
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:resourceIdis 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);addressis not used;portis optional.ExternalAddress:addressis required and must be an IP address or FQDN reachable from outside Azure;resourceIdis not used;portis 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.
Properties
| address | IP address or FQDN of the endpoint. Required when |
| port | Port to use for the endpoint (0-65535). |
| resource |
ARM resource ID of the endpoint resource. Required when |
| type | The type of the endpoint. Determines which of |
Property Details
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?: stringProperty Value
string
port
Port to use for the endpoint (0-65535).
port?: numberProperty Value
number
resourceId
ARM resource ID of the endpoint resource. Required when type is VM,
VMSS, BastionHost, or ApplicationGateway. Not used when type is
ExternalAddress.
resourceId?: stringProperty Value
string
type
The type of the endpoint. Determines which of resourceId and address
are required; see the model-level documentation for the per-type contract.
type: stringProperty Value
string