loadbalancerclient

Documentation

Overview

Package loadbalancerclient implements the client for LoadBalancer.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, loadBalancerName string, ...) *retry.Error
  • func (c *Client) CreateOrUpdateBackendPools(ctx context.Context, resourceGroupName string, loadBalancerName string, ...) *retry.Error
  • func (c *Client) Delete(ctx context.Context, resourceGroupName string, loadBalancerName string) *retry.Error
  • func (c *Client) DeleteLBBackendPool(ctx context.Context, ...) *retry.Error
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, ...) (network.LoadBalancer, *retry.Error)
  • func (c *Client) GetLBBackendPool(ctx context.Context, resourceGroupName string, loadBalancerName string, ...) (network.BackendAddressPool, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string) ([]network.LoadBalancer, *retry.Error)
  • func (c *Client) MigrateToIPBasedBackendPool(ctx context.Context, resourceGroupName string, loadBalancerName string, ...) *retry.Error
• type Interface
• type LoadBalancerListResultPage
  • func (page *LoadBalancerListResultPage) Next() error
  • func (page *LoadBalancerListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page LoadBalancerListResultPage) NotDone() bool
  • func (page LoadBalancerListResultPage) Response() network.LoadBalancerListResult
  • func (page LoadBalancerListResultPage) Values() []network.LoadBalancer

Constants

const (
	// APIVersion is the API version for network.
	APIVersion = "2022-07-01"
	// AzureStackCloudAPIVersion is the API version for Azure Stack
	AzureStackCloudAPIVersion = "2018-11-01"
	// AzureStackCloudName is the cloud name of Azure Stack
	AzureStackCloudName = "AZURESTACKCLOUD"
)

Types

type Client

type Client struct {

	// ARM throttling configures.
	RetryAfterReader time.Time
	RetryAfterWriter time.Time
	// contains filtered or unexported fields
}

Client implements LoadBalancer client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new LoadBalancer client with ratelimiting.

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, loadBalancerName string, parameters network.LoadBalancer, etag string) *retry.Error

CreateOrUpdate creates or updates a LoadBalancer.

func (*Client) CreateOrUpdateBackendPools

func (c *Client) CreateOrUpdateBackendPools(ctx context.Context, resourceGroupName string, loadBalancerName string, backendPoolName string, parameters network.BackendAddressPool, etag string) *retry.Error

CreateOrUpdateBackendPools creates or updates a LoadBalancer backend pool.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, resourceGroupName string, loadBalancerName string) *retry.Error

Delete deletes a LoadBalancer by name.

func (*Client) DeleteLBBackendPool

func (c *Client) DeleteLBBackendPool(ctx context.Context, resourceGroupName, loadBalancerName, backendPoolName string) *retry.Error

DeleteLBBackendPool deletes a LoadBalancer backend pool by name.

func (*Client) Get

func (c *Client) Get(ctx context.Context, resourceGroupName string, loadBalancerName string, expand string) (network.LoadBalancer, *retry.Error)

Get gets a LoadBalancer.

func (*Client) GetLBBackendPool

func (c *Client) GetLBBackendPool(ctx context.Context, resourceGroupName string, loadBalancerName string, backendPoolName string, expand string) (network.BackendAddressPool, *retry.Error)

GetLBBackendPool gets a LoadBalancer backend pool.

func (*Client) List

func (c *Client) List(ctx context.Context, resourceGroupName string) ([]network.LoadBalancer, *retry.Error)

List gets a list of LoadBalancer in the resource group.

func (*Client) MigrateToIPBasedBackendPool

func (c *Client) MigrateToIPBasedBackendPool(ctx context.Context, resourceGroupName string, loadBalancerName string, backendPoolNames []string) *retry.Error

MigrateToIPBasedBackendPool migrates a NIC-based backend pool to IP-based.

type Interface

type Interface interface {
	// Get gets a LoadBalancer.
	Get(ctx context.Context, resourceGroupName string, loadBalancerName string, expand string) (result network.LoadBalancer, rerr *retry.Error)

	// List gets a list of LoadBalancer in the resource group.
	List(ctx context.Context, resourceGroupName string) (result []network.LoadBalancer, rerr *retry.Error)

	// CreateOrUpdate creates or updates a LoadBalancer.
	CreateOrUpdate(ctx context.Context, resourceGroupName string, loadBalancerName string, parameters network.LoadBalancer, etag string) *retry.Error

	// CreateOrUpdateBackendPools creates or updates loadbalancer's backend address pool.
	CreateOrUpdateBackendPools(ctx context.Context, resourceGroupName string, loadBalancerName string, backendPoolName string, parameters network.BackendAddressPool, etag string) *retry.Error

	// Delete deletes a LoadBalancer by name.
	Delete(ctx context.Context, resourceGroupName string, loadBalancerName string) *retry.Error

	// GetLBBackendPool gets a LoadBalancer backend pool.
	GetLBBackendPool(ctx context.Context, resourceGroupName string, loadBalancerName string, backendPoolName string, expand string) (network.BackendAddressPool, *retry.Error)

	// DeleteLBBackendPool deletes a LoadBalancer backend pool by name.
	DeleteLBBackendPool(ctx context.Context, resourceGroupName, loadBalancerName, backendPoolName string) *retry.Error

	// MigrateToIPBasedBackendPool migrates a NIC-based backend pool to IP-based.
	MigrateToIPBasedBackendPool(ctx context.Context, resourceGroupName string, loadBalancerName string, backendPoolNames []string) *retry.Error
}

Interface is the client interface for LoadBalancer. Don't forget to run "hack/update-mock-clients.sh" command to generate the mock client.

type LoadBalancerListResultPage

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

LoadBalancerListResultPage contains a page of LoadBalancer values.

func (*LoadBalancerListResultPage) Next

func (page *LoadBalancerListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*LoadBalancerListResultPage) NextWithContext

func (page *LoadBalancerListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (LoadBalancerListResultPage) NotDone

func (page LoadBalancerListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (LoadBalancerListResultPage) Response

func (page LoadBalancerListResultPage) Response() network.LoadBalancerListResult

Response returns the raw server response from the last page request.

func (LoadBalancerListResultPage) Values

func (page LoadBalancerListResultPage) Values() []network.LoadBalancer

Values returns the slice of values for the current page or nil if there are no values.