client

Documentation

Index

• func IDToName(id string) string
• type BGPAddress
• type Client
  • func NewClient(ctx context.Context, logger *logrus.Entry, location, resourceGroup string) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) CreateLocalVNetGateway(ctx context.Context, gw LocalVNetGateway) error
  • func (c *Client) CreateNetworkGatewayConnection(ctx context.Context, conn NetworkGatewayConnection) error
  • func (c *Client) DeleteLocalVNetGateway(ctx context.Context, name string) error
  • func (c *Client) DeleteNetworkGatewayConnection(ctx context.Context, name string) error
  • func (c *Client) GetLocalVNetGateway(ctx context.Context, id string) (LocalVNetGateway, error)
  • func (c *Client) GetPublicIP(ctx context.Context, id string) (PublicIP, error)
  • func (c *Client) GetVNet(ctx context.Context, id string) (VNet, error)
  • func (c *Client) GetVNetGateway(ctx context.Context, id string) (VNetGateway, error)
  • func (c *Client) ListLocalVNetGateways(ctx context.Context) ([]LocalVNetGateway, error)
  • func (c *Client) ListNetworkGatewayConnections(ctx context.Context) ([]NetworkGatewayConnection, error)
  • func (c *Client) ListVNetGateways(ctx context.Context) ([]VNetGateway, error)
  • func (c *Client) UpdateVNetGateway(ctx context.Context, gw VNetGateway) error
• type LocalVNetGateway
• type NetworkGatewayConnection
• type PublicIP
• type ResourceGroup
• type VNet
• type VNetGateway

Functions

func IDToName

func IDToName(id string) string

Types

type BGPAddress

type BGPAddress struct {
	DefaultAddresses []string
	CustomAddresses  []string
	ConfigurationID  string
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(
	ctx context.Context, logger *logrus.Entry, location, resourceGroup string,
) (*Client, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) CreateLocalVNetGateway

func (c *Client) CreateLocalVNetGateway(ctx context.Context, gw LocalVNetGateway) error

func (*Client) CreateNetworkGatewayConnection

func (c *Client) CreateNetworkGatewayConnection(
	ctx context.Context, conn NetworkGatewayConnection,
) error

func (*Client) DeleteLocalVNetGateway

func (c *Client) DeleteLocalVNetGateway(
	ctx context.Context, name string,
) error

func (*Client) DeleteNetworkGatewayConnection

func (c *Client) DeleteNetworkGatewayConnection(
	ctx context.Context, name string,
) error

func (*Client) GetLocalVNetGateway

func (c *Client) GetLocalVNetGateway(ctx context.Context, id string) (LocalVNetGateway, error)

func (*Client) GetPublicIP

func (c *Client) GetPublicIP(ctx context.Context, id string) (PublicIP, error)

func (*Client) GetVNet

func (c *Client) GetVNet(ctx context.Context, id string) (VNet, error)

func (*Client) GetVNetGateway

func (c *Client) GetVNetGateway(ctx context.Context, id string) (VNetGateway, error)

func (*Client) ListLocalVNetGateways

func (c *Client) ListLocalVNetGateways(ctx context.Context) ([]LocalVNetGateway, error)

func (*Client) ListNetworkGatewayConnections

func (c *Client) ListNetworkGatewayConnections(ctx context.Context) ([]NetworkGatewayConnection, error)

func (*Client) ListVNetGateways

func (c *Client) ListVNetGateways(ctx context.Context) ([]VNetGateway, error)

func (*Client) UpdateVNetGateway

func (c *Client) UpdateVNetGateway(ctx context.Context, gw VNetGateway) error

type LocalVNetGateway

type LocalVNetGateway struct {
	ID         string
	Name       string
	GatewayIP  string
	FQDN       string
	ReadyToUse bool
	// A list of Network Address Prefixes that can be reached
	// through that Gateway.
	//
	// This field should be set if there is no Azure Route
	// Server which would automatically collect all Routes
	// from the underlying network and all peered networks.
	NetworkAddresses []string
	// If set to false it means that the Local VNet Gateway
	// provisioning failed, is being deleted or it is in the update
	// process and it should not be modified at that particular
	// moment.
	ASN              string
	PeerBGPAddresses []BGPAddress
}

Local Network Gateway serves the role of marking a single point of the connection with the other side.

It provides information about IP Address of the public interface from the second side and its BGP Information such as ASN number and BGP IP Address.

type NetworkGatewayConnection

type NetworkGatewayConnection struct {
	ID                    string
	Name                  string
	SharedKey             string
	BGPEnabled            *bool
	NetworkGatewayID      string
	LocalNetworkGatewayID string
	ConnectionType        string
	ConnectionProtocol    string
}

type PublicIP

type PublicIP struct {
	ID      string
	Name    string
	Address string
}

type ResourceGroup

type ResourceGroup struct {
	Location string
}

type VNet

type VNet struct {
	ID              string
	Name            string
	AddressPrefixes []string
}

type VNetGateway

type VNetGateway struct {
	ID   string
	Name string
	ASN  string
	// If set to false it means that the VPN Gateway provisioning
	// failed, vpn Gateway is being deleted or it is in the update
	// process and it should not be modified at that particular
	// moment.
	ReadyToUse bool
	// TODO: Handle Public IPs that may be in use by other
	// CSP Connections. Find out if this is allowed/accepted.
	PublicIPsIDs []string

	Addresses []string

	BGPAddresses []BGPAddress

	VNet string
}