const (
// DefaultBaseURI is the default URI used for the service Redis
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
AccessKeys redis cache access keys.
type AccessKeys struct {
autorest.Response `json:"-"`
// PrimaryKey - READ-ONLY; The current primary key that clients can use to authenticate with Redis cache.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - READ-ONLY; The current secondary key that clients can use to authenticate with Redis cache.
SecondaryKey *string `json:"secondaryKey,omitempty"`
}
func (ak AccessKeys) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AccessKeys.
AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.
type AzureEntityResource struct {
// Etag - READ-ONLY; Resource Etag.
Etag *string `json:"etag,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (aer AzureEntityResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AzureEntityResource.
BaseClient is the base client for Redis.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
CheckNameAvailabilityParameters parameters body to pass for resource name availability check.
type CheckNameAvailabilityParameters struct {
// Name - Resource name.
Name *string `json:"name,omitempty"`
// Type - Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'.
Type *string `json:"type,omitempty"`
}
Client is the REST API for Azure Redis Cache Service.
type Client struct {
BaseClient
}
func NewClient(subscriptionID string) Client
NewClient creates an instance of the Client client.
func NewClientWithBaseURI(baseURI string, subscriptionID string) Client
NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client Client) CheckNameAvailability(ctx context.Context, parameters CheckNameAvailabilityParameters) (result autorest.Response, err error)
CheckNameAvailability checks that the redis cache name is valid and is not already in use. Parameters: parameters - parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'
func (client Client) CheckNameAvailabilityPreparer(ctx context.Context, parameters CheckNameAvailabilityParameters) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (client Client) CheckNameAvailabilityResponder(resp *http.Response) (result autorest.Response, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (client Client) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (client Client) Create(ctx context.Context, resourceGroupName string, name string, parameters CreateParameters) (result CreateFuture, err error)
Create create or replace (overwrite/recreate, with potential downtime) an existing Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters supplied to the Create Redis operation.
func (client Client) CreatePreparer(ctx context.Context, resourceGroupName string, name string, parameters CreateParameters) (*http.Request, error)
CreatePreparer prepares the Create request.
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 Client) CreateSender(req *http.Request) (future CreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client Client) Delete(ctx context.Context, resourceGroupName string, name string) (result DeleteFuture, err error)
Delete deletes a Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache.
func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 Client) DeleteSender(req *http.Request) (future DeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client Client) ExportData(ctx context.Context, resourceGroupName string, name string, parameters ExportRDBParameters) (result ExportDataFuture, err error)
ExportData export data from the redis cache to blobs in a container. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters for Redis export operation.
func (client Client) ExportDataPreparer(ctx context.Context, resourceGroupName string, name string, parameters ExportRDBParameters) (*http.Request, error)
ExportDataPreparer prepares the ExportData request.
func (client Client) ExportDataResponder(resp *http.Response) (result autorest.Response, err error)
ExportDataResponder handles the response to the ExportData request. The method always closes the http.Response Body.
func (client Client) ExportDataSender(req *http.Request) (future ExportDataFuture, err error)
ExportDataSender sends the ExportData request. The method will close the http.Response Body if it receives an error.
func (client Client) ForceReboot(ctx context.Context, resourceGroupName string, name string, parameters RebootParameters) (result ForceRebootResponse, err error)
ForceReboot reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - specifies which Redis node(s) to reboot.
func (client Client) ForceRebootPreparer(ctx context.Context, resourceGroupName string, name string, parameters RebootParameters) (*http.Request, error)
ForceRebootPreparer prepares the ForceReboot request.
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 Client) ForceRebootSender(req *http.Request) (*http.Response, error)
ForceRebootSender sends the ForceReboot request. The method will close the http.Response Body if it receives an error.
func (client Client) Get(ctx context.Context, resourceGroupName string, name string) (result ResourceType, err error)
Get gets a Redis cache (resource description). Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache.
func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
GetPreparer prepares the Get request.
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 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 Client) ImportData(ctx context.Context, resourceGroupName string, name string, parameters ImportRDBParameters) (result ImportDataFuture, err error)
ImportData import data into Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters for Redis import operation.
func (client Client) ImportDataPreparer(ctx context.Context, resourceGroupName string, name string, parameters ImportRDBParameters) (*http.Request, error)
ImportDataPreparer prepares the ImportData request.
func (client Client) ImportDataResponder(resp *http.Response) (result autorest.Response, err error)
ImportDataResponder handles the response to the ImportData request. The method always closes the http.Response Body.
func (client Client) ImportDataSender(req *http.Request) (future ImportDataFuture, err error)
ImportDataSender sends the ImportData request. The method will close the http.Response Body if it receives an error.
func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResultPage, err error)
ListByResourceGroup lists all Redis caches in a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 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 Client) ListBySubscription(ctx context.Context) (result ListResultPage, err error)
ListBySubscription gets all Redis caches in the specified subscription.
func (client Client) ListBySubscriptionComplete(ctx context.Context) (result ListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client Client) ListBySubscriptionResponder(resp *http.Response) (result ListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client Client) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client Client) ListKeys(ctx context.Context, resourceGroupName string, name string) (result AccessKeys, err error)
ListKeys retrieve a Redis cache's access keys. This operation requires write permission to the cache resource. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache.
func (client Client) ListKeysPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
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 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 Client) ListUpgradeNotifications(ctx context.Context, resourceGroupName string, name string, history float64) (result NotificationListResponsePage, err error)
ListUpgradeNotifications gets any upgrade notifications for a Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. history - how many minutes in past to look for upgrade notifications
func (client Client) ListUpgradeNotificationsComplete(ctx context.Context, resourceGroupName string, name string, history float64) (result NotificationListResponseIterator, err error)
ListUpgradeNotificationsComplete enumerates all values, automatically crossing page boundaries as required.
func (client Client) ListUpgradeNotificationsPreparer(ctx context.Context, resourceGroupName string, name string, history float64) (*http.Request, error)
ListUpgradeNotificationsPreparer prepares the ListUpgradeNotifications request.
func (client Client) ListUpgradeNotificationsResponder(resp *http.Response) (result NotificationListResponse, err error)
ListUpgradeNotificationsResponder handles the response to the ListUpgradeNotifications request. The method always closes the http.Response Body.
func (client Client) ListUpgradeNotificationsSender(req *http.Request) (*http.Response, error)
ListUpgradeNotificationsSender sends the ListUpgradeNotifications request. The method will close the http.Response Body if it receives an error.
func (client Client) RegenerateKey(ctx context.Context, resourceGroupName string, name string, parameters RegenerateKeyParameters) (result AccessKeys, err error)
RegenerateKey regenerate Redis cache's access keys. This operation requires write permission to the cache resource. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - specifies which key to regenerate.
func (client Client) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, name string, parameters RegenerateKeyParameters) (*http.Request, error)
RegenerateKeyPreparer prepares the RegenerateKey request.
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 Client) RegenerateKeySender(req *http.Request) (*http.Response, error)
RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.
func (client Client) Update(ctx context.Context, resourceGroupName string, name string, parameters UpdateParameters) (result ResourceType, err error)
Update update an existing Redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters supplied to the Update Redis operation.
func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters UpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client Client) UpdateResponder(resp *http.Response) (result ResourceType, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client Client) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
CommonProperties create/Update/Get common properties of the redis cache.
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"`
// RedisVersion - Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6)
RedisVersion *string `json:"redisVersion,omitempty"`
// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
// ReplicasPerMaster - The number of replicas to be created per primary.
ReplicasPerMaster *int32 `json:"replicasPerMaster,omitempty"`
// ReplicasPerPrimary - The number of replicas to be created per primary.
ReplicasPerPrimary *int32 `json:"replicasPerPrimary,omitempty"`
// TenantSettings - A dictionary of tenant settings
TenantSettings map[string]*string `json:"tenantSettings"`
// ShardCount - The number of shards to be created on a Premium Cluster Cache.
ShardCount *int32 `json:"shardCount,omitempty"`
// MinimumTLSVersion - Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). Possible values include: 'TLSVersionOneFullStopZero', 'TLSVersionOneFullStopOne', 'TLSVersionOneFullStopTwo'
MinimumTLSVersion TLSVersion `json:"minimumTlsVersion,omitempty"`
// PublicNetworkAccess - Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'. Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}
func (cp CommonProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CommonProperties.
CreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (ResourceType, error)
}
func (future *CreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CreateParameters parameters supplied to the Create Redis operation.
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"`
}
func (cp CreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateParameters.
func (cp *CreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CreateParameters struct.
CreateProperties properties supplied to Create Redis operation.
type CreateProperties struct {
// 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/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
SubnetID *string `json:"subnetId,omitempty"`
// StaticIP - Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
StaticIP *string `json:"staticIP,omitempty"`
// 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"`
// RedisVersion - Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6)
RedisVersion *string `json:"redisVersion,omitempty"`
// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
// ReplicasPerMaster - The number of replicas to be created per primary.
ReplicasPerMaster *int32 `json:"replicasPerMaster,omitempty"`
// ReplicasPerPrimary - The number of replicas to be created per primary.
ReplicasPerPrimary *int32 `json:"replicasPerPrimary,omitempty"`
// TenantSettings - A dictionary of tenant settings
TenantSettings map[string]*string `json:"tenantSettings"`
// ShardCount - The number of shards to be created on a Premium Cluster Cache.
ShardCount *int32 `json:"shardCount,omitempty"`
// MinimumTLSVersion - Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). Possible values include: 'TLSVersionOneFullStopZero', 'TLSVersionOneFullStopOne', 'TLSVersionOneFullStopTwo'
MinimumTLSVersion TLSVersion `json:"minimumTlsVersion,omitempty"`
// PublicNetworkAccess - Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'. Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}
func (cp CreateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CreateProperties.
DayOfWeek enumerates the values for day of week.
type DayOfWeek string
const (
// DayOfWeekEveryday ...
DayOfWeekEveryday DayOfWeek = "Everyday"
// DayOfWeekFriday ...
DayOfWeekFriday DayOfWeek = "Friday"
// DayOfWeekMonday ...
DayOfWeekMonday DayOfWeek = "Monday"
// DayOfWeekSaturday ...
DayOfWeekSaturday DayOfWeek = "Saturday"
// DayOfWeekSunday ...
DayOfWeekSunday DayOfWeek = "Sunday"
// DayOfWeekThursday ...
DayOfWeekThursday DayOfWeek = "Thursday"
// DayOfWeekTuesday ...
DayOfWeekTuesday DayOfWeek = "Tuesday"
// DayOfWeekWednesday ...
DayOfWeekWednesday DayOfWeek = "Wednesday"
// DayOfWeekWeekend ...
DayOfWeekWeekend DayOfWeek = "Weekend"
)
func PossibleDayOfWeekValues() []DayOfWeek
PossibleDayOfWeekValues returns an array of possible values for the DayOfWeek const type.
DeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *DeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ErrorAdditionalInfo the resource management error additional info.
type ErrorAdditionalInfo struct {
// Type - READ-ONLY; The additional info type.
Type *string `json:"type,omitempty"`
// Info - READ-ONLY; The additional info.
Info interface{} `json:"info,omitempty"`
}
func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorAdditionalInfo.
ErrorDetail the error detail.
type ErrorDetail struct {
// Code - READ-ONLY; The error code.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"message,omitempty"`
// Target - READ-ONLY; The error target.
Target *string `json:"target,omitempty"`
// Details - READ-ONLY; The error details.
Details *[]ErrorDetail `json:"details,omitempty"`
// AdditionalInfo - READ-ONLY; The error additional info.
AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}
func (ed ErrorDetail) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDetail.
ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
type ErrorResponse struct {
// Error - The error object.
Error *ErrorDetail `json:"error,omitempty"`
}
ExportDataFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ExportDataFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *ExportDataFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ExportRDBParameters parameters for Redis export operation.
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"`
}
FirewallRule a firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect
type FirewallRule struct {
autorest.Response `json:"-"`
// FirewallRuleProperties - redis cache firewall rule properties
*FirewallRuleProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (fr FirewallRule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FirewallRule.
func (fr *FirewallRule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FirewallRule struct.
FirewallRuleCreateParameters parameters required for creating a firewall rule on redis cache. (Note, you can just use the FirewallRule type instead now.)
type FirewallRuleCreateParameters struct {
// FirewallRuleProperties - redis cache firewall rule properties
*FirewallRuleProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (frcp FirewallRuleCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FirewallRuleCreateParameters.
func (frcp *FirewallRuleCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for FirewallRuleCreateParameters struct.
FirewallRuleListResult the response of list firewall rules Redis operation.
type FirewallRuleListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list firewall rules operation.
Value *[]FirewallRule `json:"value,omitempty"`
// NextLink - READ-ONLY; Link for next page of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (frlr FirewallRuleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (frlr FirewallRuleListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FirewallRuleListResult.
FirewallRuleListResultIterator provides access to a complete listing of FirewallRule values.
type FirewallRuleListResultIterator struct {
// contains filtered or unexported fields
}
func NewFirewallRuleListResultIterator(page FirewallRuleListResultPage) FirewallRuleListResultIterator
Creates a new instance of the FirewallRuleListResultIterator type.
func (iter *FirewallRuleListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *FirewallRuleListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter FirewallRuleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter FirewallRuleListResultIterator) Response() FirewallRuleListResult
Response returns the raw server response from the last page request.
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.
FirewallRuleListResultPage contains a page of FirewallRule values.
type FirewallRuleListResultPage struct {
// contains filtered or unexported fields
}
func NewFirewallRuleListResultPage(cur FirewallRuleListResult, getNextPage func(context.Context, FirewallRuleListResult) (FirewallRuleListResult, error)) FirewallRuleListResultPage
Creates a new instance of the FirewallRuleListResultPage type.
func (page *FirewallRuleListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *FirewallRuleListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page FirewallRuleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page FirewallRuleListResultPage) Response() FirewallRuleListResult
Response returns the raw server response from the last page request.
func (page FirewallRuleListResultPage) Values() []FirewallRule
Values returns the slice of values for the current page or nil if there are no values.
FirewallRuleProperties specifies a range of IP addresses permitted to connect to the cache
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"`
}
FirewallRulesClient is the REST API for Azure Redis Cache Service.
type FirewallRulesClient struct {
BaseClient
}
func NewFirewallRulesClient(subscriptionID string) FirewallRulesClient
NewFirewallRulesClient creates an instance of the FirewallRulesClient client.
func NewFirewallRulesClientWithBaseURI(baseURI string, subscriptionID string) FirewallRulesClient
NewFirewallRulesClientWithBaseURI creates an instance of the FirewallRulesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client FirewallRulesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, cacheName string, ruleName string, parameters FirewallRule) (result FirewallRule, err error)
CreateOrUpdate create or update a redis cache firewall rule Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. ruleName - the name of the firewall rule. parameters - parameters supplied to the create or update redis firewall rule operation.
func (client FirewallRulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, cacheName string, ruleName string, parameters FirewallRule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (client FirewallRulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client FirewallRulesClient) Delete(ctx context.Context, resourceGroupName string, cacheName string, ruleName string) (result autorest.Response, err error)
Delete deletes a single firewall rule in a specified redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. ruleName - the name of the firewall rule.
func (client FirewallRulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, cacheName string, ruleName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client FirewallRulesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client FirewallRulesClient) Get(ctx context.Context, resourceGroupName string, cacheName string, ruleName string) (result FirewallRule, err error)
Get gets a single firewall rule in a specified redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. ruleName - the name of the firewall rule.
func (client FirewallRulesClient) GetPreparer(ctx context.Context, resourceGroupName string, cacheName string, ruleName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client FirewallRulesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client FirewallRulesClient) List(ctx context.Context, resourceGroupName string, cacheName string) (result FirewallRuleListResultPage, err error)
List gets all firewall rules in the specified redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache.
func (client FirewallRulesClient) ListComplete(ctx context.Context, resourceGroupName string, cacheName string) (result FirewallRuleListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client FirewallRulesClient) ListPreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client FirewallRulesClient) ListResponder(resp *http.Response) (result FirewallRuleListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client FirewallRulesClient) 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.
ForceRebootResponse response to force reboot for Redis cache.
type ForceRebootResponse struct {
autorest.Response `json:"-"`
// Message - READ-ONLY; Status message
Message *string `json:"message,omitempty"`
}
func (frr ForceRebootResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ForceRebootResponse.
ImportDataFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImportDataFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(Client) (autorest.Response, error)
}
func (future *ImportDataFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ImportRDBParameters parameters for Redis import operation.
type ImportRDBParameters struct {
// Format - File format.
Format *string `json:"format,omitempty"`
// Files - files to import.
Files *[]string `json:"files,omitempty"`
}
InstanceDetails details of single instance of redis.
type InstanceDetails struct {
// SslPort - READ-ONLY; Redis instance SSL port.
SslPort *int32 `json:"sslPort,omitempty"`
// NonSslPort - READ-ONLY; If enableNonSslPort is true, provides Redis instance Non-SSL port.
NonSslPort *int32 `json:"nonSslPort,omitempty"`
// Zone - READ-ONLY; If the Cache uses availability zones, specifies availability zone where this instance is located.
Zone *string `json:"zone,omitempty"`
// ShardID - READ-ONLY; If clustering is enabled, the Shard ID of Redis Instance
ShardID *int32 `json:"shardId,omitempty"`
// IsMaster - READ-ONLY; Specifies whether the instance is a primary node.
IsMaster *bool `json:"isMaster,omitempty"`
// IsPrimary - READ-ONLY; Specifies whether the instance is a primary node.
IsPrimary *bool `json:"isPrimary,omitempty"`
}
func (ID InstanceDetails) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for InstanceDetails.
KeyType enumerates the values for key type.
type KeyType string
const (
// KeyTypePrimary ...
KeyTypePrimary KeyType = "Primary"
// KeyTypeSecondary ...
KeyTypeSecondary KeyType = "Secondary"
)
func PossibleKeyTypeValues() []KeyType
PossibleKeyTypeValues returns an array of possible values for the KeyType const type.
LinkedServer linked server Id
type LinkedServer struct {
// ID - READ-ONLY; Linked server Id.
ID *string `json:"id,omitempty"`
}
func (ls LinkedServer) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LinkedServer.
LinkedServerClient is the REST API for Azure Redis Cache Service.
type LinkedServerClient struct {
BaseClient
}
func NewLinkedServerClient(subscriptionID string) LinkedServerClient
NewLinkedServerClient creates an instance of the LinkedServerClient client.
func NewLinkedServerClientWithBaseURI(baseURI string, subscriptionID string) LinkedServerClient
NewLinkedServerClientWithBaseURI creates an instance of the LinkedServerClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client LinkedServerClient) Create(ctx context.Context, resourceGroupName string, name string, linkedServerName string, parameters LinkedServerCreateParameters) (result LinkedServerCreateFuture, err error)
Create adds a linked server to the Redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. linkedServerName - the name of the linked server that is being added to the Redis cache. parameters - parameters supplied to the Create Linked server operation.
func (client LinkedServerClient) CreatePreparer(ctx context.Context, resourceGroupName string, name string, linkedServerName string, parameters LinkedServerCreateParameters) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (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 (client LinkedServerClient) Delete(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (result autorest.Response, err error)
Delete deletes the linked server from a redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache. linkedServerName - the name of the linked server that is being added to the Redis cache.
func (client LinkedServerClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client LinkedServerClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client LinkedServerClient) Get(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (result LinkedServerWithProperties, err error)
Get gets the detailed information about a linked server of a redis cache (requires Premium SKU). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache. linkedServerName - the name of the linked server.
func (client LinkedServerClient) GetPreparer(ctx context.Context, resourceGroupName string, name string, linkedServerName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client LinkedServerClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (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). Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache.
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 (client LinkedServerClient) ListPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
ListPreparer prepares the List request.
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 (client LinkedServerClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
LinkedServerCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LinkedServerCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LinkedServerClient) (LinkedServerWithProperties, error)
}
func (future *LinkedServerCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
LinkedServerCreateParameters parameter required for creating a linked server to redis cache.
type LinkedServerCreateParameters struct {
// LinkedServerCreateProperties - Properties required to create a linked server.
*LinkedServerCreateProperties `json:"properties,omitempty"`
}
func (lscp LinkedServerCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LinkedServerCreateParameters.
func (lscp *LinkedServerCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LinkedServerCreateParameters struct.
LinkedServerCreateProperties create properties for a linked server
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"`
}
LinkedServerProperties properties of a linked server to be returned in get/put response
type LinkedServerProperties struct {
// ProvisioningState - READ-ONLY; Terminal state of the link between primary and secondary redis cache.
ProvisioningState *string `json:"provisioningState,omitempty"`
// LinkedRedisCacheID - Fully qualified resourceId of the linked redis cache.
LinkedRedisCacheID *string `json:"linkedRedisCacheId,omitempty"`
// LinkedRedisCacheLocation - Location of the linked redis cache.
LinkedRedisCacheLocation *string `json:"linkedRedisCacheLocation,omitempty"`
// ServerRole - Role of the linked server. Possible values include: 'ReplicationRolePrimary', 'ReplicationRoleSecondary'
ServerRole ReplicationRole `json:"serverRole,omitempty"`
}
func (lsp LinkedServerProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LinkedServerProperties.
LinkedServerWithProperties response to put/get linked server (with properties) for Redis cache.
type LinkedServerWithProperties struct {
autorest.Response `json:"-"`
// LinkedServerProperties - Properties of the linked server.
*LinkedServerProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (lswp LinkedServerWithProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LinkedServerWithProperties.
func (lswp *LinkedServerWithProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LinkedServerWithProperties struct.
LinkedServerWithPropertiesList list of linked servers (with properties) of a Redis cache.
type LinkedServerWithPropertiesList struct {
autorest.Response `json:"-"`
// Value - List of linked servers (with properties) of a Redis cache.
Value *[]LinkedServerWithProperties `json:"value,omitempty"`
// NextLink - READ-ONLY; Link for next set.
NextLink *string `json:"nextLink,omitempty"`
}
func (lswpl LinkedServerWithPropertiesList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (lswpl LinkedServerWithPropertiesList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LinkedServerWithPropertiesList.
LinkedServerWithPropertiesListIterator provides access to a complete listing of LinkedServerWithProperties values.
type LinkedServerWithPropertiesListIterator struct {
// contains filtered or unexported fields
}
func NewLinkedServerWithPropertiesListIterator(page LinkedServerWithPropertiesListPage) LinkedServerWithPropertiesListIterator
Creates a new instance of the LinkedServerWithPropertiesListIterator type.
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. Deprecated: Use NextWithContext() instead.
func (iter *LinkedServerWithPropertiesListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter LinkedServerWithPropertiesListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LinkedServerWithPropertiesListIterator) Response() LinkedServerWithPropertiesList
Response returns the raw server response from the last page request.
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.
LinkedServerWithPropertiesListPage contains a page of LinkedServerWithProperties values.
type LinkedServerWithPropertiesListPage struct {
// contains filtered or unexported fields
}
func NewLinkedServerWithPropertiesListPage(cur LinkedServerWithPropertiesList, getNextPage func(context.Context, LinkedServerWithPropertiesList) (LinkedServerWithPropertiesList, error)) LinkedServerWithPropertiesListPage
Creates a new instance of the LinkedServerWithPropertiesListPage type.
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. Deprecated: Use NextWithContext() instead.
func (page *LinkedServerWithPropertiesListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page LinkedServerWithPropertiesListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LinkedServerWithPropertiesListPage) Response() LinkedServerWithPropertiesList
Response returns the raw server response from the last page request.
func (page LinkedServerWithPropertiesListPage) Values() []LinkedServerWithProperties
Values returns the slice of values for the current page or nil if there are no values.
ListResult the response of list Redis operation.
type ListResult struct {
autorest.Response `json:"-"`
// Value - List of Redis cache instances.
Value *[]ResourceType `json:"value,omitempty"`
// NextLink - READ-ONLY; Link for next page of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (lr ListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (lr ListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListResult.
ListResultIterator provides access to a complete listing of ResourceType values.
type ListResultIterator struct {
// contains filtered or unexported fields
}
func NewListResultIterator(page ListResultPage) ListResultIterator
Creates a new instance of the ListResultIterator type.
func (iter *ListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListResultIterator) Response() ListResult
Response returns the raw server response from the last page request.
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.
ListResultPage contains a page of ResourceType values.
type ListResultPage struct {
// contains filtered or unexported fields
}
func NewListResultPage(cur ListResult, getNextPage func(context.Context, ListResult) (ListResult, error)) ListResultPage
Creates a new instance of the ListResultPage type.
func (page *ListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListResultPage) Response() ListResult
Response returns the raw server response from the last page request.
func (page ListResultPage) Values() []ResourceType
Values returns the slice of values for the current page or nil if there are no values.
NotificationListResponse the response of listUpgradeNotifications.
type NotificationListResponse struct {
autorest.Response `json:"-"`
// Value - List of all notifications.
Value *[]UpgradeNotification `json:"value,omitempty"`
// NextLink - READ-ONLY; Link for next set of notifications.
NextLink *string `json:"nextLink,omitempty"`
}
func (nlr NotificationListResponse) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (nlr NotificationListResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotificationListResponse.
NotificationListResponseIterator provides access to a complete listing of UpgradeNotification values.
type NotificationListResponseIterator struct {
// contains filtered or unexported fields
}
func NewNotificationListResponseIterator(page NotificationListResponsePage) NotificationListResponseIterator
Creates a new instance of the NotificationListResponseIterator type.
func (iter *NotificationListResponseIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *NotificationListResponseIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter NotificationListResponseIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter NotificationListResponseIterator) Response() NotificationListResponse
Response returns the raw server response from the last page request.
func (iter NotificationListResponseIterator) Value() UpgradeNotification
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
NotificationListResponsePage contains a page of UpgradeNotification values.
type NotificationListResponsePage struct {
// contains filtered or unexported fields
}
func NewNotificationListResponsePage(cur NotificationListResponse, getNextPage func(context.Context, NotificationListResponse) (NotificationListResponse, error)) NotificationListResponsePage
Creates a new instance of the NotificationListResponsePage type.
func (page *NotificationListResponsePage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *NotificationListResponsePage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page NotificationListResponsePage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page NotificationListResponsePage) Response() NotificationListResponse
Response returns the raw server response from the last page request.
func (page NotificationListResponsePage) Values() []UpgradeNotification
Values returns the slice of values for the current page or nil if there are no values.
Operation REST API 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"`
}
OperationDisplay the object that describes the operation.
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"`
}
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.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - List of operations supported by the resource provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
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.
OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationsClient is the REST API for Azure Redis Cache Service.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (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 (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
PatchSchedule response to put/get patch schedules for Redis cache.
type PatchSchedule struct {
autorest.Response `json:"-"`
// ScheduleEntries - List of patch schedules for a Redis cache.
*ScheduleEntries `json:"properties,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (ps PatchSchedule) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchSchedule.
func (ps *PatchSchedule) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PatchSchedule struct.
PatchScheduleListResult the response of list patch schedules Redis operation.
type PatchScheduleListResult struct {
autorest.Response `json:"-"`
// Value - Results of the list patch schedules operation.
Value *[]PatchSchedule `json:"value,omitempty"`
// NextLink - READ-ONLY; Link for next page of results.
NextLink *string `json:"nextLink,omitempty"`
}
func (pslr PatchScheduleListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (pslr PatchScheduleListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PatchScheduleListResult.
PatchScheduleListResultIterator provides access to a complete listing of PatchSchedule values.
type PatchScheduleListResultIterator struct {
// contains filtered or unexported fields
}
func NewPatchScheduleListResultIterator(page PatchScheduleListResultPage) PatchScheduleListResultIterator
Creates a new instance of the PatchScheduleListResultIterator type.
func (iter *PatchScheduleListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *PatchScheduleListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter PatchScheduleListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PatchScheduleListResultIterator) Response() PatchScheduleListResult
Response returns the raw server response from the last page request.
func (iter PatchScheduleListResultIterator) Value() PatchSchedule
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PatchScheduleListResultPage contains a page of PatchSchedule values.
type PatchScheduleListResultPage struct {
// contains filtered or unexported fields
}
func NewPatchScheduleListResultPage(cur PatchScheduleListResult, getNextPage func(context.Context, PatchScheduleListResult) (PatchScheduleListResult, error)) PatchScheduleListResultPage
Creates a new instance of the PatchScheduleListResultPage type.
func (page *PatchScheduleListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *PatchScheduleListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page PatchScheduleListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PatchScheduleListResultPage) Response() PatchScheduleListResult
Response returns the raw server response from the last page request.
func (page PatchScheduleListResultPage) Values() []PatchSchedule
Values returns the slice of values for the current page or nil if there are no values.
PatchSchedulesClient is the REST API for Azure Redis Cache Service.
type PatchSchedulesClient struct {
BaseClient
}
func NewPatchSchedulesClient(subscriptionID string) PatchSchedulesClient
NewPatchSchedulesClient creates an instance of the PatchSchedulesClient client.
func NewPatchSchedulesClientWithBaseURI(baseURI string, subscriptionID string) PatchSchedulesClient
NewPatchSchedulesClientWithBaseURI creates an instance of the PatchSchedulesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (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. Parameters: resourceGroupName - the name of the resource group. name - the name of the Redis cache. parameters - parameters to set the patching schedule for Redis cache.
func (client PatchSchedulesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters PatchSchedule) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (client PatchSchedulesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client PatchSchedulesClient) Delete(ctx context.Context, resourceGroupName string, name string) (result autorest.Response, err error)
Delete deletes the patching schedule of a redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache.
func (client PatchSchedulesClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client PatchSchedulesClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client PatchSchedulesClient) Get(ctx context.Context, resourceGroupName string, name string) (result PatchSchedule, err error)
Get gets the patching schedule of a redis cache. Parameters: resourceGroupName - the name of the resource group. name - the name of the redis cache.
func (client PatchSchedulesClient) GetPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PatchSchedulesClient) GetResponder(resp *http.Response) (result PatchSchedule, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PatchSchedulesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client PatchSchedulesClient) ListByRedisResource(ctx context.Context, resourceGroupName string, cacheName string) (result PatchScheduleListResultPage, err error)
ListByRedisResource gets all patch schedules in the specified redis cache (there is only one). Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache.
func (client PatchSchedulesClient) ListByRedisResourceComplete(ctx context.Context, resourceGroupName string, cacheName string) (result PatchScheduleListResultIterator, err error)
ListByRedisResourceComplete enumerates all values, automatically crossing page boundaries as required.
func (client PatchSchedulesClient) ListByRedisResourcePreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)
ListByRedisResourcePreparer prepares the ListByRedisResource request.
func (client PatchSchedulesClient) ListByRedisResourceResponder(resp *http.Response) (result PatchScheduleListResult, err error)
ListByRedisResourceResponder handles the response to the ListByRedisResource request. The method always closes the http.Response Body.
func (client PatchSchedulesClient) 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.
PrivateEndpoint the Private Endpoint resource.
type PrivateEndpoint struct {
// ID - READ-ONLY; The ARM identifier for Private Endpoint
ID *string `json:"id,omitempty"`
}
func (peVar PrivateEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpoint.
PrivateEndpointConnection the Private Endpoint Connection resource.
type PrivateEndpointConnection struct {
autorest.Response `json:"-"`
// PrivateEndpointConnectionProperties - Resource properties.
*PrivateEndpointConnectionProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnection.
func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.
PrivateEndpointConnectionListResult list of private endpoint connection associated with the specified storage account
type PrivateEndpointConnectionListResult struct {
autorest.Response `json:"-"`
// Value - Array of private endpoint connections
Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}
PrivateEndpointConnectionProperties properties of the PrivateEndpointConnectProperties.
type PrivateEndpointConnectionProperties struct {
// PrivateEndpoint - The resource of private end point.
PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
// PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.
PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
// ProvisioningState - The provisioning state of the private endpoint connection resource. Possible values include: 'PrivateEndpointConnectionProvisioningStateSucceeded', 'PrivateEndpointConnectionProvisioningStateCreating', 'PrivateEndpointConnectionProvisioningStateDeleting', 'PrivateEndpointConnectionProvisioningStateFailed'
ProvisioningState PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}
PrivateEndpointConnectionProvisioningState enumerates the values for private endpoint connection provisioning state.
type PrivateEndpointConnectionProvisioningState string
const (
// PrivateEndpointConnectionProvisioningStateCreating ...
PrivateEndpointConnectionProvisioningStateCreating PrivateEndpointConnectionProvisioningState = "Creating"
// PrivateEndpointConnectionProvisioningStateDeleting ...
PrivateEndpointConnectionProvisioningStateDeleting PrivateEndpointConnectionProvisioningState = "Deleting"
// PrivateEndpointConnectionProvisioningStateFailed ...
PrivateEndpointConnectionProvisioningStateFailed PrivateEndpointConnectionProvisioningState = "Failed"
// PrivateEndpointConnectionProvisioningStateSucceeded ...
PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)
func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState
PossiblePrivateEndpointConnectionProvisioningStateValues returns an array of possible values for the PrivateEndpointConnectionProvisioningState const type.
PrivateEndpointConnectionsClient is the REST API for Azure Redis Cache Service.
type PrivateEndpointConnectionsClient struct {
BaseClient
}
func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.
func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, cacheName string, privateEndpointConnectionName string) (result autorest.Response, err error)
Delete deletes the specified private endpoint connection associated with the redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource
func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, cacheName string, privateEndpointConnectionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client PrivateEndpointConnectionsClient) 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 PrivateEndpointConnectionsClient) 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 PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, cacheName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)
Get gets the specified private endpoint connection associated with the redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource
func (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, cacheName string, privateEndpointConnectionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionsClient) 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 PrivateEndpointConnectionsClient) List(ctx context.Context, resourceGroupName string, cacheName string) (result PrivateEndpointConnectionListResult, err error)
List list all the private endpoint connections associated with the redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache.
func (client PrivateEndpointConnectionsClient) ListPreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client PrivateEndpointConnectionsClient) ListResponder(resp *http.Response) (result PrivateEndpointConnectionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionsClient) 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 PrivateEndpointConnectionsClient) Put(ctx context.Context, resourceGroupName string, cacheName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (result PrivateEndpointConnectionsPutFuture, err error)
Put update the state of specified private endpoint connection associated with the redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource properties - the private endpoint connection properties.
func (client PrivateEndpointConnectionsClient) PutPreparer(ctx context.Context, resourceGroupName string, cacheName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (*http.Request, error)
PutPreparer prepares the Put request.
func (client PrivateEndpointConnectionsClient) PutResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
PutResponder handles the response to the Put request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionsClient) PutSender(req *http.Request) (future PrivateEndpointConnectionsPutFuture, err error)
PutSender sends the Put request. The method will close the http.Response Body if it receives an error.
PrivateEndpointConnectionsPutFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PrivateEndpointConnectionsPutFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PrivateEndpointConnectionsClient) (PrivateEndpointConnection, error)
}
func (future *PrivateEndpointConnectionsPutFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PrivateEndpointServiceConnectionStatus enumerates the values for private endpoint service connection status.
type PrivateEndpointServiceConnectionStatus string
const (
// PrivateEndpointServiceConnectionStatusApproved ...
PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
// PrivateEndpointServiceConnectionStatusPending ...
PrivateEndpointServiceConnectionStatusPending PrivateEndpointServiceConnectionStatus = "Pending"
// PrivateEndpointServiceConnectionStatusRejected ...
PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)
func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus
PossiblePrivateEndpointServiceConnectionStatusValues returns an array of possible values for the PrivateEndpointServiceConnectionStatus const type.
PrivateLinkResource a private link resource
type PrivateLinkResource struct {
// PrivateLinkResourceProperties - Resource properties.
*PrivateLinkResourceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResource.
func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.
PrivateLinkResourceListResult a list of private link resources
type PrivateLinkResourceListResult struct {
autorest.Response `json:"-"`
// Value - Array of private link resources
Value *[]PrivateLinkResource `json:"value,omitempty"`
}
PrivateLinkResourceProperties properties of a private link resource.
type PrivateLinkResourceProperties struct {
// GroupID - READ-ONLY; The private link resource group id.
GroupID *string `json:"groupId,omitempty"`
// RequiredMembers - READ-ONLY; The private link resource required member names.
RequiredMembers *[]string `json:"requiredMembers,omitempty"`
// RequiredZoneNames - The private link resource Private link DNS zone name.
RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}
func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.
PrivateLinkResourcesClient is the REST API for Azure Redis Cache Service.
type PrivateLinkResourcesClient struct {
BaseClient
}
func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.
func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client PrivateLinkResourcesClient) ListByRedisCache(ctx context.Context, resourceGroupName string, cacheName string) (result PrivateLinkResourceListResult, err error)
ListByRedisCache gets the private link resources that need to be created for a redis cache. Parameters: resourceGroupName - the name of the resource group. cacheName - the name of the Redis cache.
func (client PrivateLinkResourcesClient) ListByRedisCachePreparer(ctx context.Context, resourceGroupName string, cacheName string) (*http.Request, error)
ListByRedisCachePreparer prepares the ListByRedisCache request.
func (client PrivateLinkResourcesClient) ListByRedisCacheResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)
ListByRedisCacheResponder handles the response to the ListByRedisCache request. The method always closes the http.Response Body.
func (client PrivateLinkResourcesClient) ListByRedisCacheSender(req *http.Request) (*http.Response, error)
ListByRedisCacheSender sends the ListByRedisCache request. The method will close the http.Response Body if it receives an error.
PrivateLinkServiceConnectionState a collection of information about the state of the connection between service consumer and provider.
type PrivateLinkServiceConnectionState struct {
// Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: 'PrivateEndpointServiceConnectionStatusPending', 'PrivateEndpointServiceConnectionStatusApproved', 'PrivateEndpointServiceConnectionStatusRejected'
Status PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
// Description - The reason for approval/rejection of the connection.
Description *string `json:"description,omitempty"`
// ActionsRequired - A message indicating if changes on the service provider require any updates on the consumer.
ActionsRequired *string `json:"actionsRequired,omitempty"`
}
Properties properties of the redis cache.
type Properties struct {
// ProvisioningState - READ-ONLY; Redis instance provisioning status. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateDeleting', 'ProvisioningStateDisabled', 'ProvisioningStateFailed', 'ProvisioningStateLinking', 'ProvisioningStateProvisioning', 'ProvisioningStateRecoveringScaleFailure', 'ProvisioningStateScaling', 'ProvisioningStateSucceeded', 'ProvisioningStateUnlinking', 'ProvisioningStateUnprovisioning', 'ProvisioningStateUpdating'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
// HostName - READ-ONLY; Redis host name.
HostName *string `json:"hostName,omitempty"`
// Port - READ-ONLY; Redis non-SSL port.
Port *int32 `json:"port,omitempty"`
// SslPort - READ-ONLY; Redis SSL port.
SslPort *int32 `json:"sslPort,omitempty"`
// AccessKeys - READ-ONLY; The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache
AccessKeys *AccessKeys `json:"accessKeys,omitempty"`
// LinkedServers - READ-ONLY; List of the linked servers associated with the cache
LinkedServers *[]LinkedServer `json:"linkedServers,omitempty"`
// Instances - READ-ONLY; List of the Redis instances associated with the cache
Instances *[]InstanceDetails `json:"instances,omitempty"`
// PrivateEndpointConnections - READ-ONLY; List of private endpoint connection associated with the specified redis cache
PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,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/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
SubnetID *string `json:"subnetId,omitempty"`
// StaticIP - Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.
StaticIP *string `json:"staticIP,omitempty"`
// 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"`
// RedisVersion - Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6)
RedisVersion *string `json:"redisVersion,omitempty"`
// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
// ReplicasPerMaster - The number of replicas to be created per primary.
ReplicasPerMaster *int32 `json:"replicasPerMaster,omitempty"`
// ReplicasPerPrimary - The number of replicas to be created per primary.
ReplicasPerPrimary *int32 `json:"replicasPerPrimary,omitempty"`
// TenantSettings - A dictionary of tenant settings
TenantSettings map[string]*string `json:"tenantSettings"`
// ShardCount - The number of shards to be created on a Premium Cluster Cache.
ShardCount *int32 `json:"shardCount,omitempty"`
// MinimumTLSVersion - Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). Possible values include: 'TLSVersionOneFullStopZero', 'TLSVersionOneFullStopOne', 'TLSVersionOneFullStopTwo'
MinimumTLSVersion TLSVersion `json:"minimumTlsVersion,omitempty"`
// PublicNetworkAccess - Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'. Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}
func (p Properties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Properties.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// ProvisioningStateCreating ...
ProvisioningStateCreating ProvisioningState = "Creating"
// ProvisioningStateDeleting ...
ProvisioningStateDeleting ProvisioningState = "Deleting"
// ProvisioningStateDisabled ...
ProvisioningStateDisabled ProvisioningState = "Disabled"
// ProvisioningStateFailed ...
ProvisioningStateFailed ProvisioningState = "Failed"
// ProvisioningStateLinking ...
ProvisioningStateLinking ProvisioningState = "Linking"
// ProvisioningStateProvisioning ...
ProvisioningStateProvisioning ProvisioningState = "Provisioning"
// ProvisioningStateRecoveringScaleFailure ...
ProvisioningStateRecoveringScaleFailure ProvisioningState = "RecoveringScaleFailure"
// ProvisioningStateScaling ...
ProvisioningStateScaling ProvisioningState = "Scaling"
// ProvisioningStateSucceeded ...
ProvisioningStateSucceeded ProvisioningState = "Succeeded"
// ProvisioningStateUnlinking ...
ProvisioningStateUnlinking ProvisioningState = "Unlinking"
// ProvisioningStateUnprovisioning ...
ProvisioningStateUnprovisioning ProvisioningState = "Unprovisioning"
// ProvisioningStateUpdating ...
ProvisioningStateUpdating ProvisioningState = "Updating"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
type ProxyResource struct {
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (pr ProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyResource.
PublicNetworkAccess enumerates the values for public network access.
type PublicNetworkAccess string
const (
// PublicNetworkAccessDisabled ...
PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
// PublicNetworkAccessEnabled ...
PublicNetworkAccessEnabled PublicNetworkAccess = "Enabled"
)
func PossiblePublicNetworkAccessValues() []PublicNetworkAccess
PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
RebootParameters specifies which Redis node(s) to reboot.
type RebootParameters struct {
// RebootType - Which Redis node(s) to reboot. Depending on this value data loss is possible. Possible values include: 'RebootTypePrimaryNode', 'RebootTypeSecondaryNode', 'RebootTypeAllNodes'
RebootType RebootType `json:"rebootType,omitempty"`
// ShardID - If clustering is enabled, the ID of the shard to be rebooted.
ShardID *int32 `json:"shardId,omitempty"`
// Ports - A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports.
Ports *[]int32 `json:"ports,omitempty"`
}
RebootType enumerates the values for reboot type.
type RebootType string
const (
// RebootTypeAllNodes ...
RebootTypeAllNodes RebootType = "AllNodes"
// RebootTypePrimaryNode ...
RebootTypePrimaryNode RebootType = "PrimaryNode"
// RebootTypeSecondaryNode ...
RebootTypeSecondaryNode RebootType = "SecondaryNode"
)
func PossibleRebootTypeValues() []RebootType
PossibleRebootTypeValues returns an array of possible values for the RebootType const type.
RegenerateKeyParameters specifies which Redis access keys to reset.
type RegenerateKeyParameters struct {
// KeyType - The Redis access key to regenerate. Possible values include: 'KeyTypePrimary', 'KeyTypeSecondary'
KeyType KeyType `json:"keyType,omitempty"`
}
ReplicationRole enumerates the values for replication role.
type ReplicationRole string
const (
// ReplicationRolePrimary ...
ReplicationRolePrimary ReplicationRole = "Primary"
// ReplicationRoleSecondary ...
ReplicationRoleSecondary ReplicationRole = "Secondary"
)
func PossibleReplicationRoleValues() []ReplicationRole
PossibleReplicationRoleValues returns an array of possible values for the ReplicationRole const type.
Resource common fields that are returned in the response for all Azure Resource Manager resources
type Resource struct {
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceType a single Redis item in List or Get Operation.
type ResourceType struct {
autorest.Response `json:"-"`
// 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"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// Location - The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (rt ResourceType) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceType.
func (rt *ResourceType) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ResourceType struct.
ScheduleEntries list of patch schedules for a Redis cache.
type ScheduleEntries struct {
// ScheduleEntries - List of patch schedules for a Redis cache.
ScheduleEntries *[]ScheduleEntry `json:"scheduleEntries,omitempty"`
}
ScheduleEntry patch schedule entry for a Premium Redis Cache.
type ScheduleEntry struct {
// DayOfWeek - Day of the week when a cache can be patched. Possible values include: 'DayOfWeekMonday', 'DayOfWeekTuesday', 'DayOfWeekWednesday', 'DayOfWeekThursday', 'DayOfWeekFriday', 'DayOfWeekSaturday', 'DayOfWeekSunday', 'DayOfWeekEveryday', 'DayOfWeekWeekend'
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"`
}
Sku SKU parameters supplied to the create Redis operation.
type Sku struct {
// Name - The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium). Possible values include: 'SkuNameBasic', 'SkuNameStandard', 'SkuNamePremium'
Name SkuName `json:"name,omitempty"`
// Family - The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). Possible values include: 'SkuFamilyC', 'SkuFamilyP'
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"`
}
SkuFamily enumerates the values for sku family.
type SkuFamily string
const (
// SkuFamilyC ...
SkuFamilyC SkuFamily = "C"
// SkuFamilyP ...
SkuFamilyP SkuFamily = "P"
)
func PossibleSkuFamilyValues() []SkuFamily
PossibleSkuFamilyValues returns an array of possible values for the SkuFamily const type.
SkuName enumerates the values for sku name.
type SkuName string
const (
// SkuNameBasic ...
SkuNameBasic SkuName = "Basic"
// SkuNamePremium ...
SkuNamePremium SkuName = "Premium"
// SkuNameStandard ...
SkuNameStandard SkuName = "Standard"
)
func PossibleSkuNameValues() []SkuName
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
TLSVersion enumerates the values for tls version.
type TLSVersion string
const (
// TLSVersionOneFullStopOne ...
TLSVersionOneFullStopOne TLSVersion = "1.1"
// TLSVersionOneFullStopTwo ...
TLSVersionOneFullStopTwo TLSVersion = "1.2"
// TLSVersionOneFullStopZero ...
TLSVersionOneFullStopZero TLSVersion = "1.0"
)
func PossibleTLSVersionValues() []TLSVersion
PossibleTLSVersionValues returns an array of possible values for the TLSVersion const type.
TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
type TrackedResource struct {
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
// Location - The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
UpdateParameters parameters supplied to the Update Redis operation.
type UpdateParameters struct {
// UpdateProperties - Redis cache properties.
*UpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}
func (up UpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateParameters.
func (up *UpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UpdateParameters struct.
UpdateProperties patchable properties of the redis cache.
type UpdateProperties struct {
// Sku - The SKU of the Redis cache to deploy.
Sku *Sku `json:"sku,omitempty"`
// RedisConfiguration - All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.
RedisConfiguration map[string]*string `json:"redisConfiguration"`
// RedisVersion - Redis version. Only major version will be used in PUT/PATCH request with current valid values: (4, 6)
RedisVersion *string `json:"redisVersion,omitempty"`
// EnableNonSslPort - Specifies whether the non-ssl Redis server port (6379) is enabled.
EnableNonSslPort *bool `json:"enableNonSslPort,omitempty"`
// ReplicasPerMaster - The number of replicas to be created per primary.
ReplicasPerMaster *int32 `json:"replicasPerMaster,omitempty"`
// ReplicasPerPrimary - The number of replicas to be created per primary.
ReplicasPerPrimary *int32 `json:"replicasPerPrimary,omitempty"`
// TenantSettings - A dictionary of tenant settings
TenantSettings map[string]*string `json:"tenantSettings"`
// ShardCount - The number of shards to be created on a Premium Cluster Cache.
ShardCount *int32 `json:"shardCount,omitempty"`
// MinimumTLSVersion - Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2'). Possible values include: 'TLSVersionOneFullStopZero', 'TLSVersionOneFullStopOne', 'TLSVersionOneFullStopTwo'
MinimumTLSVersion TLSVersion `json:"minimumTlsVersion,omitempty"`
// PublicNetworkAccess - Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'. Possible values include: 'PublicNetworkAccessEnabled', 'PublicNetworkAccessDisabled'
PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}
func (up UpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpdateProperties.
UpgradeNotification properties of upgrade notification.
type UpgradeNotification struct {
// Name - READ-ONLY; Name of upgrade notification.
Name *string `json:"name,omitempty"`
// Timestamp - READ-ONLY; Timestamp when upgrade notification occurred.
Timestamp *date.Time `json:"timestamp,omitempty"`
// UpsellNotification - READ-ONLY; Details about this upgrade notification
UpsellNotification map[string]*string `json:"upsellNotification"`
}
func (un UpgradeNotification) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UpgradeNotification.