vmssclient

Documentation

Overview

Package vmssclient implements the client for VMSS.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, ...) *retry.Error
  • func (c *Client) CreateOrUpdateAsync(ctx context.Context, resourceGroupName string, VMScaleSetName string, ...) (*azure.Future, *retry.Error)
  • func (c *Client) DeallocateInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, ...) (*azure.Future, *retry.Error)
  • func (c *Client) DeleteInstances(ctx context.Context, resourceGroupName string, vmScaleSetName string, ...) *retry.Error
  • func (c *Client) DeleteInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, ...) (*azure.Future, *retry.Error)
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string) (compute.VirtualMachineScaleSet, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string) ([]compute.VirtualMachineScaleSet, *retry.Error)
  • func (c *Client) StartInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, ...) (*azure.Future, *retry.Error)
  • func (c *Client) WaitForAsyncOperationResult(ctx context.Context, future *azure.Future) (*http.Response, error)
  • func (c *Client) WaitForCreateOrUpdateResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)
  • func (c *Client) WaitForDeallocateInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)
  • func (c *Client) WaitForDeleteInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)
  • func (c *Client) WaitForStartInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)
• type Interface
• type VirtualMachineScaleSetListResultPage
  • func (page *VirtualMachineScaleSetListResultPage) Next() error
  • func (page *VirtualMachineScaleSetListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page VirtualMachineScaleSetListResultPage) NotDone() bool
  • func (page VirtualMachineScaleSetListResultPage) Response() compute.VirtualMachineScaleSetListResult
  • func (page VirtualMachineScaleSetListResultPage) Values() []compute.VirtualMachineScaleSet

Constants

const (
	// APIVersion is the API version for VMSS.
	APIVersion = "2019-07-01"
)

Types

type Client

type Client struct {

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

Client implements VMSS client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new VMSS client with ratelimiting.

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters compute.VirtualMachineScaleSet) *retry.Error

CreateOrUpdate creates or updates a VirtualMachineScaleSet.

func (*Client) CreateOrUpdateAsync

func (c *Client) CreateOrUpdateAsync(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters compute.VirtualMachineScaleSet) (*azure.Future, *retry.Error)

CreateOrUpdateAsync sends the request to arm client and DO NOT wait for the response

func (*Client) DeallocateInstancesAsync

func (c *Client) DeallocateInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) (*azure.Future, *retry.Error)

DeallocateInstancesAsync sends the deallocate request to ARM client and DOEST NOT wait on the future

func (*Client) DeleteInstances

func (c *Client) DeleteInstances(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) *retry.Error

DeleteInstances deletes the instances for a VirtualMachineScaleSet.

func (*Client) DeleteInstancesAsync

func (c *Client) DeleteInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) (*azure.Future, *retry.Error)

DeleteInstancesAsync sends the delete request to ARM client and DOEST NOT wait on the future

func (*Client) Get

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

Get gets a VirtualMachineScaleSet.

func (*Client) List

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

List gets a list of VirtualMachineScaleSets in the resource group.

func (*Client) StartInstancesAsync

func (c *Client) StartInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) (*azure.Future, *retry.Error)

StartInstancesAsync sends the start request to ARM client and DOEST NOT wait on the future

func (*Client) WaitForAsyncOperationResult

func (c *Client) WaitForAsyncOperationResult(ctx context.Context, future *azure.Future) (*http.Response, error)

WaitForAsyncOperationResult waits for the response of the request

func (*Client) WaitForCreateOrUpdateResult

func (c *Client) WaitForCreateOrUpdateResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)

WaitForCreateOrUpdateResult waits for the response of the create or update request

func (*Client) WaitForDeallocateInstancesResult

func (c *Client) WaitForDeallocateInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)

WaitForDeallocateInstancesResult waits for the response of the delete instance request

func (*Client) WaitForDeleteInstancesResult

func (c *Client) WaitForDeleteInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)

WaitForDeleteInstancesResult waits for the response of the delete instance request

func (*Client) WaitForStartInstancesResult

func (c *Client) WaitForStartInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)

WaitForStartInstancesResult waits for the response of the delete instance request

type Interface

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

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

	// CreateOrUpdate creates or updates a VirtualMachineScaleSet.
	CreateOrUpdate(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters compute.VirtualMachineScaleSet) *retry.Error

	// CreateOrUpdateSync sends the request to arm client and DO NOT wait for the response
	CreateOrUpdateAsync(ctx context.Context, resourceGroupName string, VMScaleSetName string, parameters compute.VirtualMachineScaleSet) (*azure.Future, *retry.Error)

	// WaitForAsyncOperationResult waits for the response of the request
	WaitForAsyncOperationResult(ctx context.Context, future *azure.Future) (*http.Response, error)

	// DeleteInstances deletes the instances for a VirtualMachineScaleSet.
	DeleteInstances(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) *retry.Error

	// DeleteInstancesAsync sends the delete request to the ARM client and DOEST NOT wait on the future
	DeleteInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) (*azure.Future, *retry.Error)

	// WaitForCreateOrUpdateResult waits for the response of the create or update request
	WaitForCreateOrUpdateResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)

	// WaitForDeleteInstancesResult waits for the response of the delete instances request
	WaitForDeleteInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)

	// DeallocateInstances sends the deallocate request to the ARM client and DOEST NOT wait on the future
	DeallocateInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) (*azure.Future, *retry.Error)

	// WaitForDeallocateInstancesResult waits for the response of the deallocate instances request
	WaitForDeallocateInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)

	// StartInstancesAsync starts the instances for a VirtualMachineScaleSet.
	StartInstancesAsync(ctx context.Context, resourceGroupName string, vmScaleSetName string, vmInstanceIDs compute.VirtualMachineScaleSetVMInstanceRequiredIDs) (*azure.Future, *retry.Error)

	// WaitForStartInstancesResult waits for the response of the start instances request
	WaitForStartInstancesResult(ctx context.Context, future *azure.Future, resourceGroupName string) (*http.Response, error)
}

Interface is the client interface for VirtualMachineScaleSet. Don't forget to run the following command to generate the mock client: mockgen -source=$GOPATH/src/k8s.io/kubernetes/staging/src/k8s.io/legacy-cloud-providers/azure/clients/vmssclient/interface.go -package=mockvmssclient Interface > $GOPATH/src/k8s.io/kubernetes/staging/src/k8s.io/legacy-cloud-providers/azure/clients/vmssclient/mockvmssclient/interface.go

type VirtualMachineScaleSetListResultPage

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

VirtualMachineScaleSetListResultPage contains a page of VirtualMachineScaleSet values.

func (*VirtualMachineScaleSetListResultPage) Next

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

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

func (page VirtualMachineScaleSetListResultPage) NotDone() bool

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

func (VirtualMachineScaleSetListResultPage) Response

func (page VirtualMachineScaleSetListResultPage) Response() compute.VirtualMachineScaleSetListResult

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

func (VirtualMachineScaleSetListResultPage) Values

func (page VirtualMachineScaleSetListResultPage) Values() []compute.VirtualMachineScaleSet

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