1. Manuals
  2. Leap-15.6
  3. python3-azurectl
  4. azurectl::compute::endpoint(1)

Scroll to navigation

AZURECTL(1) AZURECTL(1)

NAME

azurectl - Command Line Interface to manage Microsoft Azure

An endpoint describes a rule forwarding either TCP or UDP traffic from a public port on a cloud service to a private port on a virtual machine instance. Endpoints are identified by a user-defined name.

SYNOPSIS

azurectl compute endpoint create --cloud-service-name=name --name=name --port=port

[--instance-name=name]
[--instance-port=port]
[--idle-timeout=minutes]
[--udp]
[--wait]

azurectl compute endpoint list --cloud-service-name=name

[--instance-name=name]

azurectl compute endpoint show --cloud-service-name=name --name=name

[--instance-name=name]

azurectl compute endpoint update --cloud-service-name=name --name=name

[--instance-name=name]
[--port=port]
[--instance-port=port]
[--idle-timeout=minutes]
[--udp | --tcp]
[--wait]

azurectl compute endpoint delete --cloud-service-name=name --name=name

[--instance-name=name]
[--wait]

DESCRIPTION

create

Open a new port (endpoint) on a cloud service's network interface, forwarded to a port on the specified virtual machine instance. If the virtual machine's instance-name is the same as the cloud-service-name, the --instance-name argument may be omitted.

delete

Close a named endpoint on a cloud service.

list

List information about all endpoints forwarded to the selected virtual machine.

show

List information about a single endpoint, forwarded to the selected virtual machine, with the name name.

update

Update an existing port (endpoint) on a cloud service's network interface.

OPTIONS

--cloud-service-name=name

Name of the cloud service where the selected virtual machine may be found.

--idle-timeout=minutes

Specifies the timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes.

Note: Does not apply to UDP connections.

--instance-name=name

Name of the virtual machine instance. If no name is given, the instance name is assumed to be the same as the cloud-service-name.

--instance-port=port

Numbered port on the instance to which traffic will be forward from the port of the cloud-service. If no port is given, the instance port is assumed to be the same as the cloud service port.

--name=name

Name of the endpoint, usually the name of the protocol that is carried.

--port=port

Numbered port to open on the cloud service. All traffic to this port will be forwarded to the selected virtual machine instance on its instance-port.

--tcp

Select TCP as the transport protocol for the endpoint. (update only)

--udp

Select UDP as the transport protocol for the endpoint. Otherwise, the transport protocol will be assumed to be TCP.

--wait

wait for the request to change its status to succeeded

AZURECTL User Manuals