publicips

Documentation

Index

• type AzureClient
  • func NewClient(auth azure.Authorizer, apiCallTimeout time.Duration) (*AzureClient, error)
  • func (ac *AzureClient) CreateOrUpdateAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string, ...) (result interface{}, ...)
  • func (ac *AzureClient) DeleteAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string) (poller *runtime.Poller[armnetwork.PublicIPAddressesClientDeleteResponse], ...)
  • func (ac *AzureClient) Get(ctx context.Context, spec azure.ResourceSpecGetter) (result interface{}, err error)
• type PublicIPScope
• type PublicIPSpec
  • func (s *PublicIPSpec) OwnerResourceName() string
  • func (s *PublicIPSpec) Parameters(ctx context.Context, existing interface{}) (params interface{}, err error)
  • func (s *PublicIPSpec) ResourceGroupName() string
  • func (s *PublicIPSpec) ResourceName() string
• type Service
  • func New(scope PublicIPScope) (*Service, error)
  • func (s *Service) Delete(ctx context.Context) error
  • func (s *Service) IsManaged(ctx context.Context) (bool, error)
  • func (s *Service) Name() string
  • func (s *Service) Reconcile(ctx context.Context) error

Types

type AzureClient

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

AzureClient contains the Azure go-sdk Client.

func NewClient

func NewClient(auth azure.Authorizer, apiCallTimeout time.Duration) (*AzureClient, error)

NewClient creates a new public IP client from an authorizer.

func (*AzureClient) CreateOrUpdateAsync

func (ac *AzureClient) CreateOrUpdateAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string, parameters interface{}) (result interface{}, poller *runtime.Poller[armnetwork.PublicIPAddressesClientCreateOrUpdateResponse], err error)

CreateOrUpdateAsync creates or updates a static or dynamic public IP address. It sends a PUT request to Azure and if accepted without error, the func will return a Poller which can be used to track the ongoing progress of the operation.

func (*AzureClient) DeleteAsync

func (ac *AzureClient) DeleteAsync(ctx context.Context, spec azure.ResourceSpecGetter, resumeToken string) (poller *runtime.Poller[armnetwork.PublicIPAddressesClientDeleteResponse], err error)

DeleteAsync deletes the specified public IP address asynchronously. DeleteAsync sends a DELETE request to Azure and if accepted without error, the func will return a Poller which can be used to track the ongoing progress of the operation.

func (*AzureClient) Get

func (ac *AzureClient) Get(ctx context.Context, spec azure.ResourceSpecGetter) (result interface{}, err error)

Get gets the specified public IP address in a specified resource group.

type PublicIPScope

type PublicIPScope interface {
	azure.Authorizer
	azure.AsyncStatusUpdater
	azure.ClusterDescriber
	PublicIPSpecs() []azure.ResourceSpecGetter
}

PublicIPScope defines the scope interface for a public IP service.

type PublicIPSpec

type PublicIPSpec struct {
	Name             string
	ResourceGroup    string
	ClusterName      string
	DNSName          string
	IsIPv6           bool
	Location         string
	ExtendedLocation *infrav1.ExtendedLocationSpec
	FailureDomains   []*string
	AdditionalTags   infrav1.Tags
	IPTags           []infrav1.IPTag
}

PublicIPSpec defines the specification for a Public IP.

func (*PublicIPSpec) OwnerResourceName

func (s *PublicIPSpec) OwnerResourceName() string

OwnerResourceName is a no-op for public IPs.

func (*PublicIPSpec) Parameters

func (s *PublicIPSpec) Parameters(ctx context.Context, existing interface{}) (params interface{}, err error)

Parameters returns the parameters for the public IP.

func (*PublicIPSpec) ResourceGroupName

func (s *PublicIPSpec) ResourceGroupName() string

ResourceGroupName returns the name of the resource group.

func (*PublicIPSpec) ResourceName

func (s *PublicIPSpec) ResourceName() string

ResourceName returns the name of the public IP.

type Service

type Service struct {
	Scope PublicIPScope
	async.Reconciler
	async.Getter
	async.TagsGetter
}

Service provides operations on Azure resources.

func New

func New(scope PublicIPScope) (*Service, error)

New creates a new service.

func (*Service) Delete

func (s *Service) Delete(ctx context.Context) error

Delete deletes the public IP with the provided scope.

func (*Service) IsManaged

func (s *Service) IsManaged(ctx context.Context) (bool, error)

IsManaged returns always returns true as public IPs are managed on a one-by-one basis.

func (*Service) Name

func (s *Service) Name() string

Name returns the service name.

func (*Service) Reconcile

func (s *Service) Reconcile(ctx context.Context) error

Reconcile idempotently creates or updates a public IP.