vmssvmclient

Documentation

Overview

Package vmssvmclient implements the client for VirtualMachineScaleSetVM.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, ...) (compute.VirtualMachineScaleSetVM, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string, ...) ([]compute.VirtualMachineScaleSetVM, *retry.Error)
  • func (c *Client) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, ...) (*compute.VirtualMachineScaleSetVM, *retry.Error)
  • func (c *Client) UpdateAsync(ctx context.Context, resourceGroupName string, VMScaleSetName string, ...) (*azure.Future, *retry.Error)
  • func (c *Client) UpdateVMs(ctx context.Context, resourceGroupName string, VMScaleSetName string, ...) *retry.Error
  • func (c *Client) WaitForUpdateResult(ctx context.Context, future *azure.Future, resourceGroupName, source string) (*compute.VirtualMachineScaleSetVM, *retry.Error)
• type Interface
• type VirtualMachineScaleSetVMListResultPage
  • func (page *VirtualMachineScaleSetVMListResultPage) Next() error
  • func (page *VirtualMachineScaleSetVMListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page VirtualMachineScaleSetVMListResultPage) NotDone() bool
  • func (page VirtualMachineScaleSetVMListResultPage) Response() compute.VirtualMachineScaleSetVMListResult
  • func (page VirtualMachineScaleSetVMListResultPage) Values() []compute.VirtualMachineScaleSetVM

Constants

const (
	// APIVersion is the API version for VMSS.
	APIVersion = "2022-03-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 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 vmssVM client with ratelimiting.

func (*Client) Get

func (c *Client) Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand compute.InstanceViewTypes) (compute.VirtualMachineScaleSetVM, *retry.Error)

Get gets a VirtualMachineScaleSetVM.

func (*Client) List

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

List gets a list of VirtualMachineScaleSetVMs in the virtualMachineScaleSet.

func (*Client) Update

func (c *Client) Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters compute.VirtualMachineScaleSetVM, source string) (*compute.VirtualMachineScaleSetVM, *retry.Error)

Update updates a VirtualMachineScaleSetVM.

func (*Client) UpdateAsync

func (c *Client) UpdateAsync(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters compute.VirtualMachineScaleSetVM, source string) (*azure.Future, *retry.Error)

UpdateAsync updates a VirtualMachineScaleSetVM asynchronously

func (*Client) UpdateVMs

func (c *Client) UpdateVMs(ctx context.Context, resourceGroupName string, VMScaleSetName string, instances map[string]compute.VirtualMachineScaleSetVM, source string, batchSize int) *retry.Error

UpdateVMs updates a list of VirtualMachineScaleSetVM from map[instanceID]compute.VirtualMachineScaleSetVM. If the batch size > 0, it will send sync requests concurrently in batches, or it will send sync requests in sequence. No matter what the batch size is, it will process the async requests concurrently in one single batch.

func (*Client) WaitForUpdateResult

func (c *Client) WaitForUpdateResult(ctx context.Context, future *azure.Future, resourceGroupName, source string) (*compute.VirtualMachineScaleSetVM, *retry.Error)

WaitForUpdateResult waits for the response of the update request

type Interface

type Interface interface {
	// Get gets a VirtualMachineScaleSetVM.
	Get(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, expand compute.InstanceViewTypes) (compute.VirtualMachineScaleSetVM, *retry.Error)

	// List gets a list of VirtualMachineScaleSetVMs in the virtualMachineScaleSet.
	List(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, expand string) ([]compute.VirtualMachineScaleSetVM, *retry.Error)

	// Update updates a VirtualMachineScaleSetVM.
	Update(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters compute.VirtualMachineScaleSetVM, source string) (*compute.VirtualMachineScaleSetVM, *retry.Error)

	// UpdateAsync updates a VirtualMachineScaleSetVM asynchronously
	UpdateAsync(ctx context.Context, resourceGroupName string, VMScaleSetName string, instanceID string, parameters compute.VirtualMachineScaleSetVM, source string) (*azure.Future, *retry.Error)

	// WaitForUpdateResult waits for the response of the update request
	WaitForUpdateResult(ctx context.Context, future *azure.Future, resourceGroupName, source string) (*compute.VirtualMachineScaleSetVM, *retry.Error)

	// UpdateVMs updates a list of VirtualMachineScaleSetVM from map[instanceID]compute.VirtualMachineScaleSetVM.
	UpdateVMs(ctx context.Context, resourceGroupName string, VMScaleSetName string, instances map[string]compute.VirtualMachineScaleSetVM, source string, batchSize int) *retry.Error
}

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

type VirtualMachineScaleSetVMListResultPage

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

VirtualMachineScaleSetVMListResultPage contains a page of VirtualMachineScaleSetVM values.

func (*VirtualMachineScaleSetVMListResultPage) Next

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

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

func (page VirtualMachineScaleSetVMListResultPage) NotDone() bool

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

func (VirtualMachineScaleSetVMListResultPage) Response

func (page VirtualMachineScaleSetVMListResultPage) Response() compute.VirtualMachineScaleSetVMListResult

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

func (VirtualMachineScaleSetVMListResultPage) Values

func (page VirtualMachineScaleSetVMListResultPage) Values() []compute.VirtualMachineScaleSetVM

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