publicipclient

Documentation

Overview

Package publicipclient implements the client for PublicIPAddress.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, publicIPAddressName string, ...) *retry.Error
  • func (c *Client) Delete(ctx context.Context, resourceGroupName string, publicIPAddressName string) *retry.Error
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, publicIPAddressName string, ...) (network.PublicIPAddress, *retry.Error)
  • func (c *Client) GetVirtualMachineScaleSetPublicIPAddress(ctx context.Context, resourceGroupName string, ...) (network.PublicIPAddress, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string) ([]network.PublicIPAddress, *retry.Error)
  • func (c *Client) ListAll(ctx context.Context) ([]network.PublicIPAddress, *retry.Error)
• type Interface
• type PublicIPAddressListResultPage
  • func (page *PublicIPAddressListResultPage) Next() error
  • func (page *PublicIPAddressListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page PublicIPAddressListResultPage) NotDone() bool
  • func (page PublicIPAddressListResultPage) Response() network.PublicIPAddressListResult
  • func (page PublicIPAddressListResultPage) Values() []network.PublicIPAddress

Constants

const (
	// APIVersion is the API version for network.
	APIVersion = "2020-08-01"
	// AzureStackCloudAPIVersion is the API version for Azure Stack
	AzureStackCloudAPIVersion = "2018-11-01"

	// ComputeAPIVersion is the API version for compute. It is required to get VMSS public IP.
	ComputeAPIVersion = "2017-03-30"
	// AzureStackComputeAPIVersion is the API version for compute for Azure Stack. It is required to get VMSS network interface.
	AzureStackComputeAPIVersion = "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 PublicIPAddress client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new PublicIPAddress client with ratelimiting.

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, publicIPAddressName string, parameters network.PublicIPAddress) *retry.Error

CreateOrUpdate creates or updates a PublicIPAddress.

func (*Client) Delete

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

Delete deletes a PublicIPAddress by name.

func (*Client) Get

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

Get gets a PublicIPAddress.

func (*Client) GetVirtualMachineScaleSetPublicIPAddress

func (c *Client) GetVirtualMachineScaleSetPublicIPAddress(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, IPConfigurationName string, publicIPAddressName string, expand string) (network.PublicIPAddress, *retry.Error)

GetVirtualMachineScaleSetPublicIPAddress gets a PublicIPAddress for VMSS VM.

func (*Client) List

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

List gets a list of PublicIPAddress in the resource group.

func (*Client) ListAll

func (c *Client) ListAll(ctx context.Context) ([]network.PublicIPAddress, *retry.Error)

ListAll gets all of PublicIPAddress in the subscription.

type Interface

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

	// GetVirtualMachineScaleSetPublicIPAddress gets a PublicIPAddress for VMSS VM.
	GetVirtualMachineScaleSetPublicIPAddress(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, IPConfigurationName string, publicIPAddressName string, expand string) (result network.PublicIPAddress, rerr *retry.Error)

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

	// ListAll gets all of PublicIPAddress in the subscription.
	ListAll(ctx context.Context) (result []network.PublicIPAddress, rerr *retry.Error)

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

	// Delete deletes a PublicIPAddress by name.
	Delete(ctx context.Context, resourceGroupName string, publicIPAddressName string) *retry.Error
}

Interface is the client interface for PublicIPAddress. Don't forget to run the following command to generate the mock client: mockgen -source=$GOPATH/src/sigs.k8s.io/cloud-provider-azure/pkg/azureclients/publicipclient/interface.go -package=mockpublicipclient Interface > $GOPATH/src/sigs.k8s.io/cloud-provider-azure/pkg/azureclients/publicipclient/mockpublicipclient/interface.go

type PublicIPAddressListResultPage

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

PublicIPAddressListResultPage contains a page of PublicIPAddress values.

func (*PublicIPAddressListResultPage) Next

func (page *PublicIPAddressListResultPage) 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 (*PublicIPAddressListResultPage) NextWithContext

func (page *PublicIPAddressListResultPage) 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 (PublicIPAddressListResultPage) NotDone

func (page PublicIPAddressListResultPage) NotDone() bool

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

func (PublicIPAddressListResultPage) Response

func (page PublicIPAddressListResultPage) Response() network.PublicIPAddressListResult

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

func (PublicIPAddressListResultPage) Values

func (page PublicIPAddressListResultPage) Values() []network.PublicIPAddress

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