redisenterprise

package
v50.1.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Jan 15, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package redisenterprise implements the Azure ARM Redisenterprise service API version 2020-10-01-preview.

REST API for managing Redis Enterprise resources in Azure.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Redisenterprise
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessKeyType

type AccessKeyType string

AccessKeyType enumerates the values for access key type.

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

func PossibleAccessKeyTypeValues

func PossibleAccessKeyTypeValues() []AccessKeyType

PossibleAccessKeyTypeValues returns an array of possible values for the AccessKeyType const type.

type AccessKeys

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

AccessKeys the secret access keys used for authenticating connections to redis

type ActionType

type ActionType string

ActionType enumerates the values for action type.

const (
	// Internal ...
	Internal ActionType = "Internal"
)

func PossibleActionTypeValues

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns an array of possible values for the ActionType const type.

type AzureEntityResource

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"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Redisenterprise.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Client

type Client struct {
	BaseClient
}

Client is the REST API for managing Redis Enterprise resources in Azure.

func NewClient

func NewClient(subscriptionID string) Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI

func NewClientWithBaseURI(baseURI string, subscriptionID string) Client

NewClientWithBaseURI creates an instance of the Client client 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) Create

func (client Client) Create(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (result CreateFuture, err error)

Create creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. parameters - parameters supplied to the Create RedisEnterprise operation.

func (Client) CreatePreparer

func (client Client) CreatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters Cluster) (*http.Request, error)

CreatePreparer prepares the Create request.

func (Client) CreateResponder

func (client Client) CreateResponder(resp *http.Response) (result Cluster, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (Client) CreateSender

func (client Client) CreateSender(req *http.Request) (future CreateFuture, err error)

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

func (Client) Delete

func (client Client) Delete(ctx context.Context, resourceGroupName string, clusterName string) (result DeleteFuture, err error)

Delete deletes a RedisEnterprise cache cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster.

func (Client) DeletePreparer

func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder

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

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (Client) DeleteSender

func (client Client) DeleteSender(req *http.Request) (future DeleteFuture, err error)

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

func (Client) GetMethod

func (client Client) GetMethod(ctx context.Context, resourceGroupName string, clusterName string) (result Cluster, err error)

GetMethod gets information about a RedisEnterprise cluster Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster.

func (Client) GetMethodPreparer

func (client Client) GetMethodPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

GetMethodPreparer prepares the GetMethod request.

func (Client) GetMethodResponder

func (client Client) GetMethodResponder(resp *http.Response) (result Cluster, err error)

GetMethodResponder handles the response to the GetMethod request. The method always closes the http.Response Body.

func (Client) GetMethodSender

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

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

func (Client) List

func (client Client) List(ctx context.Context) (result ClusterListPage, err error)

List gets all RedisEnterprise clusters in the specified subscription.

func (Client) ListByResourceGroup

func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ClusterListPage, err error)

ListByResourceGroup lists all RedisEnterprise clusters in a resource group. Parameters: resourceGroupName - the name of the resource group.

func (Client) ListByResourceGroupComplete

func (client Client) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ClusterListIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListByResourceGroupPreparer

func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (Client) ListByResourceGroupResponder

func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ClusterList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (Client) ListByResourceGroupSender

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

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

func (Client) ListComplete

func (client Client) ListComplete(ctx context.Context) (result ClusterListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListPreparer

func (client Client) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder

func (client Client) ListResponder(resp *http.Response) (result ClusterList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (Client) ListSender

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

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

func (Client) Update

func (client Client) Update(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterUpdate) (result UpdateFuture, err error)

Update updates an existing RedisEnterprise cluster Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. parameters - parameters supplied to the Update RedisEnterprise operation.

func (Client) UpdatePreparer

func (client Client) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, parameters ClusterUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder

func (client Client) UpdateResponder(resp *http.Response) (result Cluster, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (Client) UpdateSender

func (client Client) UpdateSender(req *http.Request) (future UpdateFuture, err error)

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

type Cluster

type Cluster struct {
	autorest.Response `json:"-"`
	// Sku - The SKU to create, which affects price, performance, and features.
	Sku *Sku `json:"sku,omitempty"`
	// Zones - The zones where this cluster will be deployed.
	Zones *[]string `json:"zones,omitempty"`
	// ClusterProperties - Other properties of the cluster.
	*ClusterProperties `json:"properties,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"`
}

Cluster describes the RedisEnterprise cluster

func (Cluster) MarshalJSON

func (c Cluster) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Cluster.

func (*Cluster) UnmarshalJSON

func (c *Cluster) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Cluster struct.

type ClusterList

type ClusterList struct {
	autorest.Response `json:"-"`
	// Value - List of clusters.
	Value *[]Cluster `json:"value,omitempty"`
	// NextLink - READ-ONLY; The URI to fetch the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

ClusterList the response of a list-all operation.

func (ClusterList) IsEmpty

func (cl ClusterList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (ClusterList) MarshalJSON

func (cl ClusterList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterList.

type ClusterListIterator

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

ClusterListIterator provides access to a complete listing of Cluster values.

func NewClusterListIterator

func NewClusterListIterator(page ClusterListPage) ClusterListIterator

Creates a new instance of the ClusterListIterator type.

func (*ClusterListIterator) Next

func (iter *ClusterListIterator) 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 (*ClusterListIterator) NextWithContext

func (iter *ClusterListIterator) 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 (ClusterListIterator) NotDone

func (iter ClusterListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ClusterListIterator) Response

func (iter ClusterListIterator) Response() ClusterList

Response returns the raw server response from the last page request.

func (ClusterListIterator) Value

func (iter ClusterListIterator) Value() Cluster

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ClusterListPage

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

ClusterListPage contains a page of Cluster values.

func NewClusterListPage

func NewClusterListPage(cur ClusterList, getNextPage func(context.Context, ClusterList) (ClusterList, error)) ClusterListPage

Creates a new instance of the ClusterListPage type.

func (*ClusterListPage) Next

func (page *ClusterListPage) 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 (*ClusterListPage) NextWithContext

func (page *ClusterListPage) 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 (ClusterListPage) NotDone

func (page ClusterListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ClusterListPage) Response

func (page ClusterListPage) Response() ClusterList

Response returns the raw server response from the last page request.

func (ClusterListPage) Values

func (page ClusterListPage) Values() []Cluster

Values returns the slice of values for the current page or nil if there are no values.

type ClusterProperties

type ClusterProperties struct {
	// MinimumTLSVersion - The minimum TLS version for the cluster to support, e.g. '1.2'
	MinimumTLSVersion *string `json:"minimumTlsVersion,omitempty"`
	// HostName - READ-ONLY; DNS name of the cluster endpoint
	HostName *string `json:"hostName,omitempty"`
	// ProvisioningState - READ-ONLY; Current provisioning status of the cluster. Possible values include: 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateCreating', 'ProvisioningStateUpdating', 'ProvisioningStateDeleting'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// ResourceState - READ-ONLY; Current resource status of the cluster. Possible values include: 'ResourceStateRunning', 'ResourceStateCreating', 'ResourceStateCreateFailed', 'ResourceStateUpdating', 'ResourceStateUpdateFailed', 'ResourceStateDeleting', 'ResourceStateDeleteFailed', 'ResourceStateEnabling', 'ResourceStateEnableFailed', 'ResourceStateDisabling', 'ResourceStateDisableFailed', 'ResourceStateDisabled'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// RedisVersion - READ-ONLY; Version of redis the cluster supports, e.g. '6'
	RedisVersion *string `json:"redisVersion,omitempty"`
	// PrivateEndpointConnections - READ-ONLY; List of private endpoint connections associated with the specified RedisEnterprise cluster
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
}

ClusterProperties properties of RedisEnterprise clusters, as opposed to general resource properties like location, tags

func (ClusterProperties) MarshalJSON

func (cp ClusterProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterProperties.

type ClusterUpdate

type ClusterUpdate struct {
	// Sku - The SKU to create, which affects price, performance, and features.
	Sku *Sku `json:"sku,omitempty"`
	// ClusterProperties - Other properties of the cluster.
	*ClusterProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

ClusterUpdate a partial update to the RedisEnterprise cluster

func (ClusterUpdate) MarshalJSON

func (cu ClusterUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ClusterUpdate.

func (*ClusterUpdate) UnmarshalJSON

func (cu *ClusterUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ClusterUpdate struct.

type ClusteringPolicy

type ClusteringPolicy string

ClusteringPolicy enumerates the values for clustering policy.

const (
	// EnterpriseCluster ...
	EnterpriseCluster ClusteringPolicy = "EnterpriseCluster"
	// OSSCluster ...
	OSSCluster ClusteringPolicy = "OSSCluster"
)

func PossibleClusteringPolicyValues

func PossibleClusteringPolicyValues() []ClusteringPolicy

PossibleClusteringPolicyValues returns an array of possible values for the ClusteringPolicy const type.

type CreateFuture

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) (Cluster, error)
}

CreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type Database

type Database struct {
	autorest.Response `json:"-"`
	// DatabaseProperties - Other properties of the database.
	*DatabaseProperties `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"`
}

Database describes a database on the RedisEnterprise cluster

func (Database) MarshalJSON

func (d Database) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Database.

func (*Database) UnmarshalJSON

func (d *Database) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Database struct.

type DatabaseList

type DatabaseList struct {
	autorest.Response `json:"-"`
	// Value - List of databases
	Value *[]Database `json:"value,omitempty"`
	// NextLink - READ-ONLY; The URI to fetch the next page of results.
	NextLink *string `json:"nextLink,omitempty"`
}

DatabaseList the response of a list-all operation.

func (DatabaseList) IsEmpty

func (dl DatabaseList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (DatabaseList) MarshalJSON

func (dl DatabaseList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseList.

type DatabaseListIterator

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

DatabaseListIterator provides access to a complete listing of Database values.

func NewDatabaseListIterator

func NewDatabaseListIterator(page DatabaseListPage) DatabaseListIterator

Creates a new instance of the DatabaseListIterator type.

func (*DatabaseListIterator) Next

func (iter *DatabaseListIterator) 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 (*DatabaseListIterator) NextWithContext

func (iter *DatabaseListIterator) 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 (DatabaseListIterator) NotDone

func (iter DatabaseListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (DatabaseListIterator) Response

func (iter DatabaseListIterator) Response() DatabaseList

Response returns the raw server response from the last page request.

func (DatabaseListIterator) Value

func (iter DatabaseListIterator) Value() Database

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type DatabaseListPage

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

DatabaseListPage contains a page of Database values.

func NewDatabaseListPage

func NewDatabaseListPage(cur DatabaseList, getNextPage func(context.Context, DatabaseList) (DatabaseList, error)) DatabaseListPage

Creates a new instance of the DatabaseListPage type.

func (*DatabaseListPage) Next

func (page *DatabaseListPage) 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 (*DatabaseListPage) NextWithContext

func (page *DatabaseListPage) 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 (DatabaseListPage) NotDone

func (page DatabaseListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DatabaseListPage) Response

func (page DatabaseListPage) Response() DatabaseList

Response returns the raw server response from the last page request.

func (DatabaseListPage) Values

func (page DatabaseListPage) Values() []Database

Values returns the slice of values for the current page or nil if there are no values.

type DatabaseProperties

type DatabaseProperties struct {
	// ClientProtocol - Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Possible values include: 'Encrypted', 'Plaintext'
	ClientProtocol Protocol `json:"clientProtocol,omitempty"`
	// Port - TCP port of the database endpoint. Specified at create time. Defaults to an available port.
	Port *int32 `json:"port,omitempty"`
	// ProvisioningState - READ-ONLY; Current provisioning status of the database. Possible values include: 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateCreating', 'ProvisioningStateUpdating', 'ProvisioningStateDeleting'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// ResourceState - READ-ONLY; Current resource status of the database. Possible values include: 'ResourceStateRunning', 'ResourceStateCreating', 'ResourceStateCreateFailed', 'ResourceStateUpdating', 'ResourceStateUpdateFailed', 'ResourceStateDeleting', 'ResourceStateDeleteFailed', 'ResourceStateEnabling', 'ResourceStateEnableFailed', 'ResourceStateDisabling', 'ResourceStateDisableFailed', 'ResourceStateDisabled'
	ResourceState ResourceState `json:"resourceState,omitempty"`
	// ClusteringPolicy - Clustering policy - default is OSSCluster. Specified at create time. Possible values include: 'EnterpriseCluster', 'OSSCluster'
	ClusteringPolicy ClusteringPolicy `json:"clusteringPolicy,omitempty"`
	// EvictionPolicy - Redis eviction policy - default is VolatileLRU. Possible values include: 'AllKeysLFU', 'AllKeysLRU', 'AllKeysRandom', 'VolatileLRU', 'VolatileLFU', 'VolatileTTL', 'VolatileRandom', 'NoEviction'
	EvictionPolicy EvictionPolicy `json:"evictionPolicy,omitempty"`
	// Modules - Optional set of redis modules to enable in this database - modules can only be added at creation time.
	Modules *[]Module `json:"modules,omitempty"`
}

DatabaseProperties properties of RedisEnterprise databases, as opposed to general resource properties like location, tags

func (DatabaseProperties) MarshalJSON

func (dp DatabaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseProperties.

type DatabaseUpdate

type DatabaseUpdate struct {
	// DatabaseProperties - Properties of the database.
	*DatabaseProperties `json:"properties,omitempty"`
}

DatabaseUpdate a partial update to the RedisEnterprise database

func (DatabaseUpdate) MarshalJSON

func (du DatabaseUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseUpdate.

func (*DatabaseUpdate) UnmarshalJSON

func (du *DatabaseUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DatabaseUpdate struct.

type DatabasesClient

type DatabasesClient struct {
	BaseClient
}

DatabasesClient is the REST API for managing Redis Enterprise resources in Azure.

func NewDatabasesClient

func NewDatabasesClient(subscriptionID string) DatabasesClient

NewDatabasesClient creates an instance of the DatabasesClient client.

func NewDatabasesClientWithBaseURI

func NewDatabasesClientWithBaseURI(baseURI string, subscriptionID string) DatabasesClient

NewDatabasesClientWithBaseURI creates an instance of the DatabasesClient 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 (DatabasesClient) Create

func (client DatabasesClient) Create(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters Database) (result DatabasesCreateFuture, err error)

Create creates a database Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database. parameters - parameters supplied to the create or update database operation.

func (DatabasesClient) CreatePreparer

func (client DatabasesClient) CreatePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters Database) (*http.Request, error)

CreatePreparer prepares the Create request.

func (DatabasesClient) CreateResponder

func (client DatabasesClient) CreateResponder(resp *http.Response) (result Database, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (DatabasesClient) CreateSender

func (client DatabasesClient) CreateSender(req *http.Request) (future DatabasesCreateFuture, err error)

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

func (DatabasesClient) Delete

func (client DatabasesClient) Delete(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (result DatabasesDeleteFuture, err error)

Delete deletes a single database Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database.

func (DatabasesClient) DeletePreparer

func (client DatabasesClient) DeletePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DatabasesClient) DeleteResponder

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

func (client DatabasesClient) DeleteSender(req *http.Request) (future DatabasesDeleteFuture, err error)

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

func (DatabasesClient) Export

func (client DatabasesClient) Export(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters ExportClusterParameters) (result DatabasesExportFuture, err error)

Export exports a database file from target database. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database. parameters - storage information for exporting into the cluster

func (DatabasesClient) ExportPreparer

func (client DatabasesClient) ExportPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters ExportClusterParameters) (*http.Request, error)

ExportPreparer prepares the Export request.

func (DatabasesClient) ExportResponder

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

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

func (DatabasesClient) ExportSender

func (client DatabasesClient) ExportSender(req *http.Request) (future DatabasesExportFuture, err error)

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

func (DatabasesClient) GetMethod

func (client DatabasesClient) GetMethod(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (result Database, err error)

GetMethod gets information about a database in a RedisEnterprise cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database.

func (DatabasesClient) GetMethodPreparer

func (client DatabasesClient) GetMethodPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (*http.Request, error)

GetMethodPreparer prepares the GetMethod request.

func (DatabasesClient) GetMethodResponder

func (client DatabasesClient) GetMethodResponder(resp *http.Response) (result Database, err error)

GetMethodResponder handles the response to the GetMethod request. The method always closes the http.Response Body.

func (DatabasesClient) GetMethodSender

func (client DatabasesClient) GetMethodSender(req *http.Request) (*http.Response, error)

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

func (DatabasesClient) Import

func (client DatabasesClient) Import(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters ImportClusterParameters) (result DatabasesImportFuture, err error)

Import imports a database file to target database. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database. parameters - storage information for importing into the cluster

func (DatabasesClient) ImportPreparer

func (client DatabasesClient) ImportPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters ImportClusterParameters) (*http.Request, error)

ImportPreparer prepares the Import request.

func (DatabasesClient) ImportResponder

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

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

func (DatabasesClient) ImportSender

func (client DatabasesClient) ImportSender(req *http.Request) (future DatabasesImportFuture, err error)

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

func (DatabasesClient) ListByCluster

func (client DatabasesClient) ListByCluster(ctx context.Context, resourceGroupName string, clusterName string) (result DatabaseListPage, err error)

ListByCluster gets all databases in the specified RedisEnterprise cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster.

func (DatabasesClient) ListByClusterComplete

func (client DatabasesClient) ListByClusterComplete(ctx context.Context, resourceGroupName string, clusterName string) (result DatabaseListIterator, err error)

ListByClusterComplete enumerates all values, automatically crossing page boundaries as required.

func (DatabasesClient) ListByClusterPreparer

func (client DatabasesClient) ListByClusterPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListByClusterPreparer prepares the ListByCluster request.

func (DatabasesClient) ListByClusterResponder

func (client DatabasesClient) ListByClusterResponder(resp *http.Response) (result DatabaseList, err error)

ListByClusterResponder handles the response to the ListByCluster request. The method always closes the http.Response Body.

func (DatabasesClient) ListByClusterSender

func (client DatabasesClient) ListByClusterSender(req *http.Request) (*http.Response, error)

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

func (DatabasesClient) ListKeys

func (client DatabasesClient) ListKeys(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (result AccessKeys, err error)

ListKeys retrieves the access keys for the RedisEnterprise database. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database.

func (DatabasesClient) ListKeysPreparer

func (client DatabasesClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (DatabasesClient) ListKeysResponder

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

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

func (client DatabasesClient) RegenerateKey(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters RegenerateKeyParameters) (result DatabasesRegenerateKeyFuture, err error)

RegenerateKey regenerates the RedisEnterprise database's access keys. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database. parameters - specifies which key to regenerate.

func (DatabasesClient) RegenerateKeyPreparer

func (client DatabasesClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters RegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (DatabasesClient) RegenerateKeyResponder

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

func (client DatabasesClient) RegenerateKeySender(req *http.Request) (future DatabasesRegenerateKeyFuture, err error)

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

func (DatabasesClient) Update

func (client DatabasesClient) Update(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DatabaseUpdate) (result DatabasesUpdateFuture, err error)

Update updates a database Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. databaseName - the name of the database. parameters - parameters supplied to the create or update database operation.

func (DatabasesClient) UpdatePreparer

func (client DatabasesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, clusterName string, databaseName string, parameters DatabaseUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DatabasesClient) UpdateResponder

func (client DatabasesClient) UpdateResponder(resp *http.Response) (result Database, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (DatabasesClient) UpdateSender

func (client DatabasesClient) UpdateSender(req *http.Request) (future DatabasesUpdateFuture, err error)

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

type DatabasesCreateFuture

type DatabasesCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (Database, error)
}

DatabasesCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type DatabasesDeleteFuture

type DatabasesDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (autorest.Response, error)
}

DatabasesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type DatabasesExportFuture

type DatabasesExportFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (autorest.Response, error)
}

DatabasesExportFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type DatabasesImportFuture

type DatabasesImportFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (autorest.Response, error)
}

DatabasesImportFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type DatabasesRegenerateKeyFuture

type DatabasesRegenerateKeyFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (AccessKeys, error)
}

DatabasesRegenerateKeyFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type DatabasesUpdateFuture

type DatabasesUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(DatabasesClient) (Database, error)
}

DatabasesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type DeleteFuture

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

DeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type ErrorAdditionalInfo

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"`
}

ErrorAdditionalInfo the resource management error additional info.

type ErrorDetail

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"`
}

ErrorDetail the error detail.

type ErrorResponse

type ErrorResponse struct {
	// Error - The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

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 EvictionPolicy

type EvictionPolicy string

EvictionPolicy enumerates the values for eviction policy.

const (
	// AllKeysLFU ...
	AllKeysLFU EvictionPolicy = "AllKeysLFU"
	// AllKeysLRU ...
	AllKeysLRU EvictionPolicy = "AllKeysLRU"
	// AllKeysRandom ...
	AllKeysRandom EvictionPolicy = "AllKeysRandom"
	// NoEviction ...
	NoEviction EvictionPolicy = "NoEviction"
	// VolatileLFU ...
	VolatileLFU EvictionPolicy = "VolatileLFU"
	// VolatileLRU ...
	VolatileLRU EvictionPolicy = "VolatileLRU"
	// VolatileRandom ...
	VolatileRandom EvictionPolicy = "VolatileRandom"
	// VolatileTTL ...
	VolatileTTL EvictionPolicy = "VolatileTTL"
)

func PossibleEvictionPolicyValues

func PossibleEvictionPolicyValues() []EvictionPolicy

PossibleEvictionPolicyValues returns an array of possible values for the EvictionPolicy const type.

type ExportClusterParameters

type ExportClusterParameters struct {
	// SasURI - SAS Uri for the target directory to export to
	SasURI *string `json:"sasUri,omitempty"`
}

ExportClusterParameters parameters for a Redis Enterprise export operation.

type GetClient

type GetClient struct {
	BaseClient
}

GetClient is the REST API for managing Redis Enterprise resources in Azure.

func NewGetClient

func NewGetClient(subscriptionID string) GetClient

NewGetClient creates an instance of the GetClient client.

func NewGetClientWithBaseURI

func NewGetClientWithBaseURI(baseURI string, subscriptionID string) GetClient

NewGetClientWithBaseURI creates an instance of the GetClient 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 (GetClient) OperationStatusMethod

func (client GetClient) OperationStatusMethod(ctx context.Context, location string, operationID string) (result OperationStatus, err error)

OperationStatusMethod gets the status of operation. Parameters: location - the region the operation is in. operationID - the operation's unique identifier.

func (GetClient) OperationStatusMethodPreparer

func (client GetClient) OperationStatusMethodPreparer(ctx context.Context, location string, operationID string) (*http.Request, error)

OperationStatusMethodPreparer prepares the OperationStatusMethod request.

func (GetClient) OperationStatusMethodResponder

func (client GetClient) OperationStatusMethodResponder(resp *http.Response) (result OperationStatus, err error)

OperationStatusMethodResponder handles the response to the OperationStatusMethod request. The method always closes the http.Response Body.

func (GetClient) OperationStatusMethodSender

func (client GetClient) OperationStatusMethodSender(req *http.Request) (*http.Response, error)

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

type ImportClusterParameters

type ImportClusterParameters struct {
	// SasURI - SAS Uri for the target blob to import from
	SasURI *string `json:"sasUri,omitempty"`
}

ImportClusterParameters parameters for a Redis Enterprise import operation.

type Module

type Module struct {
	// Name - The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
	Name *string `json:"name,omitempty"`
	// Args - Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'.
	Args *string `json:"args,omitempty"`
	// Version - READ-ONLY; The version of the module, e.g. '1.0'.
	Version *string `json:"version,omitempty"`
}

Module specifies configuration of a redis module

func (Module) MarshalJSON

func (mVar Module) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Module.

type Operation

type Operation struct {
	// Name - READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
	Name *string `json:"name,omitempty"`
	// IsDataAction - READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Display - Localized display information for this particular operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system". Possible values include: 'User', 'System', 'Usersystem'
	Origin Origin `json:"origin,omitempty"`
	// ActionType - READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Possible values include: 'Internal'
	ActionType ActionType `json:"actionType,omitempty"`
}

Operation details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay

type OperationDisplay struct {
	// Provider - READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
	Operation *string `json:"operation,omitempty"`
	// Description - READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string `json:"description,omitempty"`
}

OperationDisplay localized display information for this particular operation.

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; 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"`
}

OperationListResult a list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) IsEmpty

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext

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 (OperationListResultIterator) NotDone

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext

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 (OperationListResultPage) NotDone

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationStatus

type OperationStatus struct {
	autorest.Response `json:"-"`
	// ID - The operation's unique id.
	ID *string `json:"id,omitempty"`
	// Name - The operation's name.
	Name *string `json:"name,omitempty"`
	// StartTime - The start time of the operation.
	StartTime *string `json:"startTime,omitempty"`
	// EndTime - The end time of the operation.
	EndTime *string `json:"endTime,omitempty"`
	// Status - The current status of the operation.
	Status *string `json:"status,omitempty"`
	// Error - Error response describing why the operation failed.
	Error *ErrorResponse `json:"error,omitempty"`
}

OperationStatus the status of a long-running operation.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the REST API for managing Redis Enterprise resources in Azure.

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available REST API operations of the Microsoft.Cache provider.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

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.

type Origin

type Origin string

Origin enumerates the values for origin.

const (
	// System ...
	System Origin = "system"
	// User ...
	User Origin = "user"
	// Usersystem ...
	Usersystem Origin = "user,system"
)

func PossibleOriginValues

func PossibleOriginValues() []Origin

PossibleOriginValues returns an array of possible values for the Origin const type.

type PrivateEndpoint

type PrivateEndpoint struct {
	// ID - READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty"`
}

PrivateEndpoint the Private Endpoint resource.

type PrivateEndpointConnection

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"`
}

PrivateEndpointConnection the Private Endpoint Connection resource.

func (PrivateEndpointConnection) MarshalJSON

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON

func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.

type PrivateEndpointConnectionListResult

type PrivateEndpointConnectionListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private endpoint connections
	Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult list of private endpoint connection associated with the specified storage account

type PrivateEndpointConnectionProperties

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: 'Succeeded', 'Creating', 'Deleting', 'Failed'
	ProvisioningState PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

PrivateEndpointConnectionProperties properties of the PrivateEndpointConnectProperties.

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState enumerates the values for private endpoint connection provisioning state.

const (
	// Creating ...
	Creating PrivateEndpointConnectionProvisioningState = "Creating"
	// Deleting ...
	Deleting PrivateEndpointConnectionProvisioningState = "Deleting"
	// Failed ...
	Failed PrivateEndpointConnectionProvisioningState = "Failed"
	// Succeeded ...
	Succeeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns an array of possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient

type PrivateEndpointConnectionsClient struct {
	BaseClient
}

PrivateEndpointConnectionsClient is the REST API for managing Redis Enterprise resources in Azure.

func NewPrivateEndpointConnectionsClient

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI

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 (PrivateEndpointConnectionsClient) Delete

func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string) (result autorest.Response, err error)

Delete deletes the specified private endpoint connection associated with the RedisEnterprise cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource

func (PrivateEndpointConnectionsClient) DeletePreparer

func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder

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 (PrivateEndpointConnectionsClient) DeleteSender

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 (PrivateEndpointConnectionsClient) GetMethod

func (client PrivateEndpointConnectionsClient) GetMethod(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)

GetMethod gets the specified private endpoint connection associated with the RedisEnterprise cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource

func (PrivateEndpointConnectionsClient) GetMethodPreparer

func (client PrivateEndpointConnectionsClient) GetMethodPreparer(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string) (*http.Request, error)

GetMethodPreparer prepares the GetMethod request.

func (PrivateEndpointConnectionsClient) GetMethodResponder

func (client PrivateEndpointConnectionsClient) GetMethodResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

GetMethodResponder handles the response to the GetMethod request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) GetMethodSender

func (client PrivateEndpointConnectionsClient) GetMethodSender(req *http.Request) (*http.Response, error)

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

func (PrivateEndpointConnectionsClient) List

func (client PrivateEndpointConnectionsClient) List(ctx context.Context, resourceGroupName string, clusterName string) (result PrivateEndpointConnectionListResult, err error)

List lists all the private endpoint connections associated with the RedisEnterprise cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster.

func (PrivateEndpointConnectionsClient) ListPreparer

func (client PrivateEndpointConnectionsClient) ListPreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListPreparer prepares the List request.

func (PrivateEndpointConnectionsClient) ListResponder

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) ListSender

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 (PrivateEndpointConnectionsClient) Put

func (client PrivateEndpointConnectionsClient) Put(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (result PrivateEndpointConnectionsPutFuture, err error)

Put updates the state of the specified private endpoint connection associated with the RedisEnterprise cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource properties - the private endpoint connection properties.

func (PrivateEndpointConnectionsClient) PutPreparer

func (client PrivateEndpointConnectionsClient) PutPreparer(ctx context.Context, resourceGroupName string, clusterName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (*http.Request, error)

PutPreparer prepares the Put request.

func (PrivateEndpointConnectionsClient) PutResponder

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 (PrivateEndpointConnectionsClient) PutSender

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

type PrivateEndpointConnectionsPutFuture

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

PrivateEndpointConnectionsPutFuture an abstraction for monitoring and retrieving the results of a long-running operation.

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus enumerates the values for private endpoint service connection status.

const (
	// Approved ...
	Approved PrivateEndpointServiceConnectionStatus = "Approved"
	// Pending ...
	Pending PrivateEndpointServiceConnectionStatus = "Pending"
	// Rejected ...
	Rejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns an array of possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource

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"`
}

PrivateLinkResource a private link resource

func (PrivateLinkResource) MarshalJSON

func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON

func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceListResult

type PrivateLinkResourceListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private link resources
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult a list of private link resources

type PrivateLinkResourceProperties

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"`
}

PrivateLinkResourceProperties properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON

func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.

type PrivateLinkResourcesClient

type PrivateLinkResourcesClient struct {
	BaseClient
}

PrivateLinkResourcesClient is the REST API for managing Redis Enterprise resources in Azure.

func NewPrivateLinkResourcesClient

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI

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 (PrivateLinkResourcesClient) ListByRedisEnterpriseCache

func (client PrivateLinkResourcesClient) ListByRedisEnterpriseCache(ctx context.Context, resourceGroupName string, clusterName string) (result PrivateLinkResourceListResult, err error)

ListByRedisEnterpriseCache gets the private link resources that need to be created for a RedisEnterprise cluster. Parameters: resourceGroupName - the name of the resource group. clusterName - the name of the RedisEnterprise cluster.

func (PrivateLinkResourcesClient) ListByRedisEnterpriseCachePreparer

func (client PrivateLinkResourcesClient) ListByRedisEnterpriseCachePreparer(ctx context.Context, resourceGroupName string, clusterName string) (*http.Request, error)

ListByRedisEnterpriseCachePreparer prepares the ListByRedisEnterpriseCache request.

func (PrivateLinkResourcesClient) ListByRedisEnterpriseCacheResponder

func (client PrivateLinkResourcesClient) ListByRedisEnterpriseCacheResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)

ListByRedisEnterpriseCacheResponder handles the response to the ListByRedisEnterpriseCache request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) ListByRedisEnterpriseCacheSender

func (client PrivateLinkResourcesClient) ListByRedisEnterpriseCacheSender(req *http.Request) (*http.Response, error)

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

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	// Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: 'Pending', 'Approved', 'Rejected'
	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"`
}

PrivateLinkServiceConnectionState a collection of information about the state of the connection between service consumer and provider.

type Protocol

type Protocol string

Protocol enumerates the values for protocol.

const (
	// Encrypted ...
	Encrypted Protocol = "Encrypted"
	// Plaintext ...
	Plaintext Protocol = "Plaintext"
)

func PossibleProtocolValues

func PossibleProtocolValues() []Protocol

PossibleProtocolValues returns an array of possible values for the Protocol const type.

type ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// ProvisioningStateCanceled ...
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateCreating ...
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateDeleting ...
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUpdating ...
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type ProxyResource

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"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type RegenerateKeyParameters

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

RegenerateKeyParameters specifies which access keys to reset to a new random value.

type Resource

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"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

type ResourceState

type ResourceState string

ResourceState enumerates the values for resource state.

const (
	// ResourceStateCreateFailed ...
	ResourceStateCreateFailed ResourceState = "CreateFailed"
	// ResourceStateCreating ...
	ResourceStateCreating ResourceState = "Creating"
	// ResourceStateDeleteFailed ...
	ResourceStateDeleteFailed ResourceState = "DeleteFailed"
	// ResourceStateDeleting ...
	ResourceStateDeleting ResourceState = "Deleting"
	// ResourceStateDisabled ...
	ResourceStateDisabled ResourceState = "Disabled"
	// ResourceStateDisableFailed ...
	ResourceStateDisableFailed ResourceState = "DisableFailed"
	// ResourceStateDisabling ...
	ResourceStateDisabling ResourceState = "Disabling"
	// ResourceStateEnableFailed ...
	ResourceStateEnableFailed ResourceState = "EnableFailed"
	// ResourceStateEnabling ...
	ResourceStateEnabling ResourceState = "Enabling"
	// ResourceStateRunning ...
	ResourceStateRunning ResourceState = "Running"
	// ResourceStateUpdateFailed ...
	ResourceStateUpdateFailed ResourceState = "UpdateFailed"
	// ResourceStateUpdating ...
	ResourceStateUpdating ResourceState = "Updating"
)

func PossibleResourceStateValues

func PossibleResourceStateValues() []ResourceState

PossibleResourceStateValues returns an array of possible values for the ResourceState const type.

type Sku

type Sku struct {
	// Name - The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.). Possible values include: 'EnterpriseE10', 'EnterpriseE20', 'EnterpriseE50', 'EnterpriseE100', 'EnterpriseFlashF300', 'EnterpriseFlashF700', 'EnterpriseFlashF1500'
	Name SkuName `json:"name,omitempty"`
	// Capacity - The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.
	Capacity *int32 `json:"capacity,omitempty"`
}

Sku SKU parameters supplied to the create RedisEnterprise operation.

type SkuName

type SkuName string

SkuName enumerates the values for sku name.

const (
	// EnterpriseE10 ...
	EnterpriseE10 SkuName = "Enterprise_E10"
	// EnterpriseE100 ...
	EnterpriseE100 SkuName = "Enterprise_E100"
	// EnterpriseE20 ...
	EnterpriseE20 SkuName = "Enterprise_E20"
	// EnterpriseE50 ...
	EnterpriseE50 SkuName = "Enterprise_E50"
	// EnterpriseFlashF1500 ...
	EnterpriseFlashF1500 SkuName = "EnterpriseFlash_F1500"
	// EnterpriseFlashF300 ...
	EnterpriseFlashF300 SkuName = "EnterpriseFlash_F300"
	// EnterpriseFlashF700 ...
	EnterpriseFlashF700 SkuName = "EnterpriseFlash_F700"
)

func PossibleSkuNameValues

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type TrackedResource

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"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type UpdateFuture

type UpdateFuture 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) (Cluster, error)
}

UpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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