storageaccountclient

Documentation

Overview

Package storageaccountclient implements the client for StorageAccounts.

Index

• Constants
• type AccountListResultPage
  • func (page *AccountListResultPage) Next() error
  • func (page *AccountListResultPage) NextWithContext(ctx context.Context) (err error)
  • func (page AccountListResultPage) NotDone() bool
  • func (page AccountListResultPage) Response() storage.AccountListResult
  • func (page AccountListResultPage) Values() []storage.Account
• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, resourceGroupName string, accountName string, ...) *retry.Error
  • func (c *Client) Delete(ctx context.Context, resourceGroupName string, accountName string) *retry.Error
  • func (c *Client) GetProperties(ctx context.Context, resourceGroupName string, accountName string) (storage.Account, *retry.Error)
  • func (c *Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) ([]storage.Account, *retry.Error)
  • func (c *Client) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (storage.AccountListKeysResult, *retry.Error)
  • func (c *Client) ListStorageAccountByResourceGroup(ctx context.Context, resourceGroupName string) ([]storage.Account, *retry.Error)
  • func (c *Client) StorageAccountResultPreparer(ctx context.Context, lr storage.AccountListResult) (*http.Request, error)
• type Interface

Constants

const (
	// APIVersion is the API version for network.
	APIVersion = "2019-06-01"
	// AzureStackCloudAPIVersion is the API version for Azure Stack
	AzureStackCloudAPIVersion = "2018-02-01"
	// AzureStackCloudName is the cloud name of Azure Stack
	AzureStackCloudName = "AZURESTACKCLOUD"
)

Types

type AccountListResultPage

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

AccountListResultPage contains a page of Account values.

func (*AccountListResultPage) Next

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

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

func (page AccountListResultPage) NotDone() bool

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

func (AccountListResultPage) Response

func (page AccountListResultPage) Response() storage.AccountListResult

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

func (AccountListResultPage) Values

func (page AccountListResultPage) Values() []storage.Account

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

type Client

type Client struct {

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

Client implements StorageAccount client Interface.

func New

func New(config *azclients.ClientConfig) *Client

New creates a new StorageAccount client with ratelimiting.

func (*Client) Create

func (c *Client) Create(ctx context.Context, resourceGroupName string, accountName string, parameters storage.AccountCreateParameters) *retry.Error

Create creates a StorageAccount.

func (*Client) Delete

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

Delete deletes a StorageAccount by name.

func (*Client) GetProperties

func (c *Client) GetProperties(ctx context.Context, resourceGroupName string, accountName string) (storage.Account, *retry.Error)

GetProperties gets properties of the StorageAccount.

func (*Client) ListByResourceGroup

func (c *Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) ([]storage.Account, *retry.Error)

ListByResourceGroup get a list storage accounts by resourceGroup.

func (*Client) ListKeys

func (c *Client) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (storage.AccountListKeysResult, *retry.Error)

ListKeys get a list of storage account keys.

func (*Client) ListStorageAccountByResourceGroup

func (c *Client) ListStorageAccountByResourceGroup(ctx context.Context, resourceGroupName string) ([]storage.Account, *retry.Error)

ListStorageAccountByResourceGroup get a list storage accounts by resourceGroup.

func (*Client) StorageAccountResultPreparer

func (c *Client) StorageAccountResultPreparer(ctx context.Context, lr storage.AccountListResult) (*http.Request, error)

StorageAccountResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type Interface

type Interface interface {
	// Create creates a StorageAccount.
	Create(ctx context.Context, resourceGroupName string, accountName string, parameters storage.AccountCreateParameters) *retry.Error

	// Delete deletes a StorageAccount by name.
	Delete(ctx context.Context, resourceGroupName string, accountName string) *retry.Error

	// ListKeys get a list of storage account keys.
	ListKeys(ctx context.Context, resourceGroupName string, accountName string) (storage.AccountListKeysResult, *retry.Error)

	// ListByResourceGroup get a list storage accounts by resourceGroup.
	ListByResourceGroup(ctx context.Context, resourceGroupName string) ([]storage.Account, *retry.Error)

	// GetProperties gets properties of the StorageAccount.
	GetProperties(ctx context.Context, resourceGroupName string, accountName string) (result storage.Account, rerr *retry.Error)
}

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