storagecache

package
v61.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 31, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package storagecache implements the Azure ARM Storagecache service API version 2021-05-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"`
	// Origin - Origin of the operation.
	Origin *string `json:"origin,omitempty"`
	// IsDataAction - The flag that indicates whether the operation applies to data plane.
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// APIOperationProperties - Additional details about an operation.
	*APIOperationProperties `json:"properties,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

func (APIOperation) MarshalJSON 

func (ao APIOperation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for APIOperation.

func (*APIOperation) UnmarshalJSON 

func (ao *APIOperation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for APIOperation struct.

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"`
	// Description - The description of the operation
	Description *string `json:"description,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 

func (iter *APIOperationListResultIterator) 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 (*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 

func (iter APIOperationListResultIterator) Response() APIOperationListResult

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

func (APIOperationListResultIterator) Value 

func (iter APIOperationListResultIterator) Value() APIOperation

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 

func NewAPIOperationListResultPage(cur APIOperationListResult, getNextPage func(context.Context, APIOperationListResult) (APIOperationListResult, error)) APIOperationListResultPage

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 

func (page APIOperationListResultPage) Response() APIOperationListResult

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 APIOperationProperties 

type APIOperationProperties struct {
	// ServiceSpecification - Specification of the all the metrics provided for a resource type.
	ServiceSpecification *APIOperationPropertiesServiceSpecification `json:"serviceSpecification,omitempty"`
}

APIOperationProperties additional details about an operation.

type APIOperationPropertiesServiceSpecification 

type APIOperationPropertiesServiceSpecification struct {
	// MetricSpecifications - Details about operations related to metrics.
	MetricSpecifications *[]MetricSpecification `json:"metricSpecifications,omitempty"`
}

APIOperationPropertiesServiceSpecification specification of the all the metrics provided for a resource type.

type AscOperation 

type AscOperation struct {
	autorest.Response `json:"-"`
	// ID - The operation Id.
	ID *string `json:"id,omitempty"`
	// Name - The operation name.
	Name *string `json:"name,omitempty"`
	// StartTime - The start time of the operation.
	StartTime *string `json:"startTime,omitempty"`
	// EndTime - The end time of the operation.
	EndTime *string `json:"endTime,omitempty"`
	// Status - The status of the operation.
	Status *string `json:"status,omitempty"`
	// Error - The error detail of the operation if any.
	Error *ErrorResponse `json:"error,omitempty"`
	// AscOperationProperties - Additional operation-specific properties
	*AscOperationProperties `json:"properties,omitempty"`
}

AscOperation the status of operation.

func (AscOperation) MarshalJSON 

func (ao AscOperation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AscOperation.

func (*AscOperation) UnmarshalJSON 

func (ao *AscOperation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AscOperation struct.

type AscOperationProperties 

type AscOperationProperties struct {
	// Output - Additional operation-specific output.
	Output map[string]interface{} `json:"output"`
}

AscOperationProperties additional operation-specific output.

func (AscOperationProperties) MarshalJSON 

func (aop AscOperationProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AscOperationProperties.

type AscOperationsClient 

type AscOperationsClient struct {
	BaseClient
}

AscOperationsClient 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 NewAscOperationsClient 

func NewAscOperationsClient(subscriptionID string) AscOperationsClient

NewAscOperationsClient creates an instance of the AscOperationsClient client.

func NewAscOperationsClientWithBaseURI 

func NewAscOperationsClientWithBaseURI(baseURI string, subscriptionID string) AscOperationsClient

NewAscOperationsClientWithBaseURI creates an instance of the AscOperationsClient 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 (AscOperationsClient) Get 

func (client AscOperationsClient) Get(ctx context.Context, location string, operationID string) (result AscOperation, err error)

Get gets the status of an asynchronous operation for the Azure HPC Cache Parameters: location - the name of the region used to look up the operation. operationID - the operation id which uniquely identifies the asynchronous operation.

func (AscOperationsClient) GetPreparer 

func (client AscOperationsClient) GetPreparer(ctx context.Context, location string, operationID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AscOperationsClient) GetResponder 

func (client AscOperationsClient) GetResponder(resp *http.Response) (result AscOperation, err error)

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

func (AscOperationsClient) GetSender 

func (client AscOperationsClient) 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.

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 BlobNfsTarget 

type BlobNfsTarget struct {
	// Target - Resource ID of the storage container.
	Target *string `json:"target,omitempty"`
	// UsageModel - Identifies the StorageCache usage model to be used for this storage target.
	UsageModel *string `json:"usageModel,omitempty"`
}

BlobNfsTarget properties pertaining to the BlobNfsTarget.

type Cache 

type Cache struct {
	autorest.Response `json:"-"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// 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"`
	// Identity - The identity of the cache, if configured.
	Identity *CacheIdentity `json:"identity,omitempty"`
	// SystemData - READ-ONLY; The system meta data relating to this resource.
	SystemData *SystemData `json:"systemData,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 CacheActiveDirectorySettings 

type CacheActiveDirectorySettings struct {
	// PrimaryDNSIPAddress - Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
	PrimaryDNSIPAddress *string `json:"primaryDnsIpAddress,omitempty"`
	// SecondaryDNSIPAddress - Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.
	SecondaryDNSIPAddress *string `json:"secondaryDnsIpAddress,omitempty"`
	// DomainName - The fully qualified domain name of the Active Directory domain controller.
	DomainName *string `json:"domainName,omitempty"`
	// DomainNetBiosName - The Active Directory domain's NetBIOS name.
	DomainNetBiosName *string `json:"domainNetBiosName,omitempty"`
	// CacheNetBiosName - The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].
	CacheNetBiosName *string `json:"cacheNetBiosName,omitempty"`
	// DomainJoined - READ-ONLY; True if the HPC Cache is joined to the Active Directory domain. Possible values include: 'DomainJoinedTypeYes', 'DomainJoinedTypeNo', 'DomainJoinedTypeError'
	DomainJoined DomainJoinedType `json:"domainJoined,omitempty"`
	// Credentials - Active Directory admin credentials used to join the HPC Cache to a domain.
	Credentials *CacheActiveDirectorySettingsCredentials `json:"credentials,omitempty"`
}

CacheActiveDirectorySettings active Directory settings used to join a cache to a domain.

func (CacheActiveDirectorySettings) MarshalJSON 

func (cads CacheActiveDirectorySettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheActiveDirectorySettings.

type CacheActiveDirectorySettingsCredentials 

type CacheActiveDirectorySettingsCredentials struct {
	// Username - Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
	Username *string `json:"username,omitempty"`
	// Password - Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.
	Password *string `json:"password,omitempty"`
}

CacheActiveDirectorySettingsCredentials active Directory admin credentials used to join the HPC Cache to a domain.

type CacheDirectorySettings 

type CacheDirectorySettings struct {
	// ActiveDirectory - Specifies settings for joining the HPC Cache to an Active Directory domain.
	ActiveDirectory *CacheActiveDirectorySettings `json:"activeDirectory,omitempty"`
	// UsernameDownload - Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups.
	UsernameDownload *CacheUsernameDownloadSettings `json:"usernameDownload,omitempty"`
}

CacheDirectorySettings cache Directory Services settings.

type CacheEncryptionSettings 

type CacheEncryptionSettings struct {
	// KeyEncryptionKey - Specifies the location of the key encryption key in Key Vault.
	KeyEncryptionKey *KeyVaultKeyReference `json:"keyEncryptionKey,omitempty"`
	// RotationToLatestKeyVersionEnabled - Specifies whether the service will automatically rotate to the newest version of the key in the Key Vault.
	RotationToLatestKeyVersionEnabled *bool `json:"rotationToLatestKeyVersionEnabled,omitempty"`
}

CacheEncryptionSettings cache encryption settings.

type CacheHealth 

type CacheHealth struct {
	// State - List of Cache health states. Possible values include: 'HealthStateTypeUnknown', 'HealthStateTypeHealthy', 'HealthStateTypeDegraded', 'HealthStateTypeDown', 'HealthStateTypeTransitioning', 'HealthStateTypeStopping', 'HealthStateTypeStopped', 'HealthStateTypeUpgrading', 'HealthStateTypeFlushing'
	State HealthStateType `json:"state,omitempty"`
	// StatusDescription - Describes explanation of state.
	StatusDescription *string `json:"statusDescription,omitempty"`
	// Conditions - READ-ONLY; Outstanding conditions that need to be investigated and resolved.
	Conditions *[]Condition `json:"conditions,omitempty"`
}

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

func (CacheHealth) MarshalJSON 

func (ch CacheHealth) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheHealth.

type CacheIdentity 

type CacheIdentity struct {
	// PrincipalID - READ-ONLY; The principal ID for the system-assigned identity of the cache.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant ID associated with the cache.
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The type of identity used for the cache. Possible values include: 'CacheIdentityTypeSystemAssigned', 'CacheIdentityTypeUserAssigned', 'CacheIdentityTypeSystemAssignedUserAssigned', 'CacheIdentityTypeNone'
	Type CacheIdentityType `json:"type,omitempty"`
	// UserAssignedIdentities - A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.
	UserAssignedIdentities map[string]*CacheIdentityUserAssignedIdentitiesValue `json:"userAssignedIdentities"`
}

CacheIdentity cache identity properties.

func (CacheIdentity) MarshalJSON 

func (ci CacheIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheIdentity.

type CacheIdentityType 

type CacheIdentityType string

CacheIdentityType enumerates the values for cache identity type. 

const (
	// CacheIdentityTypeNone ...
	CacheIdentityTypeNone CacheIdentityType = "None"
	// CacheIdentityTypeSystemAssigned ...
	CacheIdentityTypeSystemAssigned CacheIdentityType = "SystemAssigned"
	// CacheIdentityTypeSystemAssignedUserAssigned ...
	CacheIdentityTypeSystemAssignedUserAssigned CacheIdentityType = "SystemAssigned, UserAssigned"
	// CacheIdentityTypeUserAssigned ...
	CacheIdentityTypeUserAssigned CacheIdentityType = "UserAssigned"
)

func PossibleCacheIdentityTypeValues 

func PossibleCacheIdentityTypeValues() []CacheIdentityType

PossibleCacheIdentityTypeValues returns an array of possible values for the CacheIdentityType const type.

type CacheIdentityUserAssignedIdentitiesValue 

type CacheIdentityUserAssignedIdentitiesValue struct {
	// PrincipalID - READ-ONLY; The principal ID of the user-assigned identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// ClientID - READ-ONLY; The client ID of the user-assigned identity.
	ClientID *string `json:"clientId,omitempty"`
}

CacheIdentityUserAssignedIdentitiesValue ...

func (CacheIdentityUserAssignedIdentitiesValue) MarshalJSON 

func (ciAiv CacheIdentityUserAssignedIdentitiesValue) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheIdentityUserAssignedIdentitiesValue.

type CacheNetworkSettings 

type CacheNetworkSettings struct {
	// Mtu - The IPv4 maximum transmission unit configured for the subnet.
	Mtu *int32 `json:"mtu,omitempty"`
	// UtilityAddresses - READ-ONLY; Array of additional IP addresses used by this Cache.
	UtilityAddresses *[]string `json:"utilityAddresses,omitempty"`
	// DNSServers - DNS servers for the cache to use.  It will be set from the network configuration if no value is provided.
	DNSServers *[]string `json:"dnsServers,omitempty"`
	// DNSSearchDomain - DNS search domain
	DNSSearchDomain *string `json:"dnsSearchDomain,omitempty"`
	// NtpServer - NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.
	NtpServer *string `json:"ntpServer,omitempty"`
}

CacheNetworkSettings cache network settings.

func (CacheNetworkSettings) MarshalJSON 

func (cns CacheNetworkSettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheNetworkSettings.

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 - READ-ONLY; ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property. Possible values include: 'ProvisioningStateTypeSucceeded', 'ProvisioningStateTypeFailed', 'ProvisioningStateTypeCancelled', 'ProvisioningStateTypeCreating', 'ProvisioningStateTypeDeleting', 'ProvisioningStateTypeUpdating'
	ProvisioningState ProvisioningStateType `json:"provisioningState,omitempty"`
	// Subnet - Subnet used for the Cache.
	Subnet *string `json:"subnet,omitempty"`
	// UpgradeStatus - READ-ONLY; Upgrade status of the Cache.
	UpgradeStatus *CacheUpgradeStatus `json:"upgradeStatus,omitempty"`
	// NetworkSettings - Specifies network settings of the cache.
	NetworkSettings *CacheNetworkSettings `json:"networkSettings,omitempty"`
	// EncryptionSettings - Specifies encryption settings of the cache.
	EncryptionSettings *CacheEncryptionSettings `json:"encryptionSettings,omitempty"`
	// SecuritySettings - Specifies security settings of the cache.
	SecuritySettings *CacheSecuritySettings `json:"securitySettings,omitempty"`
	// DirectoryServicesSettings - Specifies Directory Services settings of the cache.
	DirectoryServicesSettings *CacheDirectorySettings `json:"directoryServicesSettings,omitempty"`
}

CacheProperties properties of the Cache.

func (CacheProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for CacheProperties.

type CacheSecuritySettings 

type CacheSecuritySettings struct {
	// AccessPolicies - NFS access policies defined for this cache.
	AccessPolicies *[]NfsAccessPolicy `json:"accessPolicies,omitempty"`
}

CacheSecuritySettings cache security settings.

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: 'FirmwareStatusTypeAvailable', 'FirmwareStatusTypeUnavailable'
	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 CacheUsernameDownloadSettings 

type CacheUsernameDownloadSettings struct {
	// ExtendedGroups - Whether or not Extended Groups is enabled.
	ExtendedGroups *bool `json:"extendedGroups,omitempty"`
	// UsernameSource - This setting determines how the cache gets username and group names for clients. Possible values include: 'UsernameSourceAD', 'UsernameSourceLDAP', 'UsernameSourceFile', 'UsernameSourceNone'
	UsernameSource UsernameSource `json:"usernameSource,omitempty"`
	// GroupFileURI - The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'.
	GroupFileURI *string `json:"groupFileURI,omitempty"`
	// UserFileURI - The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'.
	UserFileURI *string `json:"userFileURI,omitempty"`
	// LdapServer - The fully qualified domain name or IP address of the LDAP server to use.
	LdapServer *string `json:"ldapServer,omitempty"`
	// LdapBaseDN - The base distinguished name for the LDAP domain.
	LdapBaseDN *string `json:"ldapBaseDN,omitempty"`
	// EncryptLdapConnection - Whether or not the LDAP connection should be encrypted.
	EncryptLdapConnection *bool `json:"encryptLdapConnection,omitempty"`
	// RequireValidCertificate - Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.
	RequireValidCertificate *bool `json:"requireValidCertificate,omitempty"`
	// AutoDownloadCertificate - Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.
	AutoDownloadCertificate *bool `json:"autoDownloadCertificate,omitempty"`
	// CaCertificateURI - The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true.
	CaCertificateURI *string `json:"caCertificateURI,omitempty"`
	// UsernameDownloaded - READ-ONLY; Indicates whether or not the HPC Cache has performed the username download successfully. Possible values include: 'UsernameDownloadedTypeYes', 'UsernameDownloadedTypeNo', 'UsernameDownloadedTypeError'
	UsernameDownloaded UsernameDownloadedType `json:"usernameDownloaded,omitempty"`
	// Credentials - When present, these are the credentials for the secure LDAP connection.
	Credentials *CacheUsernameDownloadSettingsCredentials `json:"credentials,omitempty"`
}

CacheUsernameDownloadSettings settings for Extended Groups username and group download.

func (CacheUsernameDownloadSettings) MarshalJSON 

func (cuds CacheUsernameDownloadSettings) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CacheUsernameDownloadSettings.

type CacheUsernameDownloadSettingsCredentials 

type CacheUsernameDownloadSettingsCredentials struct {
	// BindDn - The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
	BindDn *string `json:"bindDn,omitempty"`
	// BindPassword - The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.
	BindPassword *string `json:"bindPassword,omitempty"`
}

CacheUsernameDownloadSettingsCredentials when present, these are the credentials for the secure LDAP connection.

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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. 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) DebugInfo 

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

DebugInfo tells a Cache to write generate debug info for support to process. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

func (CachesClient) DebugInfoPreparer 

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

DebugInfoPreparer prepares the DebugInfo request.

func (CachesClient) DebugInfoResponder 

func (client CachesClient) DebugInfoResponder(resp *http.Response) (result autorest.Response, err error)

DebugInfoResponder handles the response to the DebugInfo request. The method always closes the http.Response Body.

func (CachesClient) DebugInfoSender 

func (client CachesClient) DebugInfoSender(req *http.Request) (future CachesDebugInfoFuture, err error)

DebugInfoSender sends the DebugInfo 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

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 autorest.Response, 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

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 autorest.Response, 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

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 autorest.Response, 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

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 autorest.Response, 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

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 autorest.Response, 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 CachesDebugInfoFuture 

type CachesDebugInfoFuture 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) (autorest.Response, error)
}

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

func (*CachesDebugInfoFuture) UnmarshalJSON 

func (future *CachesDebugInfoFuture) 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) (autorest.Response, 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) (autorest.Response, 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 

func (iter CachesListResultIterator) Response() CachesListResult

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) (autorest.Response, 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) (autorest.Response, 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) (autorest.Response, 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 properties pertaining to the ClfsTarget

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 Condition 

type Condition struct {
	// Timestamp - READ-ONLY; The time when the condition was raised.
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Message - READ-ONLY; The issue requiring attention.
	Message *string `json:"message,omitempty"`
}

Condition outstanding conditions that will need to be resolved.

func (Condition) MarshalJSON 

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

MarshalJSON is the custom marshaler for Condition.

type CreatedByType 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// CreatedByTypeApplication ...
	CreatedByTypeApplication CreatedByType = "Application"
	// CreatedByTypeKey ...
	CreatedByTypeKey CreatedByType = "Key"
	// CreatedByTypeManagedIdentity ...
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	// CreatedByTypeUser ...
	CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

type DomainJoinedType 

type DomainJoinedType string

DomainJoinedType enumerates the values for domain joined type. 

const (
	// DomainJoinedTypeError ...
	DomainJoinedTypeError DomainJoinedType = "Error"
	// DomainJoinedTypeNo ...
	DomainJoinedTypeNo DomainJoinedType = "No"
	// DomainJoinedTypeYes ...
	DomainJoinedTypeYes DomainJoinedType = "Yes"
)

func PossibleDomainJoinedTypeValues 

func PossibleDomainJoinedTypeValues() []DomainJoinedType

PossibleDomainJoinedTypeValues returns an array of possible values for the DomainJoinedType const type.

type ErrorResponse 

type ErrorResponse struct {
	// Code - Error code
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse describes the format of Error response.

type FirmwareStatusType 

type FirmwareStatusType string

FirmwareStatusType enumerates the values for firmware status type. 

const (
	// FirmwareStatusTypeAvailable ...
	FirmwareStatusTypeAvailable FirmwareStatusType = "available"
	// FirmwareStatusTypeUnavailable ...
	FirmwareStatusTypeUnavailable 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 (
	// HealthStateTypeDegraded ...
	HealthStateTypeDegraded HealthStateType = "Degraded"
	// HealthStateTypeDown ...
	HealthStateTypeDown HealthStateType = "Down"
	// HealthStateTypeFlushing ...
	HealthStateTypeFlushing HealthStateType = "Flushing"
	// HealthStateTypeHealthy ...
	HealthStateTypeHealthy HealthStateType = "Healthy"
	// HealthStateTypeStopped ...
	HealthStateTypeStopped HealthStateType = "Stopped"
	// HealthStateTypeStopping ...
	HealthStateTypeStopping HealthStateType = "Stopping"
	// HealthStateTypeTransitioning ...
	HealthStateTypeTransitioning HealthStateType = "Transitioning"
	// HealthStateTypeUnknown ...
	HealthStateTypeUnknown HealthStateType = "Unknown"
	// HealthStateTypeUpgrading ...
	HealthStateTypeUpgrading HealthStateType = "Upgrading"
)

func PossibleHealthStateTypeValues 

func PossibleHealthStateTypeValues() []HealthStateType

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

type KeyVaultKeyReference 

type KeyVaultKeyReference struct {
	// KeyURL - The URL referencing a key encryption key in Key Vault.
	KeyURL *string `json:"keyUrl,omitempty"`
	// SourceVault - Describes a resource Id to source Key Vault.
	SourceVault *KeyVaultKeyReferenceSourceVault `json:"sourceVault,omitempty"`
}

KeyVaultKeyReference describes a reference to Key Vault Key.

type KeyVaultKeyReferenceSourceVault 

type KeyVaultKeyReferenceSourceVault struct {
	// ID - Resource Id.
	ID *string `json:"id,omitempty"`
}

KeyVaultKeyReferenceSourceVault describes a resource Id to source Key Vault.

type MetricAggregationType 

type MetricAggregationType string

MetricAggregationType enumerates the values for metric aggregation type. 

const (
	// MetricAggregationTypeAverage ...
	MetricAggregationTypeAverage MetricAggregationType = "Average"
	// MetricAggregationTypeCount ...
	MetricAggregationTypeCount MetricAggregationType = "Count"
	// MetricAggregationTypeMaximum ...
	MetricAggregationTypeMaximum MetricAggregationType = "Maximum"
	// MetricAggregationTypeMinimum ...
	MetricAggregationTypeMinimum MetricAggregationType = "Minimum"
	// MetricAggregationTypeNone ...
	MetricAggregationTypeNone MetricAggregationType = "None"
	// MetricAggregationTypeNotSpecified ...
	MetricAggregationTypeNotSpecified MetricAggregationType = "NotSpecified"
	// MetricAggregationTypeTotal ...
	MetricAggregationTypeTotal MetricAggregationType = "Total"
)

func PossibleMetricAggregationTypeValues 

func PossibleMetricAggregationTypeValues() []MetricAggregationType

PossibleMetricAggregationTypeValues returns an array of possible values for the MetricAggregationType const type.

type MetricDimension 

type MetricDimension struct {
	// Name - Name of the dimension
	Name *string `json:"name,omitempty"`
	// DisplayName - Localized friendly display name of the dimension
	DisplayName *string `json:"displayName,omitempty"`
	// InternalName - Internal name of the dimension.
	InternalName *string `json:"internalName,omitempty"`
	// ToBeExportedForShoebox - To be exported to shoe box.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

MetricDimension specifications of the Dimension of metrics.

type MetricSpecification 

type MetricSpecification struct {
	// Name - The name of the metric.
	Name *string `json:"name,omitempty"`
	// DisplayName - Localized display name of the metric.
	DisplayName *string `json:"displayName,omitempty"`
	// DisplayDescription - The description of the metric.
	DisplayDescription *string `json:"displayDescription,omitempty"`
	// Unit - The unit that the metric is measured in.
	Unit *string `json:"unit,omitempty"`
	// AggregationType - The type of metric aggregation.
	AggregationType *string `json:"aggregationType,omitempty"`
	// SupportedAggregationTypes - Support metric aggregation type.
	SupportedAggregationTypes *[]MetricAggregationType `json:"supportedAggregationTypes,omitempty"`
	// MetricClass - Type of metrics.
	MetricClass *string `json:"metricClass,omitempty"`
	// Dimensions - Dimensions of the metric
	Dimensions *[]MetricDimension `json:"dimensions,omitempty"`
}

MetricSpecification details about operation related to metrics.

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"`
	// NfsAccessPolicy - Name of the access policy applied to this junction.
	NfsAccessPolicy *string `json:"nfsAccessPolicy,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 StorageCache usage model to be used for this storage target.
	UsageModel *string `json:"usageModel,omitempty"`
}

Nfs3Target properties pertaining to the Nfs3Target

type NfsAccessPolicy 

type NfsAccessPolicy struct {
	// Name - Name identifying this policy. Access Policy names are not case sensitive.
	Name *string `json:"name,omitempty"`
	// AccessRules - The set of rules describing client accesses allowed under this policy.
	AccessRules *[]NfsAccessRule `json:"accessRules,omitempty"`
}

NfsAccessPolicy a set of rules describing access policies applied to NFSv3 clients of the cache.

type NfsAccessRule 

type NfsAccessRule struct {
	// Scope - Scope for this rule. The scope and filter determine which clients match the rule. Possible values include: 'NfsAccessRuleScopeDefault', 'NfsAccessRuleScopeNetwork', 'NfsAccessRuleScopeHost'
	Scope NfsAccessRuleScope `json:"scope,omitempty"`
	// Filter - Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.
	Filter *string `json:"filter,omitempty"`
	// Access - Access allowed by this rule. Possible values include: 'NfsAccessRuleAccessNo', 'NfsAccessRuleAccessRo', 'NfsAccessRuleAccessRw'
	Access NfsAccessRuleAccess `json:"access,omitempty"`
	// Suid - Allow SUID semantics.
	Suid *bool `json:"suid,omitempty"`
	// SubmountAccess - For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.
	SubmountAccess *bool `json:"submountAccess,omitempty"`
	// RootSquash - Map root accesses to anonymousUID and anonymousGID.
	RootSquash *bool `json:"rootSquash,omitempty"`
	// AnonymousUID - UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.
	AnonymousUID *string `json:"anonymousUID,omitempty"`
	// AnonymousGID - GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.
	AnonymousGID *string `json:"anonymousGID,omitempty"`
}

NfsAccessRule rule to place restrictions on portions of the cache namespace being presented to clients.

type NfsAccessRuleAccess 

type NfsAccessRuleAccess string

NfsAccessRuleAccess enumerates the values for nfs access rule access. 

const (
	// NfsAccessRuleAccessNo ...
	NfsAccessRuleAccessNo NfsAccessRuleAccess = "no"
	// NfsAccessRuleAccessRo ...
	NfsAccessRuleAccessRo NfsAccessRuleAccess = "ro"
	// NfsAccessRuleAccessRw ...
	NfsAccessRuleAccessRw NfsAccessRuleAccess = "rw"
)

func PossibleNfsAccessRuleAccessValues 

func PossibleNfsAccessRuleAccessValues() []NfsAccessRuleAccess

PossibleNfsAccessRuleAccessValues returns an array of possible values for the NfsAccessRuleAccess const type.

type NfsAccessRuleScope 

type NfsAccessRuleScope string

NfsAccessRuleScope enumerates the values for nfs access rule scope. 

const (
	// NfsAccessRuleScopeDefault ...
	NfsAccessRuleScopeDefault NfsAccessRuleScope = "default"
	// NfsAccessRuleScopeHost ...
	NfsAccessRuleScopeHost NfsAccessRuleScope = "host"
	// NfsAccessRuleScopeNetwork ...
	NfsAccessRuleScopeNetwork NfsAccessRuleScope = "network"
)

func PossibleNfsAccessRuleScopeValues 

func PossibleNfsAccessRuleScopeValues() []NfsAccessRuleScope

PossibleNfsAccessRuleScopeValues returns an array of possible values for the NfsAccessRuleScope const type.

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 (
	// ProvisioningStateTypeCancelled ...
	ProvisioningStateTypeCancelled ProvisioningStateType = "Cancelled"
	// ProvisioningStateTypeCreating ...
	ProvisioningStateTypeCreating ProvisioningStateType = "Creating"
	// ProvisioningStateTypeDeleting ...
	ProvisioningStateTypeDeleting ProvisioningStateType = "Deleting"
	// ProvisioningStateTypeFailed ...
	ProvisioningStateTypeFailed ProvisioningStateType = "Failed"
	// ProvisioningStateTypeSucceeded ...
	ProvisioningStateTypeSucceeded ProvisioningStateType = "Succeeded"
	// ProvisioningStateTypeUpdating ...
	ProvisioningStateTypeUpdating 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 (
	// ReasonCodeNotAvailableForSubscription ...
	ReasonCodeNotAvailableForSubscription ReasonCode = "NotAvailableForSubscription"
	// ReasonCodeQuotaID ...
	ReasonCodeQuotaID 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 where the SKU is available. This is the 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 where 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 

func (iter ResourceSkusResultIterator) Response() ResourceSkusResult

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

func (ResourceSkusResultIterator) Value 

func (iter ResourceSkusResultIterator) Value() ResourceSku

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 

func (page ResourceSkusResultPage) Response() ResourceSkusResult

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: 'ReasonCodeQuotaID', 'ReasonCodeNotAvailableForSubscription'
	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 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:"-"`
	// StorageTargetProperties - StorageTarget properties
	*StorageTargetProperties `json:"properties,omitempty"`
	// 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"`
	// Location - READ-ONLY; Region name string.
	Location *string `json:"location,omitempty"`
	// SystemData - READ-ONLY; The system meta data relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty"`
}

StorageTarget type of the Storage Target.

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 StorageTargetClient 

type StorageTargetClient struct {
	BaseClient
}

StorageTargetClient 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 NewStorageTargetClient 

func NewStorageTargetClient(subscriptionID string) StorageTargetClient

NewStorageTargetClient creates an instance of the StorageTargetClient client.

func NewStorageTargetClientWithBaseURI 

func NewStorageTargetClientWithBaseURI(baseURI string, subscriptionID string) StorageTargetClient

NewStorageTargetClientWithBaseURI creates an instance of the StorageTargetClient 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 (StorageTargetClient) Flush 

func (client StorageTargetClient) Flush(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string) (result StorageTargetFlushFuture, err error)

Flush tells the cache to write all dirty data to the Storage Target's backend storage. Client requests to this storage target's namespace will return errors until the flush operation completes. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. storageTargetName - name of Storage Target.

func (StorageTargetClient) FlushPreparer 

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

FlushPreparer prepares the Flush request.

func (StorageTargetClient) FlushResponder 

func (client StorageTargetClient) FlushResponder(resp *http.Response) (result autorest.Response, err error)

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

func (StorageTargetClient) FlushSender 

func (client StorageTargetClient) FlushSender(req *http.Request) (future StorageTargetFlushFuture, err error)

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

func (StorageTargetClient) Resume 

func (client StorageTargetClient) Resume(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string) (result StorageTargetResumeFuture, err error)

Resume resumes client access to a previously suspended storage target. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. storageTargetName - name of Storage Target.

func (StorageTargetClient) ResumePreparer 

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

ResumePreparer prepares the Resume request.

func (StorageTargetClient) ResumeResponder 

func (client StorageTargetClient) ResumeResponder(resp *http.Response) (result autorest.Response, err error)

ResumeResponder handles the response to the Resume request. The method always closes the http.Response Body.

func (StorageTargetClient) ResumeSender 

func (client StorageTargetClient) ResumeSender(req *http.Request) (future StorageTargetResumeFuture, err error)

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

func (StorageTargetClient) Suspend 

func (client StorageTargetClient) Suspend(ctx context.Context, resourceGroupName string, cacheName string, storageTargetName string) (result StorageTargetSuspendFuture, err error)

Suspend suspends client access to a storage target. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. storageTargetName - name of Storage Target.

func (StorageTargetClient) SuspendPreparer 

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

SuspendPreparer prepares the Suspend request.

func (StorageTargetClient) SuspendResponder 

func (client StorageTargetClient) SuspendResponder(resp *http.Response) (result autorest.Response, err error)

SuspendResponder handles the response to the Suspend request. The method always closes the http.Response Body.

func (StorageTargetClient) SuspendSender 

func (client StorageTargetClient) SuspendSender(req *http.Request) (future StorageTargetSuspendFuture, err error)

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

type StorageTargetFlushFuture 

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

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

func (*StorageTargetFlushFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

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', 'StorageTargetTypeBlobNfs'
	TargetType StorageTargetType `json:"targetType,omitempty"`
	// ProvisioningState - READ-ONLY; ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property. Possible values include: 'ProvisioningStateTypeSucceeded', 'ProvisioningStateTypeFailed', 'ProvisioningStateTypeCancelled', 'ProvisioningStateTypeCreating', 'ProvisioningStateTypeDeleting', 'ProvisioningStateTypeUpdating'
	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"`
	// BlobNfs - Properties when targetType is blobNfs.
	BlobNfs *BlobNfsTarget `json:"blobNfs,omitempty"`
}

StorageTargetProperties properties of the Storage Target.

func (StorageTargetProperties) MarshalJSON 

func (stp StorageTargetProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageTargetProperties.

type StorageTargetResource 

type StorageTargetResource struct {
	// 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"`
	// Location - READ-ONLY; Region name string.
	Location *string `json:"location,omitempty"`
	// SystemData - READ-ONLY; The system meta data relating to this resource.
	SystemData *SystemData `json:"systemData,omitempty"`
}

StorageTargetResource resource used by a Cache.

func (StorageTargetResource) MarshalJSON 

func (str StorageTargetResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for StorageTargetResource.

type StorageTargetResumeFuture 

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

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

func (*StorageTargetResumeFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type StorageTargetSuspendFuture 

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

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

func (*StorageTargetSuspendFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type StorageTargetType 

type StorageTargetType string

StorageTargetType enumerates the values for storage target type. 

const (
	// StorageTargetTypeBlobNfs ...
	StorageTargetTypeBlobNfs StorageTargetType = "blobNfs"
	// 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. storageTargetName - name of 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) DNSRefresh 

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

DNSRefresh tells a storage target to refresh its DNS information. Parameters: resourceGroupName - target resource group. cacheName - name of Cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. storageTargetName - name of Storage Target.

func (StorageTargetsClient) DNSRefreshPreparer 

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

DNSRefreshPreparer prepares the DNSRefresh request.

func (StorageTargetsClient) DNSRefreshResponder 

func (client StorageTargetsClient) DNSRefreshResponder(resp *http.Response) (result autorest.Response, err error)

DNSRefreshResponder handles the response to the DNSRefresh request. The method always closes the http.Response Body.

func (StorageTargetsClient) DNSRefreshSender 

func (client StorageTargetsClient) DNSRefreshSender(req *http.Request) (future StorageTargetsDNSRefreshFuture, err error)

DNSRefreshSender sends the DNSRefresh 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, force 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. storageTargetName - name of Storage Target. force - boolean value requesting the force delete operation for a storage target. Force delete discards unwritten-data in the cache instead of flushing it to back-end storage.

func (StorageTargetsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (StorageTargetsClient) DeleteResponder 

func (client StorageTargetsClient) DeleteResponder(resp *http.Response) (result autorest.Response, 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class. storageTargetName - name of 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. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

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 StorageTargetsDNSRefreshFuture 

type StorageTargetsDNSRefreshFuture 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) (autorest.Response, error)
}

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

func (*StorageTargetsDNSRefreshFuture) UnmarshalJSON 

func (future *StorageTargetsDNSRefreshFuture) 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) (autorest.Response, 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 

func (iter StorageTargetsResultIterator) Response() StorageTargetsResult

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

func (StorageTargetsResultIterator) Value 

func (iter StorageTargetsResultIterator) Value() StorageTarget

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 

func (page StorageTargetsResultPage) Response() StorageTargetsResult

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 SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of resource last modification (UTC)
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type UnknownTarget 

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

UnknownTarget properties pertaining to the UnknownTarget

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 

func (iter UsageModelsResultIterator) Response() UsageModelsResult

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

func (UsageModelsResultIterator) Value 

func (iter UsageModelsResultIterator) Value() UsageModel

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.

type UsernameDownloadedType 

type UsernameDownloadedType string

UsernameDownloadedType enumerates the values for username downloaded type. 

const (
	// UsernameDownloadedTypeError ...
	UsernameDownloadedTypeError UsernameDownloadedType = "Error"
	// UsernameDownloadedTypeNo ...
	UsernameDownloadedTypeNo UsernameDownloadedType = "No"
	// UsernameDownloadedTypeYes ...
	UsernameDownloadedTypeYes UsernameDownloadedType = "Yes"
)

func PossibleUsernameDownloadedTypeValues 

func PossibleUsernameDownloadedTypeValues() []UsernameDownloadedType

PossibleUsernameDownloadedTypeValues returns an array of possible values for the UsernameDownloadedType const type.

type UsernameSource 

type UsernameSource string

UsernameSource enumerates the values for username source. 

const (
	// UsernameSourceAD ...
	UsernameSourceAD UsernameSource = "AD"
	// UsernameSourceFile ...
	UsernameSourceFile UsernameSource = "File"
	// UsernameSourceLDAP ...
	UsernameSourceLDAP UsernameSource = "LDAP"
	// UsernameSourceNone ...
	UsernameSourceNone UsernameSource = "None"
)

func PossibleUsernameSourceValues 

func PossibleUsernameSourceValues() []UsernameSource

PossibleUsernameSourceValues returns an array of possible values for the UsernameSource const type.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.