Documentation ¶
Overview ¶
Package redis implements the Azure ARM Redis service API version 2017-10-01.
REST API for Azure Redis Cache Service.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AccessKeys
- type BaseClient
- type Client
- func (client Client) Create(ctx context.Context, resourceGroupName string, name string, ...) (result RedisCreateFuture, err error)
- func (client Client) CreatePreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client Client) CreateResponder(resp *http.Response) (result ResourceType, err error)
- func (client Client) CreateSender(req *http.Request) (future RedisCreateFuture, err error)
- func (client Client) Delete(ctx context.Context, resourceGroupName string, name string) (result RedisDeleteFuture, err error)
- func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
- func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) DeleteSender(req *http.Request) (future RedisDeleteFuture, err error)
- func (client Client) ExportData(ctx context.Context, resourceGroupName string, name string, ...) (result RedisExportDataFuture, err error)
- func (client Client) ExportDataPreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client Client) ExportDataResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) ExportDataSender(req *http.Request) (future RedisExportDataFuture, err error)
- func (client Client) ForceReboot(ctx context.Context, resourceGroupName string, name string, ...) (result ForceRebootResponse, err error)
- func (client Client) ForceRebootPreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client Client) ForceRebootResponder(resp *http.Response) (result ForceRebootResponse, err error)
- func (client Client) ForceRebootSender(req *http.Request) (*http.Response, error)
- func (client Client) Get(ctx context.Context, resourceGroupName string, name string) (result ResourceType, err error)
- func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
- func (client Client) GetResponder(resp *http.Response) (result ResourceType, err error)
- func (client Client) GetSender(req *http.Request) (*http.Response, error)
- func (client Client) ImportData(ctx context.Context, resourceGroupName string, name string, ...) (result RedisImportDataFuture, err error)
- func (client Client) ImportDataPreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client Client) ImportDataResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) ImportDataSender(req *http.Request) (future RedisImportDataFuture, err error)
- func (client Client) List(ctx context.Context) (result ListResultPage, err error)
- func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResultPage, err error)
- func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListResultIterator, err error)
- func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client Client) ListComplete(ctx context.Context) (result ListResultIterator, err error)
- func (client Client) ListKeys(ctx context.Context, resourceGroupName string, name string) (result AccessKeys, err error)
- func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
- func (client Client) ListKeysResponder(resp *http.Response) (result AccessKeys, err error)
- func (client Client) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client Client) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client Client) ListResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListSender(req *http.Request) (*http.Response, error)
- func (client Client) RegenerateKey(ctx context.Context, resourceGroupName string, name string, ...) (result AccessKeys, err error)
- func (client Client) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client Client) RegenerateKeyResponder(resp *http.Response) (result AccessKeys, err error)
- func (client Client) RegenerateKeySender(req *http.Request) (*http.Response, error)
- func (client Client) Update(ctx context.Context, resourceGroupName string, name string, ...) (result ResourceType, err error)
- func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client Client) UpdateResponder(resp *http.Response) (result ResourceType, err error)
- func (client Client) UpdateSender(req *http.Request) (*http.Response, error)
- type CommonProperties
- type CreateParameters
- type CreateProperties
- type DayOfWeek
- type ExportRDBParameters
- type FirewallRule
- type FirewallRuleCreateParameters
- type FirewallRuleListResult
- type FirewallRuleListResultIterator
- type FirewallRuleListResultPage
- type FirewallRuleProperties
- type FirewallRulesClient
- func (client FirewallRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, cacheName string, ...) (result FirewallRule, err error)
- func (client FirewallRulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, cacheName string, ...) (*http.Request, error)
- func (client FirewallRulesClient) CreateOrUpdateResponder(resp *http.Response) (result FirewallRule, err error)
- func (client FirewallRulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client FirewallRulesClient) Delete(ctx context.Context, resourceGroupName string, cacheName string, ...) (result autorest.Response, err error)
- func (client FirewallRulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, cacheName string, ...) (*http.Request, error)
- func (client FirewallRulesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client FirewallRulesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client FirewallRulesClient) Get(ctx context.Context, resourceGroupName string, cacheName string, ...) (result FirewallRule, err error)
- func (client FirewallRulesClient) GetPreparer(ctx context.Context, resourceGroupName string, cacheName string, ...) (*http.Request, error)
- func (client FirewallRulesClient) GetResponder(resp *http.Response) (result FirewallRule, err error)
- func (client FirewallRulesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client FirewallRulesClient) ListByRedisResource(ctx context.Context, resourceGroupName string, cacheName string) (result FirewallRuleListResultPage, err error)
- func (client FirewallRulesClient) ListByRedisResourceComplete(ctx context.Context, resourceGroupName string, cacheName string) (result FirewallRuleListResultIterator, err error)
- func (client FirewallRulesClient) ListByRedisResourcePreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)
- func (client FirewallRulesClient) ListByRedisResourceResponder(resp *http.Response) (result FirewallRuleListResult, err error)
- func (client FirewallRulesClient) ListByRedisResourceSender(req *http.Request) (*http.Response, error)
- type ForceRebootResponse
- type ImportRDBParameters
- type KeyType
- type LinkedServer
- type LinkedServerClient
- func (client LinkedServerClient) Create(ctx context.Context, resourceGroupName string, name string, ...) (result LinkedServerCreateFuture, err error)
- func (client LinkedServerClient) CreatePreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client LinkedServerClient) CreateResponder(resp *http.Response) (result LinkedServerWithProperties, err error)
- func (client LinkedServerClient) CreateSender(req *http.Request) (future LinkedServerCreateFuture, err error)
- func (client LinkedServerClient) Delete(ctx context.Context, resourceGroupName string, name string, ...) (result autorest.Response, err error)
- func (client LinkedServerClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client LinkedServerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client LinkedServerClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client LinkedServerClient) Get(ctx context.Context, resourceGroupName string, name string, ...) (result LinkedServerWithProperties, err error)
- func (client LinkedServerClient) GetPreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client LinkedServerClient) GetResponder(resp *http.Response) (result LinkedServerWithProperties, err error)
- func (client LinkedServerClient) GetSender(req *http.Request) (*http.Response, error)
- func (client LinkedServerClient) List(ctx context.Context, resourceGroupName string, name string) (result LinkedServerWithPropertiesListPage, err error)
- func (client LinkedServerClient) ListComplete(ctx context.Context, resourceGroupName string, name string) (result LinkedServerWithPropertiesListIterator, err error)
- func (client LinkedServerClient) ListPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
- func (client LinkedServerClient) ListResponder(resp *http.Response) (result LinkedServerWithPropertiesList, err error)
- func (client LinkedServerClient) ListSender(req *http.Request) (*http.Response, error)
- type LinkedServerCreateFuture
- type LinkedServerCreateParameters
- type LinkedServerCreateProperties
- type LinkedServerProperties
- type LinkedServerWithProperties
- type LinkedServerWithPropertiesList
- type LinkedServerWithPropertiesListIterator
- func (iter *LinkedServerWithPropertiesListIterator) Next() error
- func (iter LinkedServerWithPropertiesListIterator) NotDone() bool
- func (iter LinkedServerWithPropertiesListIterator) Response() LinkedServerWithPropertiesList
- func (iter LinkedServerWithPropertiesListIterator) Value() LinkedServerWithProperties
- type LinkedServerWithPropertiesListPage
- type ListResult
- type ListResultIterator
- type ListResultPage
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationListResultIterator
- type OperationListResultPage
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type PatchSchedule
- type PatchSchedulesClient
- func (client PatchSchedulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, ...) (result PatchSchedule, err error)
- func (client PatchSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, ...) (*http.Request, error)
- func (client PatchSchedulesClient) CreateOrUpdateResponder(resp *http.Response) (result PatchSchedule, err error)
- func (client PatchSchedulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client PatchSchedulesClient) Delete(ctx context.Context, resourceGroupName string, name string) (result autorest.Response, err error)
- func (client PatchSchedulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
- func (client PatchSchedulesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client PatchSchedulesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client PatchSchedulesClient) Get(ctx context.Context, resourceGroupName string, name string) (result PatchSchedule, err error)
- func (client PatchSchedulesClient) GetPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
- func (client PatchSchedulesClient) GetResponder(resp *http.Response) (result PatchSchedule, err error)
- func (client PatchSchedulesClient) GetSender(req *http.Request) (*http.Response, error)
- type Properties
- type ProxyResource
- type RebootParameters
- type RebootType
- type RedisCreateFuture
- type RedisDeleteFuture
- type RedisExportDataFuture
- type RedisImportDataFuture
- type RegenerateKeyParameters
- type ReplicationRole
- type Resource
- type ResourceType
- type ScheduleEntries
- type ScheduleEntry
- type Sku
- type SkuFamily
- type SkuName
- type TrackedResource
- type UpdateParameters
- type UpdateProperties
Constants ¶
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 - 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 ¶
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 NewClientWithBaseURI ¶
NewClientWithBaseURI creates an instance of the Client client.
func (Client) Create ¶
func (client Client) Create(ctx context.Context, resourceGroupName string, name string, parameters CreateParameters) (result RedisCreateFuture, err error)
Create create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
resourceGroupName is the name of the resource group. name is the name of the Redis cache. parameters is 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 RedisCreateFuture, 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 RedisDeleteFuture, 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 ¶
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 RedisDeleteFuture, 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 RedisExportDataFuture, err error)
ExportData export data from the redis cache to blobs in a container.
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) 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 ¶
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 RedisExportDataFuture, 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.
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 ForceRebootResponse, err error)
ForceRebootResponder handles the response to the ForceReboot request. The method always closes the http.Response Body.
func (Client) ForceRebootSender ¶
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 ¶
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 RedisImportDataFuture, err error)
ImportData import data into Redis cache.
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) 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 ¶
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 RedisImportDataFuture, 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.
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 ¶
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.
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 AccessKeys, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
func (Client) ListKeysSender ¶
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (Client) ListPreparer ¶
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 ¶
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.
resourceGroupName is the name of the resource group. name is the name of the Redis cache. parameters is 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 ¶
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.
resourceGroupName is the name of the resource group. name is the name of the Redis cache. parameters is 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.
type CommonProperties ¶
type CommonProperties 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,omitempty"` // EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled. EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"` // TenantSettings - A dictionary of tenant settings 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"` }
CommonProperties create/Update/Get common properties of the redis cache.
type CreateParameters ¶
type CreateParameters struct { // CreateProperties - Redis cache properties. *CreateProperties `json:"properties,omitempty"` // Zones - A list of availability zones denoting where the resource needs to come from. Zones *[]string `json:"zones,omitempty"` // Location - The geo-location where the resource lives Location *string `json:"location,omitempty"` // Tags - Resource tags. Tags *map[string]*string `json:"tags,omitempty"` }
CreateParameters parameters supplied to the Create Redis operation.
func (*CreateParameters) UnmarshalJSON ¶
func (cp *CreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateParameters struct.
type CreateProperties ¶
type CreateProperties 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,omitempty"` // EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled. EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"` // TenantSettings - A dictionary of tenant settings 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"` // Sku - The SKU of the Redis cache to deploy. Sku *Sku `json:"sku,omitempty"` // SubnetID - The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/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.
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" )
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:"-"` // ID - Resource ID. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,omitempty"` // FirewallRuleProperties - redis cache firewall rule properties *FirewallRuleProperties `json:"properties,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) UnmarshalJSON ¶
func (fr *FirewallRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FirewallRule struct.
type FirewallRuleCreateParameters ¶
type FirewallRuleCreateParameters struct { // FirewallRuleProperties - Properties required to create a firewall rule . *FirewallRuleProperties `json:"properties,omitempty"` }
FirewallRuleCreateParameters parameters required for creating a firewall rule on redis cache.
func (*FirewallRuleCreateParameters) UnmarshalJSON ¶
func (frcp *FirewallRuleCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FirewallRuleCreateParameters struct.
type FirewallRuleListResult ¶
type FirewallRuleListResult struct { autorest.Response `json:"-"` // Value - Results of the list firewall rules operation. Value *[]FirewallRule `json:"value,omitempty"` // NextLink - 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.
type FirewallRuleListResultIterator ¶
type FirewallRuleListResultIterator struct {
// contains filtered or unexported fields
}
FirewallRuleListResultIterator provides access to a complete listing of FirewallRule values.
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.
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 (*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.
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.
func (FirewallRulesClient) CreateOrUpdate ¶
func (client FirewallRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, cacheName string, ruleName string, parameters FirewallRuleCreateParameters) (result FirewallRule, err error)
CreateOrUpdate create or update a redis cache firewall rule
resourceGroupName is the name of the resource group. cacheName is the name of the Redis cache. ruleName is the name of the firewall rule. parameters is 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 FirewallRuleCreateParameters) (*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 ¶
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.
resourceGroupName is the name of the resource group. cacheName is the name of the Redis cache. ruleName is 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 ¶
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.
resourceGroupName is the name of the resource group. cacheName is the name of the Redis cache. ruleName is 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 ¶
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.
resourceGroupName is the name of the resource group. cacheName is 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 - Status message Message *string `json:"message,omitempty"` }
ForceRebootResponse response to force reboot for Redis cache.
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 LinkedServer ¶
type LinkedServer struct { // ID - Linked server Id. ID *string `json:"id,omitempty"` }
LinkedServer linked server Id
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.
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).
resourceGroupName is the name of the resource group. name is the name of the Redis cache. linkedServerName is the name of the linked server that is being added to the Redis cache. parameters is 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).
resourceGroupName is the name of the resource group. name is the name of the redis cache. linkedServerName is 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 ¶
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).
resourceGroupName is the name of the resource group. name is the name of the redis cache. linkedServerName is 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 ¶
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 LinkedServerWithPropertiesListPage, err error)
List gets the list of linked servers associated with this redis cache (requires Premium SKU).
resourceGroupName is the name of the resource group. name is the name of the redis cache.
func (LinkedServerClient) ListComplete ¶
func (client LinkedServerClient) ListComplete(ctx context.Context, resourceGroupName string, name string) (result LinkedServerWithPropertiesListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type LinkedServerCreateFuture ¶
LinkedServerCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (LinkedServerCreateFuture) Result ¶
func (future LinkedServerCreateFuture) Result(client LinkedServerClient) (lswp LinkedServerWithProperties, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
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) 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 LinkedServerProperties ¶
type LinkedServerProperties 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"` // ProvisioningState - Terminal state of the link between primary and secondary redis cache. ProvisioningState *string `json:"provisioningState,omitempty"` }
LinkedServerProperties properties of a linked server to be returned in get/put response
type LinkedServerWithProperties ¶
type LinkedServerWithProperties 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"` // LinkedServerProperties - Properties of the linked server. *LinkedServerProperties `json:"properties,omitempty"` }
LinkedServerWithProperties response to put/get linked server (with properties) for Redis cache.
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 properites) of a Redis cache. Value *[]LinkedServerWithProperties `json:"value,omitempty"` // NextLink - Link for next set. NextLink *string `json:"nextLink,omitempty"` }
LinkedServerWithPropertiesList list of linked servers (with properites) of a Redis cache.
func (LinkedServerWithPropertiesList) IsEmpty ¶
func (lswpl LinkedServerWithPropertiesList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type LinkedServerWithPropertiesListIterator ¶
type LinkedServerWithPropertiesListIterator struct {
// contains filtered or unexported fields
}
LinkedServerWithPropertiesListIterator provides access to a complete listing of LinkedServerWithProperties values.
func (*LinkedServerWithPropertiesListIterator) Next ¶
func (iter *LinkedServerWithPropertiesListIterator) 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 (LinkedServerWithPropertiesListIterator) NotDone ¶
func (iter LinkedServerWithPropertiesListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (LinkedServerWithPropertiesListIterator) Response ¶
func (iter LinkedServerWithPropertiesListIterator) Response() LinkedServerWithPropertiesList
Response returns the raw server response from the last page request.
func (LinkedServerWithPropertiesListIterator) Value ¶
func (iter LinkedServerWithPropertiesListIterator) Value() LinkedServerWithProperties
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type LinkedServerWithPropertiesListPage ¶
type LinkedServerWithPropertiesListPage struct {
// contains filtered or unexported fields
}
LinkedServerWithPropertiesListPage contains a page of LinkedServerWithProperties values.
func (*LinkedServerWithPropertiesListPage) Next ¶
func (page *LinkedServerWithPropertiesListPage) 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 (LinkedServerWithPropertiesListPage) NotDone ¶
func (page LinkedServerWithPropertiesListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (LinkedServerWithPropertiesListPage) Response ¶
func (page LinkedServerWithPropertiesListPage) Response() LinkedServerWithPropertiesList
Response returns the raw server response from the last page request.
func (LinkedServerWithPropertiesListPage) Values ¶
func (page LinkedServerWithPropertiesListPage) Values() []LinkedServerWithProperties
Values returns the slice of values for the current page or nil if there are no values.
type ListResult ¶
type ListResult struct { autorest.Response `json:"-"` // Value - List of Redis cache instances. 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 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 - 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.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
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.
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 (*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.
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.
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 ¶
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 ¶
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 - Resource ID. ID *string `json:"id,omitempty"` // Name - Resource name. Name *string `json:"name,omitempty"` // Type - Resource type. Type *string `json:"type,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) 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.
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).
resourceGroupName is the name of the resource group. name is the name of the Redis cache. parameters is 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 ¶
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).
resourceGroupName is the name of the resource group. name is 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 ¶
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).
resourceGroupName is the name of the resource group. name is 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.
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,omitempty"` // EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled. EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"` // TenantSettings - A dictionary of tenant settings 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"` // Sku - The SKU of the Redis cache to deploy. Sku *Sku `json:"sku,omitempty"` // SubnetID - The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/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"` // RedisVersion - Redis version. RedisVersion *string `json:"redisVersion,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 - 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 - List of the linked servers associated with the cache LinkedServers *[]LinkedServer `json:"linkedServers,omitempty"` }
Properties properties of the redis cache.
type ProxyResource ¶
type ProxyResource 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"` }
ProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags
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" )
type RedisCreateFuture ¶
RedisCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (RedisCreateFuture) Result ¶
func (future RedisCreateFuture) Result(client Client) (rt ResourceType, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type RedisDeleteFuture ¶
RedisDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RedisExportDataFuture ¶
RedisExportDataFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type RedisImportDataFuture ¶
RedisImportDataFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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" )
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"` }
Resource the Resource definition.
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"` // Tags - Resource tags. Tags *map[string]*string `json:"tags,omitempty"` // Location - The geo-location where the resource lives Location *string `json:"location,omitempty"` // Properties - Redis cache properties. *Properties `json:"properties,omitempty"` // Zones - A list of availability zones denoting where the resource needs to come from. Zones *[]string `json:"zones,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 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 TrackedResource ¶
type TrackedResource 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"` // Tags - Resource tags. Tags *map[string]*string `json:"tags,omitempty"` // Location - The geo-location where the resource lives Location *string `json:"location,omitempty"` }
TrackedResource the resource model definition for a ARM tracked top level resource
type UpdateParameters ¶
type UpdateParameters struct { // UpdateProperties - Redis cache properties. *UpdateProperties `json:"properties,omitempty"` // Tags - Resource tags. Tags *map[string]*string `json:"tags,omitempty"` }
UpdateParameters parameters supplied to the Update Redis operation.
func (*UpdateParameters) UnmarshalJSON ¶
func (up *UpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UpdateParameters struct.
type UpdateProperties ¶
type UpdateProperties 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,omitempty"` // EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled. EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"` // TenantSettings - A dictionary of tenant settings 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"` // Sku - The SKU of the Redis cache to deploy. Sku *Sku `json:"sku,omitempty"` }
UpdateProperties patchable properties of the redis cache.