interfaceclient

Documentation

Overview

Package interfaceclient implements the client for network interfaces.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkInterfaceName string, ...) *retry.Error
  • func (c *Client) Delete(ctx context.Context, resourceGroupName string, networkInterfaceName string) *retry.Error
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, networkInterfaceName string, ...) (network.Interface, *retry.Error)
  • func (c *Client) GetVirtualMachineScaleSetNetworkInterface(ctx context.Context, resourceGroupName string, ...) (network.Interface, *retry.Error)
• type Interface

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 network interface.
	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 network interface client.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new network interface client with ratelimiting.

func (*Client) CreateOrUpdate

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

CreateOrUpdate creates or updates a network.Interface.

func (*Client) Delete

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

Delete deletes a network interface by name.

func (*Client) Get

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

Get gets a network.Interface.

func (*Client) GetVirtualMachineScaleSetNetworkInterface

func (c *Client) GetVirtualMachineScaleSetNetworkInterface(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, expand string) (network.Interface, *retry.Error)

GetVirtualMachineScaleSetNetworkInterface gets a network.Interface of VMSS VM.

type Interface

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

	// GetVirtualMachineScaleSetNetworkInterface gets a network.Interface of VMSS VM.
	GetVirtualMachineScaleSetNetworkInterface(ctx context.Context, resourceGroupName string, virtualMachineScaleSetName string, virtualmachineIndex string, networkInterfaceName string, expand string) (result network.Interface, rerr *retry.Error)

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

	// Delete deletes a network interface by name.
	Delete(ctx context.Context, resourceGroupName string, networkInterfaceName string) *retry.Error
}

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