redis

package
v2.1.1-beta+incompatible Latest Latest
Warning

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

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

Documentation

Overview

Package redis implements the Azure ARM Redis service API version 2015-08-01.

.Net client wrapper for the REST API for Azure Redis Cache Management Service

Index

Constants

View Source
const (
	// APIVersion is the version of the Redis
	APIVersion = "2015-08-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 .Net client wrapper for the REST API for Azure Redis Cache Management 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) 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) 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 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
	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.

func (ManagementClient) CreateOrUpdate

func (client ManagementClient) 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 (ManagementClient) CreateOrUpdatePreparer

func (client ManagementClient) CreateOrUpdatePreparer(resourceGroupName string, name string, parameters CreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ManagementClient) CreateOrUpdateResponder

func (client ManagementClient) 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 (ManagementClient) CreateOrUpdateSender

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

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

func (client ManagementClient) DeletePreparer(resourceGroupName string, name string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ManagementClient) DeleteResponder

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

func (client ManagementClient) 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 (ManagementClient) Get

func (client ManagementClient) 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 (ManagementClient) GetPreparer

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

GetPreparer prepares the Get request.

func (ManagementClient) GetResponder

func (client ManagementClient) 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 (ManagementClient) GetSender

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

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

List gets all redis caches in the specified subscription.

func (ManagementClient) ListByResourceGroup

func (client ManagementClient) 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 (ManagementClient) ListByResourceGroupNextResults

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

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (ManagementClient) ListByResourceGroupPreparer

func (client ManagementClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ManagementClient) ListByResourceGroupResponder

func (client ManagementClient) 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 (ManagementClient) ListByResourceGroupSender

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

func (client ManagementClient) 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 (ManagementClient) ListKeysPreparer

func (client ManagementClient) ListKeysPreparer(resourceGroupName string, name string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (ManagementClient) ListKeysResponder

func (client ManagementClient) 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 (ManagementClient) ListKeysSender

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

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

ListNextResults retrieves the next set of results, if any.

func (ManagementClient) ListPreparer

func (client ManagementClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (ManagementClient) ListResponder

func (client ManagementClient) 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 (ManagementClient) ListSender

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

func (client ManagementClient) 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 (ManagementClient) RegenerateKeyPreparer

func (client ManagementClient) RegenerateKeyPreparer(resourceGroupName string, name string, parameters RegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (ManagementClient) RegenerateKeyResponder

func (client ManagementClient) 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 (ManagementClient) RegenerateKeySender

func (client ManagementClient) 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 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"`
	VirtualNetwork     *string             `json:"virtualNetwork,omitempty"`
	Subnet             *string             `json:"subnet,omitempty"`
	StaticIP           *string             `json:"staticIP,omitempty"`
}

Properties is parameters supplied to CreateOrUpdate redis operation.

type ReadableProperties

type ReadableProperties struct {
	ProvisioningState  *string             `json:"provisioningState,omitempty"`
	HostName           *string             `json:"hostName,omitempty"`
	Port               *int32              `json:"port,omitempty"`
	SslPort            *int32              `json:"sslPort,omitempty"`
	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"`
	VirtualNetwork     *string             `json:"virtualNetwork,omitempty"`
	Subnet             *string             `json:"subnet,omitempty"`
	StaticIP           *string             `json:"staticIP,omitempty"`
}

ReadableProperties is parameters describing a redis instance

type ReadablePropertiesWithAccessKey

type ReadablePropertiesWithAccessKey struct {
	AccessKeys         *AccessKeys         `json:"accessKeys,omitempty"`
	ProvisioningState  *string             `json:"provisioningState,omitempty"`
	HostName           *string             `json:"hostName,omitempty"`
	Port               *int32              `json:"port,omitempty"`
	SslPort            *int32              `json:"sslPort,omitempty"`
	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"`
	VirtualNetwork     *string             `json:"virtualNetwork,omitempty"`
	Subnet             *string             `json:"subnet,omitempty"`
	StaticIP           *string             `json:"staticIP,omitempty"`
}

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

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

type SubResource

type SubResource struct {
	ID *string `json:"id,omitempty"`
}

SubResource is

Jump to

Keyboard shortcuts

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