redis

package
v12.5.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package redis implements the Azure ARM Redis service API version 2015-08-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 {
	// PrimaryKey - The current primary key that clients can use to authenticate with Redis cache.
	PrimaryKey *string `json:"primaryKey,omitempty"`
	// SecondaryKey - The current secondary key that clients can use to authenticate with Redis cache.
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

AccessKeys redis cache access keys.

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.

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.

func (Client) CreateOrUpdate 

func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, parameters CreateOrUpdateParameters) (result ResourceWithAccessKey, err error)

CreateOrUpdate create a Redis cache, or replace (overwrite/recreate, with potential downtime) an existing cache.

resourceGroupName is the name of the resource group. name is the name of the Redis cache. parameters is parameters supplied to the CreateOrUpdate Redis operation.

func (Client) CreateOrUpdatePreparer 

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

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder 

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result ResourceWithAccessKey, err error)

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

func (Client) CreateOrUpdateSender 

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

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

Delete deletes a Redis cache.

resourceGroupName is the name of the resource group. name is 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) (*http.Response, error)

DeleteSender sends the Delete 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 autorest.Response, err error)

ForceReboot reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.

resourceGroupName is the name of the resource group. name is the name of the Redis cache. parameters is 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 autorest.Response, 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).

resourceGroupName is the name of the resource group. name is 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) 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 gets all Redis caches in a resource group.

resourceGroupName is 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 ListKeysResult, err error)

ListKeys retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.

resourceGroupName is the name of the resource group. name is 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 ListKeysResult, 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 ListKeysResult, err error)

RegenerateKey regenerate the access keys for a Redis cache. This operation requires write permission to the cache resource.

resourceGroupName is the name of the resource group. name is the name of the Redis cache. parameters is specifies which key to reset.

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 ListKeysResult, 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.

type CreateOrUpdateParameters 

type CreateOrUpdateParameters struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags *map[string]*string `json:"tags,omitempty"`
	// Properties - Redis cache properties.
	*Properties `json:"properties,omitempty"`
}

CreateOrUpdateParameters parameters supplied to the CreateOrUpdate Redis operation.

func (*CreateOrUpdateParameters) UnmarshalJSON 

func (coup *CreateOrUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreateOrUpdateParameters struct.

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

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

type ListKeysResult 

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

ListKeysResult the response of Redis list keys operation.

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	// Value - Results of the list operation.
	Value *[]ResourceType `json:"value,omitempty"`
	// NextLink - 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.

type ListResultIterator 

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

ListResultIterator provides access to a complete listing of ResourceType values.

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.

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 (*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.

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 Properties 

type Properties struct {
	// RedisVersion - RedisVersion parameter has been deprecated. As such, it is no longer necessary to provide this parameter and any value specified is ignored.
	RedisVersion *string `json:"redisVersion,omitempty"`
	// Sku - What SKU of 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,omitempty"`
	// EnableNonSslPort - If the value is true, then the non-SLL Redis server port (6379) will be enabled.
	EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
	// TenantSettings - tenantSettings
	TenantSettings *map[string]*string `json:"tenantSettings,omitempty"`
	// ShardCount - The number of shards to be created on a Premium Cluster Cache.
	ShardCount *int32 `json:"shardCount,omitempty"`
	// VirtualNetwork - The exact ARM resource ID of the virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1
	VirtualNetwork *string `json:"virtualNetwork,omitempty"`
	// Subnet - Required when deploying a Redis cache inside an existing Azure Virtual Network.
	Subnet *string `json:"subnet,omitempty"`
	// StaticIP - Required when deploying a Redis cache inside an existing Azure Virtual Network.
	StaticIP *string `json:"staticIP,omitempty"`
}

Properties parameters supplied to CreateOrUpdate Redis operation.

type ReadableProperties 

type ReadableProperties struct {
	// RedisVersion - RedisVersion parameter has been deprecated. As such, it is no longer necessary to provide this parameter and any value specified is ignored.
	RedisVersion *string `json:"redisVersion,omitempty"`
	// Sku - What SKU of 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,omitempty"`
	// EnableNonSslPort - If the value is true, then the non-SLL Redis server port (6379) will be enabled.
	EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
	// TenantSettings - tenantSettings
	TenantSettings *map[string]*string `json:"tenantSettings,omitempty"`
	// ShardCount - The number of shards to be created on a Premium Cluster Cache.
	ShardCount *int32 `json:"shardCount,omitempty"`
	// VirtualNetwork - The exact ARM resource ID of the virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1
	VirtualNetwork *string `json:"virtualNetwork,omitempty"`
	// Subnet - Required when deploying a Redis cache inside an existing Azure Virtual Network.
	Subnet *string `json:"subnet,omitempty"`
	// StaticIP - Required when deploying a Redis cache inside an existing Azure Virtual Network.
	StaticIP *string `json:"staticIP,omitempty"`
	// ProvisioningState - Redis instance provisioning status.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// HostName - Redis host name.
	HostName *string `json:"hostName,omitempty"`
	// Port - Redis non-SSL port.
	Port *int32 `json:"port,omitempty"`
	// SslPort - Redis SSL port.
	SslPort *int32 `json:"sslPort,omitempty"`
}

ReadableProperties parameters describing a Redis instance

type ReadablePropertiesWithAccessKey 

type ReadablePropertiesWithAccessKey struct {
	// RedisVersion - RedisVersion parameter has been deprecated. As such, it is no longer necessary to provide this parameter and any value specified is ignored.
	RedisVersion *string `json:"redisVersion,omitempty"`
	// Sku - What SKU of 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,omitempty"`
	// EnableNonSslPort - If the value is true, then the non-SLL Redis server port (6379) will be enabled.
	EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
	// TenantSettings - tenantSettings
	TenantSettings *map[string]*string `json:"tenantSettings,omitempty"`
	// ShardCount - The number of shards to be created on a Premium Cluster Cache.
	ShardCount *int32 `json:"shardCount,omitempty"`
	// VirtualNetwork - The exact ARM resource ID of the virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1
	VirtualNetwork *string `json:"virtualNetwork,omitempty"`
	// Subnet - Required when deploying a Redis cache inside an existing Azure Virtual Network.
	Subnet *string `json:"subnet,omitempty"`
	// StaticIP - Required when deploying a Redis cache inside an existing Azure Virtual Network.
	StaticIP *string `json:"staticIP,omitempty"`
	// ProvisioningState - Redis instance provisioning status.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// HostName - Redis host name.
	HostName *string `json:"hostName,omitempty"`
	// Port - Redis non-SSL port.
	Port *int32 `json:"port,omitempty"`
	// SslPort - Redis SSL port.
	SslPort *int32 `json:"sslPort,omitempty"`
	// AccessKeys - Redis cache access keys.
	AccessKeys *AccessKeys `json:"accessKeys,omitempty"`
}

ReadablePropertiesWithAccessKey properties generated only in response to CreateOrUpdate Redis operation.

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 shared 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"
)

type RegenerateKeyParameters 

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

RegenerateKeyParameters specifies which Redis access keys to reset.

type Resource 

type Resource struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags *map[string]*string `json:"tags,omitempty"`
}

Resource ...

type ResourceType 

type ResourceType struct {
	autorest.Response `json:"-"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags *map[string]*string `json:"tags,omitempty"`
	// ReadableProperties - Redis cache properties.
	*ReadableProperties `json:"properties,omitempty"`
}

ResourceType a single Redis item in List or Get Operation.

func (*ResourceType) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for ResourceType struct.

type ResourceWithAccessKey 

type ResourceWithAccessKey struct {
	autorest.Response `json:"-"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags *map[string]*string `json:"tags,omitempty"`
	// ReadablePropertiesWithAccessKey - Redis cache properties.
	*ReadablePropertiesWithAccessKey `json:"properties,omitempty"`
}

ResourceWithAccessKey a Redis item in CreateOrUpdate Operation response.

func (*ResourceWithAccessKey) UnmarshalJSON 

func (rwak *ResourceWithAccessKey) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceWithAccessKey struct.

type Sku 

type Sku struct {
	// Name - What type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). Possible values include: 'Basic', 'Standard', 'Premium'
	Name SkuName `json:"name,omitempty"`
	// Family - Which family to use. Valid values: (C, P). Possible values include: 'C', 'P'
	Family SkuFamily `json:"family,omitempty"`
	// Capacity - What size of Redis cache to deploy. Valid values: for C family (0, 1, 2, 3, 4, 5, 6), for P 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"
)

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"
)

Source Files

View all Source files

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.