securitygroupclient

Documentation

Overview

Package securitygroupclient implements the client for SecurityGroups.

Index

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

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 SecurityGroup client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new SecurityGroup client with ratelimiting.

func (*Client) CreateOrUpdate

func (c *Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, networkSecurityGroupName string, parameters network.SecurityGroup, etag string) *retry.Error

CreateOrUpdate creates or updates a SecurityGroup.

func (*Client) Delete

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

Delete deletes a SecurityGroup by name.

func (*Client) Get

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

Get gets a SecurityGroup.

func (*Client) List

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

List gets a list of SecurityGroups in the resource group.

type Interface

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

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

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

	// Delete deletes a SecurityGroup by name.
	Delete(ctx context.Context, resourceGroupName string, networkSecurityGroupName string) *retry.Error
}

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

type SecurityGroupListResultPage

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

SecurityGroupListResultPage contains a page of SecurityGroup values.

func (*SecurityGroupListResultPage) Next

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

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

func (page SecurityGroupListResultPage) NotDone() bool

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

func (SecurityGroupListResultPage) Response

func (page SecurityGroupListResultPage) Response() network.SecurityGroupListResult

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

func (SecurityGroupListResultPage) Values

func (page SecurityGroupListResultPage) Values() []network.SecurityGroup

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