subnetclient

Documentation

Overview

Package subnetclient implements the client for Subnet.

Index

• Constants
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkName string, ...) *retry.Error
  • func (c *Client) Delete(ctx context.Context, resourceGroupName string, virtualNetworkName string, ...) *retry.Error
  • func (c *Client) Get(ctx context.Context, resourceGroupName string, virtualNetworkName string, ...) (network.Subnet, *retry.Error)
  • func (c *Client) List(ctx context.Context, resourceGroupName string, virtualNetworkName string) ([]network.Subnet, *retry.Error)
• type Interface
• type SubnetListResultPage
  • func (page *SubnetListResultPage) Next() error
  • func (page *SubnetListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page SubnetListResultPage) NotDone() bool
  • func (page SubnetListResultPage) Response() network.SubnetListResult
  • func (page SubnetListResultPage) Values() []network.Subnet

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"
	// 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 Subnet client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new Subnet client with ratelimiting.

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, subnetParameters network.Subnet) *retry.Error

CreateOrUpdate creates or updates a Subnet.

func (*Client) Delete

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

Delete deletes a Subnet by name.

func (*Client) Get

func (c *Client) Get(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, expand string) (network.Subnet, *retry.Error)

Get gets a Subnet.

func (*Client) List

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

List gets a list of Subnets in the VNet.

type Interface

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

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

	// CreateOrUpdate creates or updates a Subnet.
	CreateOrUpdate(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string, subnetParameters network.Subnet) *retry.Error

	// Delete deletes a Subnet by name.
	Delete(ctx context.Context, resourceGroupName string, virtualNetworkName string, subnetName string) *retry.Error
}

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

type SubnetListResultPage

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

SubnetListResultPage contains a page of Subnet values.

func (*SubnetListResultPage) Next

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

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

func (page SubnetListResultPage) NotDone() bool

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

func (SubnetListResultPage) Response

func (page SubnetListResultPage) Response() network.SubnetListResult

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

func (SubnetListResultPage) Values

func (page SubnetListResultPage) Values() []network.Subnet

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