redis

package
v67.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 16, 2022 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redis/armredis(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redis/armredis). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package redis implements the Azure ARM Redis service API version 2017-02-01.

REST API for Azure Redis Cache Service.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Redis
	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 AccessKeys 

type AccessKeys struct {
	autorest.Response `json:"-"`
	// PrimaryKey - READ-ONLY; The current primary key that clients can use to authenticate with Redis cache.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - READ-ONLY; The current secondary key that clients can use to authenticate with Redis cache.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

AccessKeys redis cache access keys.

func (AccessKeys) MarshalJSON 

func (ak AccessKeys) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccessKeys.

type BaseClient 

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

BaseClient is the base client for Redis.

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 Client 

type Client struct {
	BaseClient
}

Client is the REST API for Azure Redis Cache Service.

func NewClient 

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client 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 (Client) Create 

func (client Client) Create(ctx context.Context, resourceGroupName string, name string, parameters CreateParameters) (result CreateFuture, err error)

Create create or replace (overwrite/recreate, with potential downtime) an existing Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters supplied to the Create Redis operation.

func (Client) CreatePreparer 

func (client Client) CreatePreparer(ctx context.Context, resourceGroupName string, name string, parameters CreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (Client) CreateResponder 

func (client Client) CreateResponder(resp *http.Response) (result ResourceType, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (Client) CreateSender 

func (client Client) CreateSender(req *http.Request) (future CreateFuture, err error)

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

func (Client) Delete 

func (client Client) Delete(ctx context.Context, resourceGroupName string, name string) (result DeleteFuture, err error)

Delete deletes a Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache.

func (Client) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder 

func (client Client) 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 (Client) DeleteSender 

func (client Client) DeleteSender(req *http.Request) (future DeleteFuture, err error)

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

func (Client) ExportData 

func (client Client) ExportData(ctx context.Context, resourceGroupName string, name string, parameters ExportRDBParameters) (result ExportDataFuture, err error)

ExportData export data from the redis cache to blobs in a container. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters for Redis export operation.

func (Client) ExportDataPreparer 

func (client Client) ExportDataPreparer(ctx context.Context, resourceGroupName string, name string, parameters ExportRDBParameters) (*http.Request, error)

ExportDataPreparer prepares the ExportData request.

func (Client) ExportDataResponder 

func (client Client) ExportDataResponder(resp *http.Response) (result autorest.Response, err error)

ExportDataResponder handles the response to the ExportData request. The method always closes the http.Response Body.

func (Client) ExportDataSender 

func (client Client) ExportDataSender(req *http.Request) (future ExportDataFuture, err error)

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

func (Client) ForceReboot 

func (client Client) ForceReboot(ctx context.Context, resourceGroupName string, name string, parameters RebootParameters) (result ForceRebootResponse, err error)

ForceReboot reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - specifies which Redis node(s) to reboot.

func (Client) ForceRebootPreparer 

func (client Client) ForceRebootPreparer(ctx context.Context, resourceGroupName string, name string, parameters RebootParameters) (*http.Request, error)

ForceRebootPreparer prepares the ForceReboot request.

func (Client) ForceRebootResponder 

func (client Client) ForceRebootResponder(resp *http.Response) (result ForceRebootResponse, err error)

ForceRebootResponder handles the response to the ForceReboot request. The method always closes the http.Response Body.

func (Client) ForceRebootSender 

func (client Client) ForceRebootSender(req *http.Request) (*http.Response, error)

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

func (Client) Get 

func (client Client) Get(ctx context.Context, resourceGroupName string, name string) (result ResourceType, err error)

Get gets a Redis cache (resource description). Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache.

func (Client) GetPreparer 

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

GetPreparer prepares the Get request.

func (Client) GetResponder 

func (client Client) GetResponder(resp *http.Response) (result ResourceType, err error)

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

func (Client) GetSender 

func (client Client) 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 (Client) ImportData 

func (client Client) ImportData(ctx context.Context, resourceGroupName string, name string, parameters ImportRDBParameters) (result ImportDataFuture, err error)

ImportData import data into Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters for Redis import operation.

func (Client) ImportDataPreparer 

func (client Client) ImportDataPreparer(ctx context.Context, resourceGroupName string, name string, parameters ImportRDBParameters) (*http.Request, error)

ImportDataPreparer prepares the ImportData request.

func (Client) ImportDataResponder 

func (client Client) ImportDataResponder(resp *http.Response) (result autorest.Response, err error)

ImportDataResponder handles the response to the ImportData request. The method always closes the http.Response Body.

func (Client) ImportDataSender 

func (client Client) ImportDataSender(req *http.Request) (future ImportDataFuture, err error)

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

func (Client) List 

func (client Client) List(ctx context.Context) (result ListResultPage, err error)

List gets all Redis caches in the specified subscription.

func (Client) ListByResourceGroup 

func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResultPage, err error)

ListByResourceGroup lists all Redis caches in a resource group. Parameters: resourceGroupName - the name of the resource group.

func (Client) ListByResourceGroupComplete 

func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListResultIterator, err error)

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

func (Client) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder 

func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)

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

func (Client) ListByResourceGroupSender 

func (client Client) 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 (Client) ListComplete 

func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)

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

func (Client) ListKeys 

func (client Client) ListKeys(ctx context.Context, resourceGroupName string, name string) (result AccessKeys, err error)

ListKeys retrieve a Redis cache's access keys. This operation requires write permission to the cache resource. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache.

func (Client) ListKeysPreparer 

func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (Client) ListKeysResponder 

func (client Client) ListKeysResponder(resp *http.Response) (result AccessKeys, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (Client) ListKeysSender 

func (client Client) ListKeysSender(req *http.Request) (*http.Response, error)

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

func (Client) ListPreparer 

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

ListPreparer prepares the List request.

func (Client) ListResponder 

func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)

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

func (Client) ListSender 

func (client Client) 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 (Client) RegenerateKey 

func (client Client) RegenerateKey(ctx context.Context, resourceGroupName string, name string, parameters RegenerateKeyParameters) (result AccessKeys, err error)

RegenerateKey regenerate Redis cache's access keys. This operation requires write permission to the cache resource. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - specifies which key to regenerate.

func (Client) RegenerateKeyPreparer 

func (client Client) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, name string, parameters RegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (Client) RegenerateKeyResponder 

func (client Client) RegenerateKeyResponder(resp *http.Response) (result AccessKeys, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (Client) RegenerateKeySender 

func (client Client) RegenerateKeySender(req *http.Request) (*http.Response, error)

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

func (Client) Update 

func (client Client) Update(ctx context.Context, resourceGroupName string, name string, parameters UpdateParameters) (result ResourceType, err error)

Update update an existing Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters supplied to the Update Redis operation.

func (Client) UpdatePreparer 

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters UpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder 

func (client Client) UpdateResponder(resp *http.Response) (result ResourceType, err error)

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

func (Client) UpdateSender 

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

type CreateFuture 

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

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

func (*CreateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CreateParameters 

type CreateParameters struct {
	// CreateProperties - Redis cache properties.
	*CreateProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

CreateParameters parameters supplied to the Create Redis operation.

func (CreateParameters) MarshalJSON 

func (cp CreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateParameters.

func (*CreateParameters) UnmarshalJSON 

func (cp *CreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreateParameters struct.

type CreateProperties 

type CreateProperties struct {
	// Sku - The SKU of the Redis cache to deploy.
	Sku *Sku `json:"sku,omitempty"`
	// RedisConfiguration - All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
	RedisConfiguration map[string]*string `json:"redisConfiguration"`
	// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
	EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
	// TenantSettings - tenantSettings
	TenantSettings map[string]*string `json:"tenantSettings"`
	// ShardCount - The number of shards to be created on a Premium Cluster Cache.
	ShardCount *int32 `json:"shardCount,omitempty"`
	// SubnetID - The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
	SubnetID *string `json:"subnetId,omitempty"`
	// StaticIP - Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
	StaticIP *string `json:"staticIP,omitempty"`
}

CreateProperties properties supplied to Create Redis operation.

func (CreateProperties) MarshalJSON 

func (cp CreateProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateProperties.

type DayOfWeek 

type DayOfWeek string

DayOfWeek enumerates the values for day of week. 

const (
	// Everyday ...
	Everyday DayOfWeek = "Everyday"
	// Friday ...
	Friday DayOfWeek = "Friday"
	// Monday ...
	Monday DayOfWeek = "Monday"
	// Saturday ...
	Saturday DayOfWeek = "Saturday"
	// Sunday ...
	Sunday DayOfWeek = "Sunday"
	// Thursday ...
	Thursday DayOfWeek = "Thursday"
	// Tuesday ...
	Tuesday DayOfWeek = "Tuesday"
	// Wednesday ...
	Wednesday DayOfWeek = "Wednesday"
	// Weekend ...
	Weekend DayOfWeek = "Weekend"
)

func PossibleDayOfWeekValues 

func PossibleDayOfWeekValues() []DayOfWeek

PossibleDayOfWeekValues returns an array of possible values for the DayOfWeek const type.

type DeleteFuture 

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

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

func (*DeleteFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ExportDataFuture 

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

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

func (*ExportDataFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ExportRDBParameters 

type ExportRDBParameters struct {
	// Format - File format.
	Format *string `json:"format,omitempty"`
	// Prefix - Prefix to use for exported files.
	Prefix *string `json:"prefix,omitempty"`
	// Container - Container name to export to.
	Container *string `json:"container,omitempty"`
}

ExportRDBParameters parameters for Redis export operation.

type FirewallRule 

type FirewallRule struct {
	autorest.Response `json:"-"`
	// FirewallRuleProperties - redis cache firewall rule properties
	*FirewallRuleProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

FirewallRule a firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect

func (FirewallRule) MarshalJSON 

func (fr FirewallRule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FirewallRule.

func (*FirewallRule) UnmarshalJSON 

func (fr *FirewallRule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for FirewallRule struct.

type FirewallRuleListResult 

type FirewallRuleListResult struct {
	autorest.Response `json:"-"`
	// Value - Results of the list firewall rules operation.
	Value *[]FirewallRule `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link for next set of locations.
	NextLink *string `json:"nextLink,omitempty"`
}

FirewallRuleListResult the response of list firewall rules Redis operation.

func (FirewallRuleListResult) IsEmpty 

func (frlr FirewallRuleListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (FirewallRuleListResult) MarshalJSON 

func (frlr FirewallRuleListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FirewallRuleListResult.

type FirewallRuleListResultIterator 

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

FirewallRuleListResultIterator provides access to a complete listing of FirewallRule values.

func NewFirewallRuleListResultIterator 

func NewFirewallRuleListResultIterator(page FirewallRuleListResultPage) FirewallRuleListResultIterator

Creates a new instance of the FirewallRuleListResultIterator type.

func (*FirewallRuleListResultIterator) Next 

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

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

func (iter FirewallRuleListResultIterator) NotDone() bool

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

func (FirewallRuleListResultIterator) Response 

func (iter FirewallRuleListResultIterator) Response() FirewallRuleListResult

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

func (FirewallRuleListResultIterator) Value 

func (iter FirewallRuleListResultIterator) Value() FirewallRule

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

type FirewallRuleListResultPage 

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

FirewallRuleListResultPage contains a page of FirewallRule values.

func NewFirewallRuleListResultPage 

func NewFirewallRuleListResultPage(cur FirewallRuleListResult, getNextPage func(context.Context, FirewallRuleListResult) (FirewallRuleListResult, error)) FirewallRuleListResultPage

Creates a new instance of the FirewallRuleListResultPage type.

func (*FirewallRuleListResultPage) Next 

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

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

func (page FirewallRuleListResultPage) NotDone() bool

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

func (FirewallRuleListResultPage) Response 

func (page FirewallRuleListResultPage) Response() FirewallRuleListResult

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

func (FirewallRuleListResultPage) Values 

func (page FirewallRuleListResultPage) Values() []FirewallRule

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

type FirewallRuleProperties 

type FirewallRuleProperties struct {
	// StartIP - lowest IP address included in the range
	StartIP *string `json:"startIP,omitempty"`
	// EndIP - highest IP address included in the range
	EndIP *string `json:"endIP,omitempty"`
}

FirewallRuleProperties specifies a range of IP addresses permitted to connect to the cache

type FirewallRulesClient 

type FirewallRulesClient struct {
	BaseClient
}

FirewallRulesClient is the REST API for Azure Redis Cache Service.

func NewFirewallRulesClient 

func NewFirewallRulesClient(subscriptionID string) FirewallRulesClient

NewFirewallRulesClient creates an instance of the FirewallRulesClient client.

func NewFirewallRulesClientWithBaseURI 

func NewFirewallRulesClientWithBaseURI(baseURI string, subscriptionID string) FirewallRulesClient

NewFirewallRulesClientWithBaseURI creates an instance of the FirewallRulesClient 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 (FirewallRulesClient) CreateOrUpdate 

func (client FirewallRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, cacheName string, ruleName string, parameters FirewallRule) (result FirewallRule, err error)

CreateOrUpdate create or update a redis cache firewall rule Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. ruleName - the name of the firewall rule. parameters - parameters supplied to the create or update redis firewall rule operation.

func (FirewallRulesClient) CreateOrUpdatePreparer 

func (client FirewallRulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, cacheName string, ruleName string, parameters FirewallRule) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (FirewallRulesClient) CreateOrUpdateResponder 

func (client FirewallRulesClient) CreateOrUpdateResponder(resp *http.Response) (result FirewallRule, err error)

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

func (FirewallRulesClient) CreateOrUpdateSender 

func (client FirewallRulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (FirewallRulesClient) Delete 

func (client FirewallRulesClient) Delete(ctx context.Context, resourceGroupName string, cacheName string, ruleName string) (result autorest.Response, err error)

Delete deletes a single firewall rule in a specified redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. ruleName - the name of the firewall rule.

func (FirewallRulesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (FirewallRulesClient) DeleteResponder 

func (client FirewallRulesClient) 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 (FirewallRulesClient) DeleteSender 

func (client FirewallRulesClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (FirewallRulesClient) Get 

func (client FirewallRulesClient) Get(ctx context.Context, resourceGroupName string, cacheName string, ruleName string) (result FirewallRule, err error)

Get gets a single firewall rule in a specified redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. ruleName - the name of the firewall rule.

func (FirewallRulesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (FirewallRulesClient) GetResponder 

func (client FirewallRulesClient) GetResponder(resp *http.Response) (result FirewallRule, err error)

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

func (FirewallRulesClient) GetSender 

func (client FirewallRulesClient) 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 (FirewallRulesClient) ListByRedisResource 

func (client FirewallRulesClient) ListByRedisResource(ctx context.Context, resourceGroupName string, cacheName string) (result FirewallRuleListResultPage, err error)

ListByRedisResource gets all firewall rules in the specified redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache.

func (FirewallRulesClient) ListByRedisResourceComplete 

func (client FirewallRulesClient) ListByRedisResourceComplete(ctx context.Context, resourceGroupName string, cacheName string) (result FirewallRuleListResultIterator, err error)

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

func (FirewallRulesClient) ListByRedisResourcePreparer 

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

ListByRedisResourcePreparer prepares the ListByRedisResource request.

func (FirewallRulesClient) ListByRedisResourceResponder 

func (client FirewallRulesClient) ListByRedisResourceResponder(resp *http.Response) (result FirewallRuleListResult, err error)

ListByRedisResourceResponder handles the response to the ListByRedisResource request. The method always closes the http.Response Body.

func (FirewallRulesClient) ListByRedisResourceSender 

func (client FirewallRulesClient) ListByRedisResourceSender(req *http.Request) (*http.Response, error)

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

type ForceRebootResponse 

type ForceRebootResponse struct {
	autorest.Response `json:"-"`
	// Message - READ-ONLY; Status message
	Message *string `json:"Message,omitempty"`
}

ForceRebootResponse response to force reboot for Redis cache.

func (ForceRebootResponse) MarshalJSON 

func (frr ForceRebootResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ForceRebootResponse.

type ImportDataFuture 

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

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

func (*ImportDataFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ImportRDBParameters 

type ImportRDBParameters struct {
	// Format - File format.
	Format *string `json:"format,omitempty"`
	// Files - files to import.
	Files *[]string `json:"files,omitempty"`
}

ImportRDBParameters parameters for Redis import operation.

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

const (
	// Primary ...
	Primary KeyType = "Primary"
	// Secondary ...
	Secondary KeyType = "Secondary"
)

func PossibleKeyTypeValues 

func PossibleKeyTypeValues() []KeyType

PossibleKeyTypeValues returns an array of possible values for the KeyType const type.

type LinkedServer 

type LinkedServer struct {
	// ID - READ-ONLY; Linked server Id.
	ID *string `json:"id,omitempty"`
}

LinkedServer linked server Id

func (LinkedServer) MarshalJSON 

func (ls LinkedServer) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LinkedServer.

type LinkedServerClient 

type LinkedServerClient struct {
	BaseClient
}

LinkedServerClient is the REST API for Azure Redis Cache Service.

func NewLinkedServerClient 

func NewLinkedServerClient(subscriptionID string) LinkedServerClient

NewLinkedServerClient creates an instance of the LinkedServerClient client.

func NewLinkedServerClientWithBaseURI 

func NewLinkedServerClientWithBaseURI(baseURI string, subscriptionID string) LinkedServerClient

NewLinkedServerClientWithBaseURI creates an instance of the LinkedServerClient 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 (LinkedServerClient) Create 

func (client LinkedServerClient) Create(ctx context.Context, resourceGroupName string, name string, linkedServerName string, parameters LinkedServerCreateParameters) (result LinkedServerCreateFuture, err error)

Create adds a linked server to the Redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. linkedServerName - the name of the linked server that is being added to the Redis cache. parameters - parameters supplied to the Create Linked server operation.

func (LinkedServerClient) CreatePreparer 

func (client LinkedServerClient) CreatePreparer(ctx context.Context, resourceGroupName string, name string, linkedServerName string, parameters LinkedServerCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (LinkedServerClient) CreateResponder 

func (client LinkedServerClient) CreateResponder(resp *http.Response) (result LinkedServerWithProperties, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (LinkedServerClient) CreateSender 

func (client LinkedServerClient) CreateSender(req *http.Request) (future LinkedServerCreateFuture, err error)

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

func (LinkedServerClient) Delete 

func (client LinkedServerClient) Delete(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (result autorest.Response, err error)

Delete deletes the linked server from a redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache. linkedServerName - the name of the linked server that is being added to the Redis cache.

func (LinkedServerClient) DeletePreparer 

func (client LinkedServerClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (LinkedServerClient) DeleteResponder 

func (client LinkedServerClient) 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 (LinkedServerClient) DeleteSender 

func (client LinkedServerClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (LinkedServerClient) Get 

func (client LinkedServerClient) Get(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (result LinkedServerWithProperties, err error)

Get gets the detailed information about a linked server of a redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache. linkedServerName - the name of the linked server.

func (LinkedServerClient) GetPreparer 

func (client LinkedServerClient) GetPreparer(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (LinkedServerClient) GetResponder 

func (client LinkedServerClient) GetResponder(resp *http.Response) (result LinkedServerWithProperties, err error)

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

func (LinkedServerClient) GetSender 

func (client LinkedServerClient) 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 (LinkedServerClient) List 

func (client LinkedServerClient) List(ctx context.Context, resourceGroupName string, name string) (result LinkedServerWithPropertiesList, err error)

List gets the list of linked servers associated with this redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache.

func (LinkedServerClient) ListPreparer 

func (client LinkedServerClient) ListPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)

ListPreparer prepares the List request.

func (LinkedServerClient) ListResponder 

func (client LinkedServerClient) ListResponder(resp *http.Response) (result LinkedServerWithPropertiesList, err error)

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

func (LinkedServerClient) ListSender 

func (client LinkedServerClient) 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 LinkedServerCreateFuture 

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

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

func (*LinkedServerCreateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type LinkedServerCreateParameters 

type LinkedServerCreateParameters struct {
	// LinkedServerCreateProperties - Properties required to create a linked server.
	*LinkedServerCreateProperties `json:"properties,omitempty"`
}

LinkedServerCreateParameters parameter required for creating a linked server to redis cache.

func (LinkedServerCreateParameters) MarshalJSON 

func (lscp LinkedServerCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LinkedServerCreateParameters.

func (*LinkedServerCreateParameters) UnmarshalJSON 

func (lscp *LinkedServerCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for LinkedServerCreateParameters struct.

type LinkedServerCreateProperties 

type LinkedServerCreateProperties struct {
	// LinkedRedisCacheID - Fully qualified resourceId of the linked redis cache.
	LinkedRedisCacheID *string `json:"linkedRedisCacheId,omitempty"`
	// LinkedRedisCacheLocation - Location of the linked redis cache.
	LinkedRedisCacheLocation *string `json:"linkedRedisCacheLocation,omitempty"`
	// ServerRole - Role of the linked server. Possible values include: 'ReplicationRolePrimary', 'ReplicationRoleSecondary'
	ServerRole ReplicationRole `json:"serverRole,omitempty"`
}

LinkedServerCreateProperties create properties for a linked server

type LinkedServerList 

type LinkedServerList struct {
	// Value - List of linked server Ids of a Redis cache.
	Value *[]LinkedServer `json:"value,omitempty"`
}

LinkedServerList list of linked server Ids of a Redis cache.

type LinkedServerProperties 

type LinkedServerProperties struct {
	// ProvisioningState - READ-ONLY; Terminal state of the link between primary and secondary redis cache.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// LinkedRedisCacheID - Fully qualified resourceId of the linked redis cache.
	LinkedRedisCacheID *string `json:"linkedRedisCacheId,omitempty"`
	// LinkedRedisCacheLocation - Location of the linked redis cache.
	LinkedRedisCacheLocation *string `json:"linkedRedisCacheLocation,omitempty"`
	// ServerRole - Role of the linked server. Possible values include: 'ReplicationRolePrimary', 'ReplicationRoleSecondary'
	ServerRole ReplicationRole `json:"serverRole,omitempty"`
}

LinkedServerProperties properties of a linked server to be returned in get/put response

func (LinkedServerProperties) MarshalJSON 

func (lsp LinkedServerProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LinkedServerProperties.

type LinkedServerWithProperties 

type LinkedServerWithProperties struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// LinkedServerProperties - Properties of the linked server.
	*LinkedServerProperties `json:"properties,omitempty"`
}

LinkedServerWithProperties response to put/get linked server (with properties) for Redis cache.

func (LinkedServerWithProperties) MarshalJSON 

func (lswp LinkedServerWithProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LinkedServerWithProperties.

func (*LinkedServerWithProperties) UnmarshalJSON 

func (lswp *LinkedServerWithProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for LinkedServerWithProperties struct.

type LinkedServerWithPropertiesList 

type LinkedServerWithPropertiesList struct {
	autorest.Response `json:"-"`
	// Value - List of linked servers (with properties) of a Redis cache.
	Value *[]LinkedServerWithProperties `json:"value,omitempty"`
}

LinkedServerWithPropertiesList list of linked servers (with properties) of a Redis cache.

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	// Value - List of Redis cache instances.
	Value *[]ResourceType `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link for next set of locations.
	NextLink *string `json:"nextLink,omitempty"`
}

ListResult the response of list Redis operation.

func (ListResult) IsEmpty 

func (lr ListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ListResult) MarshalJSON 

func (lr ListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ListResult.

type ListResultIterator 

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

ListResultIterator provides access to a complete listing of ResourceType values.

func NewListResultIterator 

func NewListResultIterator(page ListResultPage) ListResultIterator

Creates a new instance of the ListResultIterator type.

func (*ListResultIterator) Next 

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

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

func (iter ListResultIterator) NotDone() bool

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

func (ListResultIterator) Response 

func (iter ListResultIterator) Response() ListResult

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

func (ListResultIterator) Value 

func (iter ListResultIterator) Value() ResourceType

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

type ListResultPage 

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

ListResultPage contains a page of ResourceType values.

func NewListResultPage 

func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage

Creates a new instance of the ListResultPage type.

func (*ListResultPage) Next 

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

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

func (page ListResultPage) NotDone() bool

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

func (ListResultPage) Response 

func (page ListResultPage) Response() ListResult

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

func (ListResultPage) Values 

func (page ListResultPage) Values() []ResourceType

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

type Operation 

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

Operation REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Friendly name of the resource provider
	Provider *string `json:"provider,omitempty"`
	// Operation - Operation type: read, write, delete, listKeys/action, etc.
	Operation *string `json:"operation,omitempty"`
	// Resource - Resource type on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
	// Description - Friendly name of the operation
	Description *string `json:"description,omitempty"`
}

OperationDisplay the object that describes the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of operations supported by the resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON 

func (olr OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

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

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

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

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

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

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the REST API for Azure Redis Cache Service.

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 OperationListResultPage, err error)

List lists all of the available REST API operations of the Microsoft.Cache provider.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, 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 OperationListResult, 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 PatchSchedule 

type PatchSchedule struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// Location - READ-ONLY; Resource location.
	Location *string `json:"location,omitempty"`
	// ScheduleEntries - List of patch schedules for a Redis cache.
	*ScheduleEntries `json:"properties,omitempty"`
}

PatchSchedule response to put/get patch schedules for Redis cache.

func (PatchSchedule) MarshalJSON 

func (ps PatchSchedule) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PatchSchedule.

func (*PatchSchedule) UnmarshalJSON 

func (ps *PatchSchedule) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PatchSchedule struct.

type PatchSchedulesClient 

type PatchSchedulesClient struct {
	BaseClient
}

PatchSchedulesClient is the REST API for Azure Redis Cache Service.

func NewPatchSchedulesClient 

func NewPatchSchedulesClient(subscriptionID string) PatchSchedulesClient

NewPatchSchedulesClient creates an instance of the PatchSchedulesClient client.

func NewPatchSchedulesClientWithBaseURI 

func NewPatchSchedulesClientWithBaseURI(baseURI string, subscriptionID string) PatchSchedulesClient

NewPatchSchedulesClientWithBaseURI creates an instance of the PatchSchedulesClient 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 (PatchSchedulesClient) CreateOrUpdate 

func (client PatchSchedulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, parameters PatchSchedule) (result PatchSchedule, err error)

CreateOrUpdate create or replace the patching schedule for Redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters to set the patching schedule for Redis cache.

func (PatchSchedulesClient) CreateOrUpdatePreparer 

func (client PatchSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters PatchSchedule) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PatchSchedulesClient) CreateOrUpdateResponder 

func (client PatchSchedulesClient) CreateOrUpdateResponder(resp *http.Response) (result PatchSchedule, err error)

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

func (PatchSchedulesClient) CreateOrUpdateSender 

func (client PatchSchedulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (PatchSchedulesClient) Delete 

func (client PatchSchedulesClient) Delete(ctx context.Context, resourceGroupName string, name string) (result autorest.Response, err error)

Delete deletes the patching schedule of a redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache.

func (PatchSchedulesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (PatchSchedulesClient) DeleteResponder 

func (client PatchSchedulesClient) 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 (PatchSchedulesClient) DeleteSender 

func (client PatchSchedulesClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (PatchSchedulesClient) Get 

func (client PatchSchedulesClient) Get(ctx context.Context, resourceGroupName string, name string) (result PatchSchedule, err error)

Get gets the patching schedule of a redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache.

func (PatchSchedulesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PatchSchedulesClient) GetResponder 

func (client PatchSchedulesClient) GetResponder(resp *http.Response) (result PatchSchedule, err error)

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

func (PatchSchedulesClient) GetSender 

func (client PatchSchedulesClient) 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 Properties 

type Properties struct {
	// RedisConfiguration - All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
	RedisConfiguration map[string]*string `json:"redisConfiguration"`
	// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
	EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
	// TenantSettings - tenantSettings
	TenantSettings map[string]*string `json:"tenantSettings"`
	// ShardCount - The number of shards to be created on a Premium Cluster Cache.
	ShardCount *int32 `json:"shardCount,omitempty"`
	// SubnetID - The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
	SubnetID *string `json:"subnetId,omitempty"`
	// StaticIP - Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
	StaticIP *string `json:"staticIP,omitempty"`
}

Properties properties supplied to Create or Update Redis operation.

func (Properties) MarshalJSON 

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type RebootParameters 

type RebootParameters struct {
	// RebootType - Which Redis node(s) to reboot. Depending on this value data loss is possible. Possible values include: 'PrimaryNode', 'SecondaryNode', 'AllNodes'
	RebootType RebootType `json:"rebootType,omitempty"`
	// ShardID - If clustering is enabled, the ID of the shard to be rebooted.
	ShardID *int32 `json:"shardId,omitempty"`
}

RebootParameters specifies which Redis node(s) to reboot.

type RebootType 

type RebootType string

RebootType enumerates the values for reboot type. 

const (
	// AllNodes ...
	AllNodes RebootType = "AllNodes"
	// PrimaryNode ...
	PrimaryNode RebootType = "PrimaryNode"
	// SecondaryNode ...
	SecondaryNode RebootType = "SecondaryNode"
)

func PossibleRebootTypeValues 

func PossibleRebootTypeValues() []RebootType

PossibleRebootTypeValues returns an array of possible values for the RebootType const type.

type RegenerateKeyParameters 

type RegenerateKeyParameters struct {
	// KeyType - The Redis access key to regenerate. Possible values include: 'Primary', 'Secondary'
	KeyType KeyType `json:"keyType,omitempty"`
}

RegenerateKeyParameters specifies which Redis access keys to reset.

type ReplicationRole 

type ReplicationRole string

ReplicationRole enumerates the values for replication role. 

const (
	// ReplicationRolePrimary ...
	ReplicationRolePrimary ReplicationRole = "Primary"
	// ReplicationRoleSecondary ...
	ReplicationRoleSecondary ReplicationRole = "Secondary"
)

func PossibleReplicationRoleValues 

func PossibleReplicationRoleValues() []ReplicationRole

PossibleReplicationRoleValues returns an array of possible values for the ReplicationRole const type.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

Resource the Resource definition.

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type ResourceProperties 

type ResourceProperties struct {
	// Sku - The SKU of the Redis cache to deploy.
	Sku *Sku `json:"sku,omitempty"`
	// RedisVersion - READ-ONLY; Redis version.
	RedisVersion *string `json:"redisVersion,omitempty"`
	// ProvisioningState - READ-ONLY; Redis instance provisioning status.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// HostName - READ-ONLY; Redis host name.
	HostName *string `json:"hostName,omitempty"`
	// Port - READ-ONLY; Redis non-SSL port.
	Port *int32 `json:"port,omitempty"`
	// SslPort - READ-ONLY; Redis SSL port.
	SslPort *int32 `json:"sslPort,omitempty"`
	// AccessKeys - READ-ONLY; The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
	AccessKeys *AccessKeys `json:"accessKeys,omitempty"`
	// LinkedServers - READ-ONLY; List of the linked servers associated with the cache
	LinkedServers *LinkedServerList `json:"linkedServers,omitempty"`
	// RedisConfiguration - All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
	RedisConfiguration map[string]*string `json:"redisConfiguration"`
	// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
	EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
	// TenantSettings - tenantSettings
	TenantSettings map[string]*string `json:"tenantSettings"`
	// ShardCount - The number of shards to be created on a Premium Cluster Cache.
	ShardCount *int32 `json:"shardCount,omitempty"`
	// SubnetID - The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
	SubnetID *string `json:"subnetId,omitempty"`
	// StaticIP - Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
	StaticIP *string `json:"staticIP,omitempty"`
}

ResourceProperties parameters describing a Redis instance.

func (ResourceProperties) MarshalJSON 

func (rp ResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceProperties.

type ResourceType 

type ResourceType struct {
	autorest.Response `json:"-"`
	// ResourceProperties - Redis cache properties.
	*ResourceProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

ResourceType a single Redis item in List or Get Operation.

func (ResourceType) MarshalJSON 

func (rt ResourceType) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceType.

func (*ResourceType) UnmarshalJSON 

func (rt *ResourceType) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceType struct.

type ScheduleEntries 

type ScheduleEntries struct {
	// ScheduleEntries - List of patch schedules for a Redis cache.
	ScheduleEntries *[]ScheduleEntry `json:"scheduleEntries,omitempty"`
}

ScheduleEntries list of patch schedules for a Redis cache.

type ScheduleEntry 

type ScheduleEntry struct {
	// DayOfWeek - Day of the week when a cache can be patched. Possible values include: 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday', 'Everyday', 'Weekend'
	DayOfWeek DayOfWeek `json:"dayOfWeek,omitempty"`
	// StartHourUtc - Start hour after which cache patching can start.
	StartHourUtc *int32 `json:"startHourUtc,omitempty"`
	// MaintenanceWindow - ISO8601 timespan specifying how much time cache patching can take.
	MaintenanceWindow *string `json:"maintenanceWindow,omitempty"`
}

ScheduleEntry patch schedule entry for a Premium Redis Cache.

type Sku 

type Sku struct {
	// Name - The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). Possible values include: 'Basic', 'Standard', 'Premium'
	Name SkuName `json:"name,omitempty"`
	// Family - The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). Possible values include: 'C', 'P'
	Family SkuFamily `json:"family,omitempty"`
	// Capacity - The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).
	Capacity *int32 `json:"capacity,omitempty"`
}

Sku SKU parameters supplied to the create Redis operation.

type SkuFamily 

type SkuFamily string

SkuFamily enumerates the values for sku family. 

const (
	// C ...
	C SkuFamily = "C"
	// P ...
	P SkuFamily = "P"
)

func PossibleSkuFamilyValues 

func PossibleSkuFamilyValues() []SkuFamily

PossibleSkuFamilyValues returns an array of possible values for the SkuFamily const type.

type SkuName 

type SkuName string

SkuName enumerates the values for sku name. 

const (
	// Basic ...
	Basic SkuName = "Basic"
	// Premium ...
	Premium SkuName = "Premium"
	// Standard ...
	Standard SkuName = "Standard"
)

func PossibleSkuNameValues 

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for a ARM tracked top level resource

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type UpdateParameters 

type UpdateParameters struct {
	// UpdateProperties - Redis cache properties.
	*UpdateProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

UpdateParameters parameters supplied to the Update Redis operation.

func (UpdateParameters) MarshalJSON 

func (up UpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateParameters.

func (*UpdateParameters) UnmarshalJSON 

func (up *UpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UpdateParameters struct.

type UpdateProperties 

type UpdateProperties struct {
	// Sku - The SKU of the Redis cache to deploy.
	Sku *Sku `json:"sku,omitempty"`
	// RedisConfiguration - All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
	RedisConfiguration map[string]*string `json:"redisConfiguration"`
	// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
	EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
	// TenantSettings - tenantSettings
	TenantSettings map[string]*string `json:"tenantSettings"`
	// ShardCount - The number of shards to be created on a Premium Cluster Cache.
	ShardCount *int32 `json:"shardCount,omitempty"`
	// SubnetID - The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
	SubnetID *string `json:"subnetId,omitempty"`
	// StaticIP - Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
	StaticIP *string `json:"staticIP,omitempty"`
}

UpdateProperties properties supplied to Update Redis operation.

func (UpdateProperties) MarshalJSON 

func (up UpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateProperties.

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.