storagecache

package
v59.0.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package storagecache implements the Azure ARM Storagecache service API version 2019-11-01.

A Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as "Storage Targets"). These operations allow you to manage Caches.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Storagecache
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type APIOperation

type APIOperation struct {
	// Display - The object that represents the operation.
	Display *APIOperationDisplay `json:"display,omitempty"`
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
}

APIOperation REST API operation description: see https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3023-operationsapiimplementation

type APIOperationDisplay

type APIOperationDisplay struct {
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
	// Provider - Service provider: Microsoft.StorageCache
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed: Cache, etc.
	Resource *string `json:"resource,omitempty"`
}

APIOperationDisplay the object that represents the operation.

type APIOperationListResult

type APIOperationListResult struct {
	autorest.Response `json:"-"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - List of Resource Provider operations supported by the Microsoft.StorageCache resource provider.
	Value *[]APIOperation `json:"value,omitempty"`
}

APIOperationListResult result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.

func (APIOperationListResult) IsEmpty

func (aolr APIOperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type APIOperationListResultIterator

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

APIOperationListResultIterator provides access to a complete listing of APIOperation values.

func NewAPIOperationListResultIterator

func NewAPIOperationListResultIterator(page APIOperationListResultPage) APIOperationListResultIterator

Creates a new instance of the APIOperationListResultIterator type.

func (*APIOperationListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*APIOperationListResultIterator) NextWithContext

func (iter *APIOperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (APIOperationListResultIterator) NotDone

func (iter APIOperationListResultIterator) NotDone() bool

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

func (APIOperationListResultIterator) Response

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

func (APIOperationListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type APIOperationListResultPage

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

APIOperationListResultPage contains a page of APIOperation values.

func NewAPIOperationListResultPage

Creates a new instance of the APIOperationListResultPage type.

func (*APIOperationListResultPage) Next

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

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

func (page APIOperationListResultPage) NotDone() bool

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

func (APIOperationListResultPage) Response

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

func (APIOperationListResultPage) Values

func (page APIOperationListResultPage) Values() []APIOperation

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

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Storagecache.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Cache

type Cache struct {
	autorest.Response `json:"-"`
	// Tags - ARM tags as name/value pairs.
	Tags interface{} `json:"tags,omitempty"`
	// ID - READ-ONLY; Resource ID of the Cache.
	ID *string `json:"id,omitempty"`
	// Location - Region name string.
	Location *string `json:"location,omitempty"`
	// Name - READ-ONLY; Name of Cache.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Type of the Cache; Microsoft.StorageCache/Cache
	Type *string `json:"type,omitempty"`
	// CacheProperties - Properties of the Cache.
	*CacheProperties `json:"properties,omitempty"`
	// Sku - SKU for the Cache.
	Sku *CacheSku `json:"sku,omitempty"`
}

Cache a Cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

func (Cache) MarshalJSON

func (c Cache) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Cache.

func (*Cache) UnmarshalJSON

func (c *Cache) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Cache struct.

type CacheHealth

type CacheHealth struct {
	// State - List of Cache health states. Possible values include: 'Unknown', 'Healthy', 'Degraded', 'Down', 'Transitioning', 'Stopping', 'Stopped', 'Upgrading', 'Flushing'
	State HealthStateType `json:"state,omitempty"`
	// StatusDescription - Describes explanation of state.
	StatusDescription *string `json:"statusDescription,omitempty"`
}

CacheHealth an indication of Cache health. Gives more information about health than just that related to provisioning.

type CacheProperties

type CacheProperties struct {
	// CacheSizeGB - The size of this Cache, in GB.
	CacheSizeGB *int32 `json:"cacheSizeGB,omitempty"`
	// Health - READ-ONLY; Health of the Cache.
	Health *CacheHealth `json:"health,omitempty"`
	// MountAddresses - READ-ONLY; Array of IP addresses that can be used by clients mounting this Cache.
	MountAddresses *[]string `json:"mountAddresses,omitempty"`
	// ProvisioningState - ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property. Possible values include: 'Succeeded', 'Failed', 'Cancelled', 'Creating', 'Deleting', 'Updating'
	ProvisioningState ProvisioningStateType `json:"provisioningState,omitempty"`
	// Subnet - Subnet used for the Cache.
	Subnet *string `json:"subnet,omitempty"`
	// UpgradeStatus - Upgrade status of the Cache.
	UpgradeStatus *CacheUpgradeStatus `json:"upgradeStatus,omitempty"`
}

CacheProperties properties of the Cache.

func (CacheProperties) MarshalJSON

func (c CacheProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheProperties.

type CacheSku

type CacheSku struct {
	// Name - SKU name for this Cache.
	Name *string `json:"name,omitempty"`
}

CacheSku SKU for the Cache.

type CacheUpgradeStatus

type CacheUpgradeStatus struct {
	// CurrentFirmwareVersion - READ-ONLY; Version string of the firmware currently installed on this Cache.
	CurrentFirmwareVersion *string `json:"currentFirmwareVersion,omitempty"`
	// FirmwareUpdateStatus - READ-ONLY; True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. Possible values include: 'Available', 'Unavailable'
	FirmwareUpdateStatus FirmwareStatusType `json:"firmwareUpdateStatus,omitempty"`
	// FirmwareUpdateDeadline - READ-ONLY; Time at which the pending firmware update will automatically be installed on the Cache.
	FirmwareUpdateDeadline *date.Time `json:"firmwareUpdateDeadline,omitempty"`
	// LastFirmwareUpdate - READ-ONLY; Time of the last successful firmware update.
	LastFirmwareUpdate *date.Time `json:"lastFirmwareUpdate,omitempty"`
	// PendingFirmwareVersion - READ-ONLY; When firmwareUpdateAvailable is true, this field holds the version string for the update.
	PendingFirmwareVersion *string `json:"pendingFirmwareVersion,omitempty"`
}

CacheUpgradeStatus properties describing the software upgrade state of the Cache.

func (CacheUpgradeStatus) MarshalJSON

func (cus CacheUpgradeStatus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheUpgradeStatus.

type CachesClient

type CachesClient struct {
	BaseClient
}

CachesClient is the a Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as "Storage Targets"). These operations allow you to manage Caches.

func NewCachesClient

func NewCachesClient(subscriptionID string) CachesClient

NewCachesClient creates an instance of the CachesClient client.

func NewCachesClientWithBaseURI

func NewCachesClientWithBaseURI(baseURI string, subscriptionID string) CachesClient

NewCachesClientWithBaseURI creates an instance of the CachesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (CachesClient) CreateOrUpdate

func (client CachesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, cacheName string, cache *Cache) (result CachesCreateOrUpdateFuture, err error)

CreateOrUpdate create or update a Cache. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. cache - object containing the user-selectable properties of the new Cache. If read-only properties are included, they must match the existing values of those properties.

func (CachesClient) CreateOrUpdatePreparer

func (client CachesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, cacheName string, cache *Cache) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (CachesClient) CreateOrUpdateResponder

func (client CachesClient) CreateOrUpdateResponder(resp *http.Response) (result Cache, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (CachesClient) CreateOrUpdateSender

func (client CachesClient) CreateOrUpdateSender(req *http.Request) (future CachesCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (CachesClient) Delete

func (client CachesClient) Delete(ctx context.Context, resourceGroupName string, cacheName string) (result CachesDeleteFuture, err error)

Delete schedules a Cache for deletion. Parameters: resourceGroupName - target resource group. cacheName - name of Cache.

func (CachesClient) DeletePreparer

func (client CachesClient) DeletePreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CachesClient) DeleteResponder

func (client CachesClient) DeleteResponder(resp *http.Response) (result SetObject, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (CachesClient) DeleteSender

func (client CachesClient) DeleteSender(req *http.Request) (future CachesDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (CachesClient) Flush

func (client CachesClient) Flush(ctx context.Context, resourceGroupName string, cacheName string) (result CachesFlushFuture, err error)

Flush tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete. Parameters: resourceGroupName - target resource group. cacheName - name of Cache.

func (CachesClient) FlushPreparer

func (client CachesClient) FlushPreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)

FlushPreparer prepares the Flush request.

func (CachesClient) FlushResponder

func (client CachesClient) FlushResponder(resp *http.Response) (result SetObject, err error)

FlushResponder handles the response to the Flush request. The method always closes the http.Response Body.

func (CachesClient) FlushSender

func (client CachesClient) FlushSender(req *http.Request) (future CachesFlushFuture, err error)

FlushSender sends the Flush request. The method will close the http.Response Body if it receives an error.

func (CachesClient) Get

func (client CachesClient) Get(ctx context.Context, resourceGroupName string, cacheName string) (result Cache, err error)

Get returns a Cache. Parameters: resourceGroupName - target resource group. cacheName - name of Cache.

func (CachesClient) GetPreparer

func (client CachesClient) GetPreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CachesClient) GetResponder

func (client CachesClient) GetResponder(resp *http.Response) (result Cache, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (CachesClient) GetSender

func (client CachesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (CachesClient) List

func (client CachesClient) List(ctx context.Context) (result CachesListResultPage, err error)

List returns all Caches the user has access to under a subscription.

func (CachesClient) ListByResourceGroup

func (client CachesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result CachesListResultPage, err error)

ListByResourceGroup returns all Caches the user has access to under a resource group. Parameters: resourceGroupName - target resource group.

func (CachesClient) ListByResourceGroupComplete

func (client CachesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result CachesListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (CachesClient) ListByResourceGroupPreparer

func (client CachesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (CachesClient) ListByResourceGroupResponder

func (client CachesClient) ListByResourceGroupResponder(resp *http.Response) (result CachesListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (CachesClient) ListByResourceGroupSender

func (client CachesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (CachesClient) ListComplete

func (client CachesClient) ListComplete(ctx context.Context) (result CachesListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (CachesClient) ListPreparer

func (client CachesClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (CachesClient) ListResponder

func (client CachesClient) ListResponder(resp *http.Response) (result CachesListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (CachesClient) ListSender

func (client CachesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (CachesClient) Start

func (client CachesClient) Start(ctx context.Context, resourceGroupName string, cacheName string) (result CachesStartFuture, err error)

Start tells a Stopped state Cache to transition to Active state. Parameters: resourceGroupName - target resource group. cacheName - name of Cache.

func (CachesClient) StartPreparer

func (client CachesClient) StartPreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)

StartPreparer prepares the Start request.

func (CachesClient) StartResponder

func (client CachesClient) StartResponder(resp *http.Response) (result SetObject, err error)

StartResponder handles the response to the Start request. The method always closes the http.Response Body.

func (CachesClient) StartSender

func (client CachesClient) StartSender(req *http.Request) (future CachesStartFuture, err error)

StartSender sends the Start request. The method will close the http.Response Body if it receives an error.

func (CachesClient) Stop

func (client CachesClient) Stop(ctx context.Context, resourceGroupName string, cacheName string) (result CachesStopFuture, err error)

Stop tells an Active Cache to transition to Stopped state. Parameters: resourceGroupName - target resource group. cacheName - name of Cache.

func (CachesClient) StopPreparer

func (client CachesClient) StopPreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)

StopPreparer prepares the Stop request.

func (CachesClient) StopResponder

func (client CachesClient) StopResponder(resp *http.Response) (result SetObject, err error)

StopResponder handles the response to the Stop request. The method always closes the http.Response Body.

func (CachesClient) StopSender

func (client CachesClient) StopSender(req *http.Request) (future CachesStopFuture, err error)

StopSender sends the Stop request. The method will close the http.Response Body if it receives an error.

func (CachesClient) Update

func (client CachesClient) Update(ctx context.Context, resourceGroupName string, cacheName string, cache *Cache) (result Cache, err error)

Update update a Cache instance. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. cache - object containing the user-selectable properties of the Cache. If read-only properties are included, they must match the existing values of those properties.

func (CachesClient) UpdatePreparer

func (client CachesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, cacheName string, cache *Cache) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (CachesClient) UpdateResponder

func (client CachesClient) UpdateResponder(resp *http.Response) (result Cache, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (CachesClient) UpdateSender

func (client CachesClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

func (CachesClient) UpgradeFirmware

func (client CachesClient) UpgradeFirmware(ctx context.Context, resourceGroupName string, cacheName string) (result CachesUpgradeFirmwareFuture, err error)

UpgradeFirmware upgrade a Cache's firmware if a new version is available. Otherwise, this operation has no effect. Parameters: resourceGroupName - target resource group. cacheName - name of Cache.

func (CachesClient) UpgradeFirmwarePreparer

func (client CachesClient) UpgradeFirmwarePreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)

UpgradeFirmwarePreparer prepares the UpgradeFirmware request.

func (CachesClient) UpgradeFirmwareResponder

func (client CachesClient) UpgradeFirmwareResponder(resp *http.Response) (result SetObject, err error)

UpgradeFirmwareResponder handles the response to the UpgradeFirmware request. The method always closes the http.Response Body.

func (CachesClient) UpgradeFirmwareSender

func (client CachesClient) UpgradeFirmwareSender(req *http.Request) (future CachesUpgradeFirmwareFuture, err error)

UpgradeFirmwareSender sends the UpgradeFirmware request. The method will close the http.Response Body if it receives an error.

type CachesCreateOrUpdateFuture

type CachesCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CachesClient) (Cache, error)
}

CachesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CachesCreateOrUpdateFuture) UnmarshalJSON

func (future *CachesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CachesDeleteFuture

type CachesDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CachesClient) (SetObject, error)
}

CachesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CachesDeleteFuture) UnmarshalJSON

func (future *CachesDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CachesFlushFuture

type CachesFlushFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CachesClient) (SetObject, error)
}

CachesFlushFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CachesFlushFuture) UnmarshalJSON

func (future *CachesFlushFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CachesListResult

type CachesListResult struct {
	autorest.Response `json:"-"`
	// NextLink - URL to get the next set of Cache list results, if there are any.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - List of Caches.
	Value *[]Cache `json:"value,omitempty"`
}

CachesListResult result of the request to list Caches. It contains a list of Caches and a URL link to get the next set of results.

func (CachesListResult) IsEmpty

func (clr CachesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CachesListResultIterator

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

CachesListResultIterator provides access to a complete listing of Cache values.

func NewCachesListResultIterator

func NewCachesListResultIterator(page CachesListResultPage) CachesListResultIterator

Creates a new instance of the CachesListResultIterator type.

func (*CachesListResultIterator) Next

func (iter *CachesListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*CachesListResultIterator) NextWithContext

func (iter *CachesListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (CachesListResultIterator) NotDone

func (iter CachesListResultIterator) NotDone() bool

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

func (CachesListResultIterator) Response

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

func (CachesListResultIterator) Value

func (iter CachesListResultIterator) Value() Cache

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type CachesListResultPage

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

CachesListResultPage contains a page of Cache values.

func NewCachesListResultPage

func NewCachesListResultPage(cur CachesListResult, getNextPage func(context.Context, CachesListResult) (CachesListResult, error)) CachesListResultPage

Creates a new instance of the CachesListResultPage type.

func (*CachesListResultPage) Next

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

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

func (page CachesListResultPage) NotDone() bool

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

func (CachesListResultPage) Response

func (page CachesListResultPage) Response() CachesListResult

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

func (CachesListResultPage) Values

func (page CachesListResultPage) Values() []Cache

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

type CachesStartFuture

type CachesStartFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CachesClient) (SetObject, error)
}

CachesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CachesStartFuture) UnmarshalJSON

func (future *CachesStartFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CachesStopFuture

type CachesStopFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CachesClient) (SetObject, error)
}

CachesStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CachesStopFuture) UnmarshalJSON

func (future *CachesStopFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CachesUpgradeFirmwareFuture

type CachesUpgradeFirmwareFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CachesClient) (SetObject, error)
}

CachesUpgradeFirmwareFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CachesUpgradeFirmwareFuture) UnmarshalJSON

func (future *CachesUpgradeFirmwareFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ClfsTarget

type ClfsTarget struct {
	// Target - Resource ID of storage container.
	Target *string `json:"target,omitempty"`
}

ClfsTarget storage container for use as a CLFS Storage Target.

type CloudError

type CloudError struct {
	// Error - The body of the error.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response.

type CloudErrorBody

type CloudErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
}

CloudErrorBody an error response.

type FirmwareStatusType

type FirmwareStatusType string

FirmwareStatusType enumerates the values for firmware status type.

const (
	// Available ...
	Available FirmwareStatusType = "available"
	// Unavailable ...
	Unavailable FirmwareStatusType = "unavailable"
)

func PossibleFirmwareStatusTypeValues

func PossibleFirmwareStatusTypeValues() []FirmwareStatusType

PossibleFirmwareStatusTypeValues returns an array of possible values for the FirmwareStatusType const type.

type HealthStateType

type HealthStateType string

HealthStateType enumerates the values for health state type.

const (
	// Degraded ...
	Degraded HealthStateType = "Degraded"
	// Down ...
	Down HealthStateType = "Down"
	// Flushing ...
	Flushing HealthStateType = "Flushing"
	// Healthy ...
	Healthy HealthStateType = "Healthy"
	// Stopped ...
	Stopped HealthStateType = "Stopped"
	// Stopping ...
	Stopping HealthStateType = "Stopping"
	// Transitioning ...
	Transitioning HealthStateType = "Transitioning"
	// Unknown ...
	Unknown HealthStateType = "Unknown"
	// Upgrading ...
	Upgrading HealthStateType = "Upgrading"
)

func PossibleHealthStateTypeValues

func PossibleHealthStateTypeValues() []HealthStateType

PossibleHealthStateTypeValues returns an array of possible values for the HealthStateType const type.

type NamespaceJunction

type NamespaceJunction struct {
	// NamespacePath - Namespace path on a Cache for a Storage Target.
	NamespacePath *string `json:"namespacePath,omitempty"`
	// TargetPath - Path in Storage Target to which namespacePath points.
	TargetPath *string `json:"targetPath,omitempty"`
	// NfsExport - NFS export where targetPath exists.
	NfsExport *string `json:"nfsExport,omitempty"`
}

NamespaceJunction a namespace junction.

type Nfs3Target

type Nfs3Target struct {
	// Target - IP address or host name of an NFSv3 host (e.g., 10.0.44.44).
	Target *string `json:"target,omitempty"`
	// UsageModel - Identifies the primary usage model to be used for this Storage Target. Get choices from .../usageModels
	UsageModel *string `json:"usageModel,omitempty"`
}

Nfs3Target an NFSv3 mount point for use as a Storage Target.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the a Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as "Storage Targets"). These operations allow you to manage Caches.

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result APIOperationListResultPage, err error)

List lists all of the available Resource Provider operations.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result APIOperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result APIOperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ProvisioningStateType

type ProvisioningStateType string

ProvisioningStateType enumerates the values for provisioning state type.

const (
	// Cancelled ...
	Cancelled ProvisioningStateType = "Cancelled"
	// Creating ...
	Creating ProvisioningStateType = "Creating"
	// Deleting ...
	Deleting ProvisioningStateType = "Deleting"
	// Failed ...
	Failed ProvisioningStateType = "Failed"
	// Succeeded ...
	Succeeded ProvisioningStateType = "Succeeded"
	// Updating ...
	Updating ProvisioningStateType = "Updating"
)

func PossibleProvisioningStateTypeValues

func PossibleProvisioningStateTypeValues() []ProvisioningStateType

PossibleProvisioningStateTypeValues returns an array of possible values for the ProvisioningStateType const type.

type ReasonCode

type ReasonCode string

ReasonCode enumerates the values for reason code.

const (
	// NotAvailableForSubscription ...
	NotAvailableForSubscription ReasonCode = "NotAvailableForSubscription"
	// QuotaID ...
	QuotaID ReasonCode = "QuotaId"
)

func PossibleReasonCodeValues

func PossibleReasonCodeValues() []ReasonCode

PossibleReasonCodeValues returns an array of possible values for the ReasonCode const type.

type ResourceSku

type ResourceSku struct {
	// ResourceType - READ-ONLY; The type of resource the SKU applies to.
	ResourceType *string `json:"resourceType,omitempty"`
	// Capabilities - A list of capabilities of this SKU, such as throughput or ops/sec.
	Capabilities *[]ResourceSkuCapabilities `json:"capabilities,omitempty"`
	// Locations - READ-ONLY; The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.).
	Locations *[]string `json:"locations,omitempty"`
	// LocationInfo - The set of locations that the SKU is available.
	LocationInfo *[]ResourceSkuLocationInfo `json:"locationInfo,omitempty"`
	// Name - The name of this SKU.
	Name *string `json:"name,omitempty"`
	// Restrictions - The restrictions preventing this SKU from being used. This is empty if there are no restrictions.
	Restrictions *[]Restriction `json:"restrictions,omitempty"`
}

ResourceSku a resource SKU.

func (ResourceSku) MarshalJSON

func (rs ResourceSku) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceSku.

type ResourceSkuCapabilities

type ResourceSkuCapabilities struct {
	// Name - Name of a capability, such as ops/sec.
	Name *string `json:"name,omitempty"`
	// Value - Quantity, if the capability is measured by quantity.
	Value *string `json:"value,omitempty"`
}

ResourceSkuCapabilities a resource SKU capability.

type ResourceSkuLocationInfo

type ResourceSkuLocationInfo struct {
	// Location - Location where this SKU is available.
	Location *string `json:"location,omitempty"`
	// Zones - Zones if any.
	Zones *[]string `json:"zones,omitempty"`
}

ResourceSkuLocationInfo resource SKU location information.

type ResourceSkusResult

type ResourceSkusResult struct {
	autorest.Response `json:"-"`
	// NextLink - The URI to fetch the next page of Cache SKUs.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - READ-ONLY; The list of SKUs available for the subscription.
	Value *[]ResourceSku `json:"value,omitempty"`
}

ResourceSkusResult the response from the List Cache SKUs operation.

func (ResourceSkusResult) IsEmpty

func (rsr ResourceSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ResourceSkusResult) MarshalJSON

func (rsr ResourceSkusResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceSkusResult.

type ResourceSkusResultIterator

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

ResourceSkusResultIterator provides access to a complete listing of ResourceSku values.

func NewResourceSkusResultIterator

func NewResourceSkusResultIterator(page ResourceSkusResultPage) ResourceSkusResultIterator

Creates a new instance of the ResourceSkusResultIterator type.

func (*ResourceSkusResultIterator) Next

func (iter *ResourceSkusResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ResourceSkusResultIterator) NextWithContext

func (iter *ResourceSkusResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ResourceSkusResultIterator) NotDone

func (iter ResourceSkusResultIterator) NotDone() bool

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

func (ResourceSkusResultIterator) Response

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

func (ResourceSkusResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ResourceSkusResultPage

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

ResourceSkusResultPage contains a page of ResourceSku values.

func NewResourceSkusResultPage

func NewResourceSkusResultPage(cur ResourceSkusResult, getNextPage func(context.Context, ResourceSkusResult) (ResourceSkusResult, error)) ResourceSkusResultPage

Creates a new instance of the ResourceSkusResultPage type.

func (*ResourceSkusResultPage) Next

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

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

func (page ResourceSkusResultPage) NotDone() bool

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

func (ResourceSkusResultPage) Response

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

func (ResourceSkusResultPage) Values

func (page ResourceSkusResultPage) Values() []ResourceSku

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

type Restriction

type Restriction struct {
	// Type - READ-ONLY; The type of restrictions. In this version, the only possible value for this is location.
	Type *string `json:"type,omitempty"`
	// Values - READ-ONLY; The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted.
	Values *[]string `json:"values,omitempty"`
	// ReasonCode - The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". "QuotaId" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. "NotAvailableForSubscription" is related to capacity at the datacenter. Possible values include: 'QuotaID', 'NotAvailableForSubscription'
	ReasonCode ReasonCode `json:"reasonCode,omitempty"`
}

Restriction the restrictions preventing this SKU from being used.

func (Restriction) MarshalJSON

func (r Restriction) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Restriction.

type SetObject

type SetObject struct {
	autorest.Response `json:"-"`
	Value             interface{} `json:"value,omitempty"`
}

SetObject ...

type SkusClient

type SkusClient struct {
	BaseClient
}

SkusClient is the a Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as "Storage Targets"). These operations allow you to manage Caches.

func NewSkusClient

func NewSkusClient(subscriptionID string) SkusClient

NewSkusClient creates an instance of the SkusClient client.

func NewSkusClientWithBaseURI

func NewSkusClientWithBaseURI(baseURI string, subscriptionID string) SkusClient

NewSkusClientWithBaseURI creates an instance of the SkusClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (SkusClient) List

func (client SkusClient) List(ctx context.Context) (result ResourceSkusResultPage, err error)

List get the list of StorageCache.Cache SKUs available to this subscription.

func (SkusClient) ListComplete

func (client SkusClient) ListComplete(ctx context.Context) (result ResourceSkusResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (SkusClient) ListPreparer

func (client SkusClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (SkusClient) ListResponder

func (client SkusClient) ListResponder(resp *http.Response) (result ResourceSkusResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (SkusClient) ListSender

func (client SkusClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type StorageTarget

type StorageTarget struct {
	autorest.Response `json:"-"`
	// Name - READ-ONLY; Name of the Storage Target.
	Name *string `json:"name,omitempty"`
	// ID - READ-ONLY; Resource ID of the Storage Target.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget
	Type *string `json:"type,omitempty"`
	// StorageTargetProperties - Properties of the Storage Target.
	*StorageTargetProperties `json:"properties,omitempty"`
}

StorageTarget a storage system being cached by a Cache.

func (StorageTarget) MarshalJSON

func (st StorageTarget) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageTarget.

func (*StorageTarget) UnmarshalJSON

func (st *StorageTarget) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for StorageTarget struct.

type StorageTargetProperties

type StorageTargetProperties struct {
	// Junctions - List of Cache namespace junctions to target for namespace associations.
	Junctions *[]NamespaceJunction `json:"junctions,omitempty"`
	// TargetType - Type of the Storage Target. Possible values include: 'StorageTargetTypeNfs3', 'StorageTargetTypeClfs', 'StorageTargetTypeUnknown'
	TargetType StorageTargetType `json:"targetType,omitempty"`
	// ProvisioningState - ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property. Possible values include: 'Succeeded', 'Failed', 'Cancelled', 'Creating', 'Deleting', 'Updating'
	ProvisioningState ProvisioningStateType `json:"provisioningState,omitempty"`
	// Nfs3 - Properties when targetType is nfs3.
	Nfs3 *Nfs3Target `json:"nfs3,omitempty"`
	// Clfs - Properties when targetType is clfs.
	Clfs *ClfsTarget `json:"clfs,omitempty"`
	// Unknown - Properties when targetType is unknown.
	Unknown *UnknownTarget `json:"unknown,omitempty"`
}

StorageTargetProperties properties of the Storage Target.

type StorageTargetType

type StorageTargetType string

StorageTargetType enumerates the values for storage target type.

const (
	// StorageTargetTypeClfs ...
	StorageTargetTypeClfs StorageTargetType = "clfs"
	// StorageTargetTypeNfs3 ...
	StorageTargetTypeNfs3 StorageTargetType = "nfs3"
	// StorageTargetTypeUnknown ...
	StorageTargetTypeUnknown StorageTargetType = "unknown"
)

func PossibleStorageTargetTypeValues

func PossibleStorageTargetTypeValues() []StorageTargetType

PossibleStorageTargetTypeValues returns an array of possible values for the StorageTargetType const type.

type StorageTargetsClient

type StorageTargetsClient struct {
	BaseClient
}

StorageTargetsClient is the a Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as "Storage Targets"). These operations allow you to manage Caches.

func NewStorageTargetsClient

func NewStorageTargetsClient(subscriptionID string) StorageTargetsClient

NewStorageTargetsClient creates an instance of the StorageTargetsClient client.

func NewStorageTargetsClientWithBaseURI

func NewStorageTargetsClientWithBaseURI(baseURI string, subscriptionID string) StorageTargetsClient

NewStorageTargetsClientWithBaseURI creates an instance of the StorageTargetsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (StorageTargetsClient) CreateOrUpdate

func (client StorageTargetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string, storagetarget *StorageTarget) (result StorageTargetsCreateOrUpdateFuture, err error)

CreateOrUpdate create or update a Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. storageTargetName - name of the Storage Target. storagetarget - object containing the definition of a Storage Target.

func (StorageTargetsClient) CreateOrUpdatePreparer

func (client StorageTargetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string, storagetarget *StorageTarget) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (StorageTargetsClient) CreateOrUpdateResponder

func (client StorageTargetsClient) CreateOrUpdateResponder(resp *http.Response) (result StorageTarget, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (StorageTargetsClient) CreateOrUpdateSender

func (client StorageTargetsClient) CreateOrUpdateSender(req *http.Request) (future StorageTargetsCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (StorageTargetsClient) Delete

func (client StorageTargetsClient) Delete(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string) (result StorageTargetsDeleteFuture, err error)

Delete removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. storageTargetName - name of Storage Target.

func (StorageTargetsClient) DeletePreparer

func (client StorageTargetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (StorageTargetsClient) DeleteResponder

func (client StorageTargetsClient) DeleteResponder(resp *http.Response) (result SetObject, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (StorageTargetsClient) DeleteSender

func (client StorageTargetsClient) DeleteSender(req *http.Request) (future StorageTargetsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (StorageTargetsClient) Get

func (client StorageTargetsClient) Get(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string) (result StorageTarget, err error)

Get returns a Storage Target from a Cache. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. storageTargetName - name of the Storage Target.

func (StorageTargetsClient) GetPreparer

func (client StorageTargetsClient) GetPreparer(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (StorageTargetsClient) GetResponder

func (client StorageTargetsClient) GetResponder(resp *http.Response) (result StorageTarget, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (StorageTargetsClient) GetSender

func (client StorageTargetsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (StorageTargetsClient) ListByCache

func (client StorageTargetsClient) ListByCache(ctx context.Context, resourceGroupName string, cacheName string) (result StorageTargetsResultPage, err error)

ListByCache returns a list of Storage Targets for the specified Cache. Parameters: resourceGroupName - target resource group. cacheName - name of Cache.

func (StorageTargetsClient) ListByCacheComplete

func (client StorageTargetsClient) ListByCacheComplete(ctx context.Context, resourceGroupName string, cacheName string) (result StorageTargetsResultIterator, err error)

ListByCacheComplete enumerates all values, automatically crossing page boundaries as required.

func (StorageTargetsClient) ListByCachePreparer

func (client StorageTargetsClient) ListByCachePreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)

ListByCachePreparer prepares the ListByCache request.

func (StorageTargetsClient) ListByCacheResponder

func (client StorageTargetsClient) ListByCacheResponder(resp *http.Response) (result StorageTargetsResult, err error)

ListByCacheResponder handles the response to the ListByCache request. The method always closes the http.Response Body.

func (StorageTargetsClient) ListByCacheSender

func (client StorageTargetsClient) ListByCacheSender(req *http.Request) (*http.Response, error)

ListByCacheSender sends the ListByCache request. The method will close the http.Response Body if it receives an error.

type StorageTargetsCreateOrUpdateFuture

type StorageTargetsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(StorageTargetsClient) (StorageTarget, error)
}

StorageTargetsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*StorageTargetsCreateOrUpdateFuture) UnmarshalJSON

func (future *StorageTargetsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type StorageTargetsDeleteFuture

type StorageTargetsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(StorageTargetsClient) (SetObject, error)
}

StorageTargetsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*StorageTargetsDeleteFuture) UnmarshalJSON

func (future *StorageTargetsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type StorageTargetsResult

type StorageTargetsResult struct {
	autorest.Response `json:"-"`
	// NextLink - The URI to fetch the next page of Storage Targets.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The list of Storage Targets defined for the Cache.
	Value *[]StorageTarget `json:"value,omitempty"`
}

StorageTargetsResult a list of Storage Targets.

func (StorageTargetsResult) IsEmpty

func (str StorageTargetsResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type StorageTargetsResultIterator

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

StorageTargetsResultIterator provides access to a complete listing of StorageTarget values.

func NewStorageTargetsResultIterator

func NewStorageTargetsResultIterator(page StorageTargetsResultPage) StorageTargetsResultIterator

Creates a new instance of the StorageTargetsResultIterator type.

func (*StorageTargetsResultIterator) Next

func (iter *StorageTargetsResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*StorageTargetsResultIterator) NextWithContext

func (iter *StorageTargetsResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (StorageTargetsResultIterator) NotDone

func (iter StorageTargetsResultIterator) NotDone() bool

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

func (StorageTargetsResultIterator) Response

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

func (StorageTargetsResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type StorageTargetsResultPage

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

StorageTargetsResultPage contains a page of StorageTarget values.

func NewStorageTargetsResultPage

func NewStorageTargetsResultPage(cur StorageTargetsResult, getNextPage func(context.Context, StorageTargetsResult) (StorageTargetsResult, error)) StorageTargetsResultPage

Creates a new instance of the StorageTargetsResultPage type.

func (*StorageTargetsResultPage) Next

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

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

func (page StorageTargetsResultPage) NotDone() bool

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

func (StorageTargetsResultPage) Response

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

func (StorageTargetsResultPage) Values

func (page StorageTargetsResultPage) Values() []StorageTarget

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

type UnknownTarget

type UnknownTarget struct {
	// UnknownMap - Dictionary of string->string pairs containing information about the Storage Target.
	UnknownMap map[string]*string `json:"unknownMap"`
}

UnknownTarget storage container for use as an Unknown Storage Target.

func (UnknownTarget) MarshalJSON

func (ut UnknownTarget) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UnknownTarget.

type UsageModel

type UsageModel struct {
	// Display - Localized information describing this usage model.
	Display *UsageModelDisplay `json:"display,omitempty"`
	// ModelName - Non-localized keyword name for this usage model.
	ModelName *string `json:"modelName,omitempty"`
	// TargetType - The type of Storage Target to which this model is applicable (only nfs3 as of this version).
	TargetType *string `json:"targetType,omitempty"`
}

UsageModel a usage model.

type UsageModelDisplay

type UsageModelDisplay struct {
	// Description - String to display for this usage model.
	Description *string `json:"description,omitempty"`
}

UsageModelDisplay localized information describing this usage model.

type UsageModelsClient

type UsageModelsClient struct {
	BaseClient
}

UsageModelsClient is the a Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as "Storage Targets"). These operations allow you to manage Caches.

func NewUsageModelsClient

func NewUsageModelsClient(subscriptionID string) UsageModelsClient

NewUsageModelsClient creates an instance of the UsageModelsClient client.

func NewUsageModelsClientWithBaseURI

func NewUsageModelsClientWithBaseURI(baseURI string, subscriptionID string) UsageModelsClient

NewUsageModelsClientWithBaseURI creates an instance of the UsageModelsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (UsageModelsClient) List

func (client UsageModelsClient) List(ctx context.Context) (result UsageModelsResultPage, err error)

List get the list of Cache Usage Models available to this subscription.

func (UsageModelsClient) ListComplete

func (client UsageModelsClient) ListComplete(ctx context.Context) (result UsageModelsResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UsageModelsClient) ListPreparer

func (client UsageModelsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (UsageModelsClient) ListResponder

func (client UsageModelsClient) ListResponder(resp *http.Response) (result UsageModelsResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UsageModelsClient) ListSender

func (client UsageModelsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UsageModelsResult

type UsageModelsResult struct {
	autorest.Response `json:"-"`
	// NextLink - The URI to fetch the next page of Cache usage models.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The list of usage models available for the subscription.
	Value *[]UsageModel `json:"value,omitempty"`
}

UsageModelsResult a list of Cache usage models.

func (UsageModelsResult) IsEmpty

func (umr UsageModelsResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UsageModelsResultIterator

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

UsageModelsResultIterator provides access to a complete listing of UsageModel values.

func NewUsageModelsResultIterator

func NewUsageModelsResultIterator(page UsageModelsResultPage) UsageModelsResultIterator

Creates a new instance of the UsageModelsResultIterator type.

func (*UsageModelsResultIterator) Next

func (iter *UsageModelsResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*UsageModelsResultIterator) NextWithContext

func (iter *UsageModelsResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (UsageModelsResultIterator) NotDone

func (iter UsageModelsResultIterator) NotDone() bool

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

func (UsageModelsResultIterator) Response

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

func (UsageModelsResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type UsageModelsResultPage

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

UsageModelsResultPage contains a page of UsageModel values.

func NewUsageModelsResultPage

func NewUsageModelsResultPage(cur UsageModelsResult, getNextPage func(context.Context, UsageModelsResult) (UsageModelsResult, error)) UsageModelsResultPage

Creates a new instance of the UsageModelsResultPage type.

func (*UsageModelsResultPage) Next

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

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

func (page UsageModelsResultPage) NotDone() bool

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

func (UsageModelsResultPage) Response

func (page UsageModelsResultPage) Response() UsageModelsResult

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

func (UsageModelsResultPage) Values

func (page UsageModelsResultPage) Values() []UsageModel

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL