fileclient

Documentation

Overview

Package fileclient implements the client for azure file.

Index

• type Client
  • func (c *Client) CreateFileShare(resourceGroupName, accountName string, shareOptions *ShareOptions) error
  • func (c *Client) DeleteFileShare(resourceGroupName, accountName, name string) error
  • func (c *Client) GetFileShare(resourceGroupName, accountName, name string) (storage.FileShare, error)
  • func (c *Client) GetServiceProperties(resourceGroupName, accountName string) (storage.FileServiceProperties, error)
  • func (c *Client) ResizeFileShare(resourceGroupName, accountName, name string, sizeGiB int) error
  • func (c *Client) SetServiceProperties(resourceGroupName, accountName string, ...) (storage.FileServiceProperties, error)
  • func (c *Client) WithSubscriptionID(subscriptionID string) Interface
• type Interface
  • func New(config *azclients.ClientConfig) Interface
• type ShareOptions

Types

type Client

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

Client implements the azure file client interface

func (*Client) CreateFileShare

func (c *Client) CreateFileShare(resourceGroupName, accountName string, shareOptions *ShareOptions) error

CreateFileShare creates a file share

func (*Client) DeleteFileShare

func (c *Client) DeleteFileShare(resourceGroupName, accountName, name string) error

DeleteFileShare deletes a file share

func (*Client) GetFileShare

func (c *Client) GetFileShare(resourceGroupName, accountName, name string) (storage.FileShare, error)

GetFileShare gets a file share

func (*Client) GetServiceProperties

func (c *Client) GetServiceProperties(resourceGroupName, accountName string) (storage.FileServiceProperties, error)

GetServiceProperties get service properties

func (*Client) ResizeFileShare

func (c *Client) ResizeFileShare(resourceGroupName, accountName, name string, sizeGiB int) error

ResizeFileShare resizes a file share

func (*Client) SetServiceProperties

func (c *Client) SetServiceProperties(resourceGroupName, accountName string, parameters storage.FileServiceProperties) (storage.FileServiceProperties, error)

SetServiceProperties set service properties

func (*Client) WithSubscriptionID

func (c *Client) WithSubscriptionID(subscriptionID string) Interface

type Interface

type Interface interface {
	CreateFileShare(resourceGroupName, accountName string, shareOptions *ShareOptions) error
	DeleteFileShare(resourceGroupName, accountName, name string) error
	ResizeFileShare(resourceGroupName, accountName, name string, sizeGiB int) error
	GetFileShare(resourceGroupName, accountName, name string) (storage.FileShare, error)
	GetServiceProperties(resourceGroupName, accountName string) (storage.FileServiceProperties, error)
	SetServiceProperties(resourceGroupName, accountName string, parameters storage.FileServiceProperties) (storage.FileServiceProperties, error)
	WithSubscriptionID(subscriptionID string) Interface
}

Interface is the client interface for creating file shares, interface for test injection. Don't forget to run "hack/update-mock-clients.sh" command to generate the mock client.

func New

func New(config *azclients.ClientConfig) Interface

New creates a azure file client

type ShareOptions

type ShareOptions struct {
	Name       string
	Protocol   storage.EnabledProtocols
	RequestGiB int
	// supported values: ""(by default), "TransactionOptimized", "Cool", "Hot", "Premium"
	AccessTier string
	// supported values: ""(by default), "AllSquash", "NoRootSquash", "RootSquash"
	RootSquash string
	// Metadata - A name-value pair to associate with the share as metadata.
	Metadata map[string]*string
}

ShareOptions contains the fields which are used to create file share.