vmasclient

Documentation

Overview

Package vmasclient implements the client for VMAS.

Index

• Constants
• type AvailabilitySetListResultPage
  • func (page *AvailabilitySetListResultPage) Next() error
  • func (page *AvailabilitySetListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page AvailabilitySetListResultPage) NotDone() bool
  • func (page AvailabilitySetListResultPage) Response() compute.AvailabilitySetListResult
  • func (page AvailabilitySetListResultPage) Values() []compute.AvailabilitySet
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, vmasName string) (compute.AvailabilitySet, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string) ([]compute.AvailabilitySet, *retry.Error)
• type Interface

Constants

const (
	// APIVersion is the API version for VMAS.
	APIVersion = "2020-12-01"
	// AzureStackCloudAPIVersion is the API version for Azure Stack
	AzureStackCloudAPIVersion = "2019-07-01"
	// AzureStackCloudName is the cloud name of Azure Stack
	AzureStackCloudName = "AZURESTACKCLOUD"
)

Types

type AvailabilitySetListResultPage

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

AvailabilitySetListResultPage contains a page of AvailabilitySet values.

func (*AvailabilitySetListResultPage) Next

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

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

func (page AvailabilitySetListResultPage) NotDone() bool

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

func (AvailabilitySetListResultPage) Response

func (page AvailabilitySetListResultPage) Response() compute.AvailabilitySetListResult

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

func (AvailabilitySetListResultPage) Values

func (page AvailabilitySetListResultPage) Values() []compute.AvailabilitySet

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

type Client

type Client struct {

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

Client implements VMAS client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new VMAS client with ratelimiting.

func (*Client) Get

func (c *Client) Get(ctx context.Context, resourceGroupName string, vmasName string) (compute.AvailabilitySet, *retry.Error)

Get gets a AvailabilitySet.

func (*Client) List

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

List gets a list of AvailabilitySets in the resource group.

type Interface

type Interface interface {
	// Get gets a VirtualMachineScaleSet.
	Get(ctx context.Context, resourceGroupName string, VMScaleSetName string) (result compute.AvailabilitySet, rerr *retry.Error)

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

Interface is the client interface for AvailabilitySet. 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/vmasclient/interface.go -package=mockvmasclient Interface > $GOPATH/src/sigs.k8s.io/cloud-provider-azure/pkg/azureclients/vmasclient/mockvmasclient/interface.go