redis

package
v5.0.0-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Oct 5, 2016 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package redis implements the Azure ARM Redis service API version 2016-04-01.

REST API for Azure Redis Cache Service

Index

Constants

View Source 
const (
	// APIVersion is the version of the Redis
	APIVersion = "2016-04-01"

	// 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   *string `json:"primaryKey,omitempty"`
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

AccessKeys is redis cache access keys.

type Client 

type Client struct {
	ManagementClient
}

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(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(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(resourceGroupName string, name string) (result autorest.Response, err error)

Delete deletes a redis cache. This operation takes a while to complete.

resourceGroupName is the name of the resource group. name is the name of the redis cache.

func (Client) DeletePreparer 

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

func (client Client) Export(resourceGroupName string, name string, parameters ExportRDBParameters, cancel <-chan struct{}) (result autorest.Response, err error)

Export import data into redis cache. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. name is the name of the redis cache. parameters is parameters for redis export operation.

func (Client) ExportPreparer 

func (client Client) ExportPreparer(resourceGroupName string, name string, parameters ExportRDBParameters, cancel <-chan struct{}) (*http.Request, error)

ExportPreparer prepares the Export request.

func (Client) ExportResponder 

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

ExportResponder handles the response to the Export request. The method always closes the http.Response Body.

func (Client) ExportSender 

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

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

func (Client) ForceReboot 

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

func (client Client) Import(resourceGroupName string, name string, parameters ImportRDBParameters, cancel <-chan struct{}) (result autorest.Response, err error)

Import import data into redis cache. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group. name is the name of the redis cache. parameters is parameters for redis import operation.

func (Client) ImportPreparer 

func (client Client) ImportPreparer(resourceGroupName string, name string, parameters ImportRDBParameters, cancel <-chan struct{}) (*http.Request, error)

ImportPreparer prepares the Import request.

func (Client) ImportResponder 

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

ImportResponder handles the response to the Import request. The method always closes the http.Response Body.

func (Client) ImportSender 

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

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

func (Client) List 

func (client Client) List() (result ListResult, err error)

List gets all redis caches in the specified subscription.

func (Client) ListByResourceGroup 

func (client Client) ListByResourceGroup(resourceGroupName string) (result ListResult, err error)

ListByResourceGroup gets all redis caches in a resource group.

resourceGroupName is the name of the resource group.

func (Client) ListByResourceGroupNextResults 

func (client Client) ListByResourceGroupNextResults(lastResults ListResult) (result ListResult, err error)

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (Client) ListByResourceGroupPreparer 

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

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

func (client Client) ListNextResults(lastResults ListResult) (result ListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (Client) ListPreparer 

func (client Client) ListPreparer() (*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(resourceGroupName string, name string, parameters RegenerateKeyParameters) (result ListKeysResult, err error)

RegenerateKey regenerate 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. parameters is specifies which key to reset.

func (Client) RegenerateKeyPreparer 

func (client Client) RegenerateKeyPreparer(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         *string             `json:"id,omitempty"`
	Name       *string             `json:"name,omitempty"`
	Type       *string             `json:"type,omitempty"`
	Location   *string             `json:"location,omitempty"`
	Tags       *map[string]*string `json:"tags,omitempty"`
	Properties *Properties         `json:"properties,omitempty"`
}

CreateOrUpdateParameters is parameters supplied to the CreateOrUpdate Redis operation.

type DayOfWeek 

type DayOfWeek string

DayOfWeek enumerates the values for day of week. 

const (
	// Friday specifies the friday state for day of week.
	Friday DayOfWeek = "Friday"
	// Monday specifies the monday state for day of week.
	Monday DayOfWeek = "Monday"
	// Saturday specifies the saturday state for day of week.
	Saturday DayOfWeek = "Saturday"
	// Sunday specifies the sunday state for day of week.
	Sunday DayOfWeek = "Sunday"
	// Thursday specifies the thursday state for day of week.
	Thursday DayOfWeek = "Thursday"
	// Tuesday specifies the tuesday state for day of week.
	Tuesday DayOfWeek = "Tuesday"
	// Wednesday specifies the wednesday state for day of week.
	Wednesday DayOfWeek = "Wednesday"
)

type ExportRDBParameters 

type ExportRDBParameters struct {
	Format    *string `json:"format,omitempty"`
	Prefix    *string `json:"prefix,omitempty"`
	Container *string `json:"container,omitempty"`
}

ExportRDBParameters is parameters for redis export operation.

type ImportRDBParameters 

type ImportRDBParameters struct {
	Format *string   `json:"format,omitempty"`
	Files  *[]string `json:"files,omitempty"`
}

ImportRDBParameters is parameters for redis import operation.

type KeyType 

type KeyType string

KeyType enumerates the values for key type. 

const (
	// Primary specifies the primary state for key type.
	Primary KeyType = "Primary"
	// Secondary specifies the secondary state for key type.
	Secondary KeyType = "Secondary"
)

type ListKeysResult 

type ListKeysResult struct {
	autorest.Response `json:"-"`
	PrimaryKey        *string `json:"primaryKey,omitempty"`
	SecondaryKey      *string `json:"secondaryKey,omitempty"`
}

ListKeysResult is the response of redis list keys operation.

type ListResult 

type ListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ResourceType `json:"value,omitempty"`
	NextLink          *string         `json:"nextLink,omitempty"`
}

ListResult is the response of list redis operation.

func (ListResult) ListResultPreparer 

func (client ListResult) ListResultPreparer() (*http.Request, error)

ListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Redis.

func New 

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type PatchSchedulesClient 

type PatchSchedulesClient struct {
	ManagementClient
}

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.

func (PatchSchedulesClient) CreateOrUpdate 

func (client PatchSchedulesClient) CreateOrUpdate(resourceGroupName string, name string, parameters PatchSchedulesRequest) (result PatchSchedulesResponse, err error)

CreateOrUpdate create or replace the patching schedule for redis cache.

resourceGroupName is the name of the resource group. name is the name of the redis cache. parameters is parameters to set patch schedules for redis cache.

func (PatchSchedulesClient) CreateOrUpdatePreparer 

func (client PatchSchedulesClient) CreateOrUpdatePreparer(resourceGroupName string, name string, parameters PatchSchedulesRequest) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PatchSchedulesClient) CreateOrUpdateResponder 

func (client PatchSchedulesClient) CreateOrUpdateResponder(resp *http.Response) (result PatchSchedulesResponse, 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(resourceGroupName string, name string) (result autorest.Response, err error)

Delete deletes the patching schedule for redis cache.

resourceGroupName is the name of the resource group. name is the name of the redis cache.

func (PatchSchedulesClient) DeletePreparer 

func (client PatchSchedulesClient) DeletePreparer(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(resourceGroupName string, name string) (result PatchSchedulesResponse, err error)

Get gets the patching schedule for redis cache.

resourceGroupName is the name of the resource group. name is the name of the redis cache.

func (PatchSchedulesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PatchSchedulesClient) GetResponder 

func (client PatchSchedulesClient) GetResponder(resp *http.Response) (result PatchSchedulesResponse, 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 PatchSchedulesRequest 

type PatchSchedulesRequest struct {
	Properties *ScheduleEntries `json:"properties,omitempty"`
}

PatchSchedulesRequest is parameters to set patch schedules for redis cache.

type PatchSchedulesResponse 

type PatchSchedulesResponse struct {
	autorest.Response `json:"-"`
	ID                *string          `json:"id,omitempty"`
	Name              *string          `json:"name,omitempty"`
	Type              *string          `json:"type,omitempty"`
	Location          *string          `json:"location,omitempty"`
	Properties        *ScheduleEntries `json:"properties,omitempty"`
}

PatchSchedulesResponse is response to put/get patch schedules for redis cache.

type Properties 

type Properties struct {
	RedisVersion       *string             `json:"redisVersion,omitempty"`
	Sku                *Sku                `json:"sku,omitempty"`
	RedisConfiguration *map[string]*string `json:"redisConfiguration,omitempty"`
	EnableNonSslPort   *bool               `json:"enableNonSslPort,omitempty"`
	TenantSettings     *map[string]*string `json:"tenantSettings,omitempty"`
	ShardCount         *int32              `json:"shardCount,omitempty"`
	SubnetID           *string             `json:"subnetId,omitempty"`
	StaticIP           *string             `json:"staticIP,omitempty"`
}

Properties is properties supplied to CreateOrUpdate redis operation.

type ReadableProperties 

type ReadableProperties struct {
	RedisVersion       *string             `json:"redisVersion,omitempty"`
	Sku                *Sku                `json:"sku,omitempty"`
	RedisConfiguration *map[string]*string `json:"redisConfiguration,omitempty"`
	EnableNonSslPort   *bool               `json:"enableNonSslPort,omitempty"`
	TenantSettings     *map[string]*string `json:"tenantSettings,omitempty"`
	ShardCount         *int32              `json:"shardCount,omitempty"`
	SubnetID           *string             `json:"subnetId,omitempty"`
	StaticIP           *string             `json:"staticIP,omitempty"`
	ProvisioningState  *string             `json:"provisioningState,omitempty"`
	HostName           *string             `json:"hostName,omitempty"`
	Port               *int32              `json:"port,omitempty"`
	SslPort            *int32              `json:"sslPort,omitempty"`
}

ReadableProperties is parameters describing a redis instance

type ReadablePropertiesWithAccessKey 

type ReadablePropertiesWithAccessKey struct {
	RedisVersion       *string             `json:"redisVersion,omitempty"`
	Sku                *Sku                `json:"sku,omitempty"`
	RedisConfiguration *map[string]*string `json:"redisConfiguration,omitempty"`
	EnableNonSslPort   *bool               `json:"enableNonSslPort,omitempty"`
	TenantSettings     *map[string]*string `json:"tenantSettings,omitempty"`
	ShardCount         *int32              `json:"shardCount,omitempty"`
	SubnetID           *string             `json:"subnetId,omitempty"`
	StaticIP           *string             `json:"staticIP,omitempty"`
	ProvisioningState  *string             `json:"provisioningState,omitempty"`
	HostName           *string             `json:"hostName,omitempty"`
	Port               *int32              `json:"port,omitempty"`
	SslPort            *int32              `json:"sslPort,omitempty"`
	AccessKeys         *AccessKeys         `json:"accessKeys,omitempty"`
}

ReadablePropertiesWithAccessKey is properties generated only in response to CreateOrUpdate redis operation.

type RebootParameters 

type RebootParameters struct {
	RebootType RebootType `json:"rebootType,omitempty"`
	ShardID    *int32     `json:"shardId,omitempty"`
}

RebootParameters is specifies which redis node(s) to reboot.

type RebootType 

type RebootType string

RebootType enumerates the values for reboot type. 

const (
	// AllNodes specifies the all nodes state for reboot type.
	AllNodes RebootType = "AllNodes"
	// PrimaryNode specifies the primary node state for reboot type.
	PrimaryNode RebootType = "PrimaryNode"
	// SecondaryNode specifies the secondary node state for reboot type.
	SecondaryNode RebootType = "SecondaryNode"
)

type RegenerateKeyParameters 

type RegenerateKeyParameters struct {
	KeyType KeyType `json:"keyType,omitempty"`
}

RegenerateKeyParameters is specifies which redis access keys to reset.

type Resource 

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

Resource is

type ResourceType 

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

ResourceType is a single redis item in List or Get Operation.

type ResourceWithAccessKey 

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

ResourceWithAccessKey is a redis item in CreateOrUpdate Operation response.

type ScheduleEntries 

type ScheduleEntries struct {
	ScheduleEntriesProperty *[]ScheduleEntry `json:"scheduleEntries,omitempty"`
}

ScheduleEntries is list of patch schedules for redis cache.

type ScheduleEntry 

type ScheduleEntry struct {
	DayOfWeek         DayOfWeek `json:"dayOfWeek,omitempty"`
	StartHourUtc      *int32    `json:"startHourUtc,omitempty"`
	MaintenanceWindow *string   `json:"maintenanceWindow,omitempty"`
}

ScheduleEntry is

type Sku 

type Sku struct {
	Name     SkuName   `json:"name,omitempty"`
	Family   SkuFamily `json:"family,omitempty"`
	Capacity *int32    `json:"capacity,omitempty"`
}

Sku is sku parameters supplied to the create redis operation.

type SkuFamily 

type SkuFamily string

SkuFamily enumerates the values for sku family. 

const (
	// C specifies the c state for sku family.
	C SkuFamily = "C"
	// P specifies the p state for sku family.
	P SkuFamily = "P"
)

type SkuName 

type SkuName string

SkuName enumerates the values for sku name. 

const (
	// Basic specifies the basic state for sku name.
	Basic SkuName = "Basic"
	// Premium specifies the premium state for sku name.
	Premium SkuName = "Premium"
	// Standard specifies the standard state for sku name.
	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.