redisenterprise

package
v0.20240524.1090207 Latest Latest
Warning

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

Go to latest
Published: May 24, 2024 License: MPL-2.0 Imports: 16 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/redisenterprise/2023-10-01-preview/redisenterprise Documentation

The redisenterprise SDK allows for interaction with the Azure Resource Manager Service redisenterprise (API Version 2023-10-01-preview).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/redisenterprise/2023-10-01-preview/redisenterprise"

Client Initialization

client := redisenterprise.NewRedisEnterpriseClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RedisEnterpriseClient.CheckNameAvailability

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := redisenterprise.CheckNameAvailabilityParameters{
	// ...
}


read, err := client.CheckNameAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: RedisEnterpriseClient.Create

ctx := context.TODO()
id := redisenterprise.NewRedisEnterpriseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue")

payload := redisenterprise.Cluster{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.DatabasesCreate

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

payload := redisenterprise.Database{
	// ...
}


if err := client.DatabasesCreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.DatabasesDelete

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

if err := client.DatabasesDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.DatabasesExport

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

payload := redisenterprise.ExportClusterParameters{
	// ...
}


if err := client.DatabasesExportThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.DatabasesFlush

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

payload := redisenterprise.FlushParameters{
	// ...
}


if err := client.DatabasesFlushThenPoll(ctx, id, payload); err != nil {
	// handle the error
}
ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

payload := redisenterprise.ForceUnlinkParameters{
	// ...
}


if err := client.DatabasesForceUnlinkThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.DatabasesGet

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

read, err := client.DatabasesGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: RedisEnterpriseClient.DatabasesImport

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

payload := redisenterprise.ImportClusterParameters{
	// ...
}


if err := client.DatabasesImportThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.DatabasesListByCluster

ctx := context.TODO()
id := redisenterprise.NewRedisEnterpriseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue")

// alternatively `client.DatabasesListByCluster(ctx, id)` can be used to do batched pagination
items, err := client.DatabasesListByClusterComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: RedisEnterpriseClient.DatabasesListKeys

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

read, err := client.DatabasesListKeys(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: RedisEnterpriseClient.DatabasesRegenerateKey

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

payload := redisenterprise.RegenerateKeyParameters{
	// ...
}


if err := client.DatabasesRegenerateKeyThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.DatabasesUpdate

ctx := context.TODO()
id := redisenterprise.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue", "databaseValue")

payload := redisenterprise.DatabaseUpdate{
	// ...
}


if err := client.DatabasesUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.Delete

ctx := context.TODO()
id := redisenterprise.NewRedisEnterpriseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: RedisEnterpriseClient.Get

ctx := context.TODO()
id := redisenterprise.NewRedisEnterpriseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: RedisEnterpriseClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: RedisEnterpriseClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: RedisEnterpriseClient.Update

ctx := context.TODO()
id := redisenterprise.NewRedisEnterpriseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "redisEnterpriseValue")

payload := redisenterprise.ClusterUpdate{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessKeyType

func PossibleValuesForAccessKeyType() []string

func PossibleValuesForAofFrequency

func PossibleValuesForAofFrequency() []string

func PossibleValuesForClusteringPolicy

func PossibleValuesForClusteringPolicy() []string

func PossibleValuesForCmkIdentityType

func PossibleValuesForCmkIdentityType() []string

func PossibleValuesForEvictionPolicy

func PossibleValuesForEvictionPolicy() []string

func PossibleValuesForLinkState

func PossibleValuesForLinkState() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForProtocol

func PossibleValuesForProtocol() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForRdbFrequency

func PossibleValuesForRdbFrequency() []string

func PossibleValuesForResourceState

func PossibleValuesForResourceState() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForTlsVersion

func PossibleValuesForTlsVersion() []string

func ValidateDatabaseID

func ValidateDatabaseID(input interface{}, key string) (warnings []string, errors []error)

ValidateDatabaseID checks that 'input' can be parsed as a Database ID

func ValidateRedisEnterpriseID

func ValidateRedisEnterpriseID(input interface{}, key string) (warnings []string, errors []error)

ValidateRedisEnterpriseID checks that 'input' can be parsed as a Redis Enterprise ID

Types

type AccessKeyType

type AccessKeyType string
const (
	AccessKeyTypePrimary   AccessKeyType = "Primary"
	AccessKeyTypeSecondary AccessKeyType = "Secondary"
)

func (*AccessKeyType) UnmarshalJSON

func (s *AccessKeyType) UnmarshalJSON(bytes []byte) error

type AccessKeys

type AccessKeys struct {
	PrimaryKey   *string `json:"primaryKey,omitempty"`
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

type AofFrequency

type AofFrequency string
const (
	AofFrequencyAlways AofFrequency = "always"
	AofFrequencyOnes   AofFrequency = "1s"
)

func (*AofFrequency) UnmarshalJSON

func (s *AofFrequency) UnmarshalJSON(bytes []byte) error

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type CheckNameAvailabilityParameters

type CheckNameAvailabilityParameters struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type Cluster

type Cluster struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ClusterProperties                 `json:"properties,omitempty"`
	Sku        Sku                                `json:"sku"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
	Zones      *zones.Schema                      `json:"zones,omitempty"`
}

type ClusterOperationPredicate

type ClusterOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ClusterOperationPredicate) Matches

func (p ClusterOperationPredicate) Matches(input Cluster) bool

type ClusterProperties

type ClusterProperties struct {
	Encryption                 *ClusterPropertiesEncryption `json:"encryption,omitempty"`
	HostName                   *string                      `json:"hostName,omitempty"`
	MinimumTlsVersion          *TlsVersion                  `json:"minimumTlsVersion,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *ProvisioningState           `json:"provisioningState,omitempty"`
	RedisVersion               *string                      `json:"redisVersion,omitempty"`
	ResourceState              *ResourceState               `json:"resourceState,omitempty"`
}

type ClusterPropertiesEncryption

type ClusterPropertiesEncryption struct {
	CustomerManagedKeyEncryption *ClusterPropertiesEncryptionCustomerManagedKeyEncryption `json:"customerManagedKeyEncryption,omitempty"`
}

type ClusterPropertiesEncryptionCustomerManagedKeyEncryption

type ClusterPropertiesEncryptionCustomerManagedKeyEncryption struct {
	KeyEncryptionKeyIdentity *ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyEncryptionKeyIdentity `json:"keyEncryptionKeyIdentity,omitempty"`
	KeyEncryptionKeyUrl      *string                                                                          `json:"keyEncryptionKeyUrl,omitempty"`
}

type ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyEncryptionKeyIdentity

type ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyEncryptionKeyIdentity struct {
	IdentityType                   *CmkIdentityType `json:"identityType,omitempty"`
	UserAssignedIdentityResourceId *string          `json:"userAssignedIdentityResourceId,omitempty"`
}

type ClusterUpdate

type ClusterUpdate struct {
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *ClusterProperties                 `json:"properties,omitempty"`
	Sku        *Sku                               `json:"sku,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type ClusteringPolicy

type ClusteringPolicy string
const (
	ClusteringPolicyEnterpriseCluster ClusteringPolicy = "EnterpriseCluster"
	ClusteringPolicyOSSCluster        ClusteringPolicy = "OSSCluster"
)

func (*ClusteringPolicy) UnmarshalJSON

func (s *ClusteringPolicy) UnmarshalJSON(bytes []byte) error

type CmkIdentityType

type CmkIdentityType string
const (
	CmkIdentityTypeSystemAssignedIdentity CmkIdentityType = "systemAssignedIdentity"
	CmkIdentityTypeUserAssignedIdentity   CmkIdentityType = "userAssignedIdentity"
)

func (*CmkIdentityType) UnmarshalJSON

func (s *CmkIdentityType) UnmarshalJSON(bytes []byte) error

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Cluster
}

type Database

type Database struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *DatabaseProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type DatabaseId

type DatabaseId struct {
	SubscriptionId      string
	ResourceGroupName   string
	RedisEnterpriseName string
	DatabaseName        string
}

DatabaseId is a struct representing the Resource ID for a Database

func NewDatabaseID

func NewDatabaseID(subscriptionId string, resourceGroupName string, redisEnterpriseName string, databaseName string) DatabaseId

NewDatabaseID returns a new DatabaseId struct

func ParseDatabaseID

func ParseDatabaseID(input string) (*DatabaseId, error)

ParseDatabaseID parses 'input' into a DatabaseId

func ParseDatabaseIDInsensitively

func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)

ParseDatabaseIDInsensitively parses 'input' case-insensitively into a DatabaseId note: this method should only be used for API response data and not user input

func (*DatabaseId) FromParseResult

func (id *DatabaseId) FromParseResult(input resourceids.ParseResult) error

func (DatabaseId) ID

func (id DatabaseId) ID() string

ID returns the formatted Database ID

func (DatabaseId) Segments

func (id DatabaseId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Database ID

func (DatabaseId) String

func (id DatabaseId) String() string

String returns a human-readable description of this Database ID

type DatabaseOperationPredicate

type DatabaseOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (DatabaseOperationPredicate) Matches

func (p DatabaseOperationPredicate) Matches(input Database) bool

type DatabaseProperties

type DatabaseProperties struct {
	ClientProtocol    *Protocol                         `json:"clientProtocol,omitempty"`
	ClusteringPolicy  *ClusteringPolicy                 `json:"clusteringPolicy,omitempty"`
	EvictionPolicy    *EvictionPolicy                   `json:"evictionPolicy,omitempty"`
	GeoReplication    *DatabasePropertiesGeoReplication `json:"geoReplication,omitempty"`
	Modules           *[]Module                         `json:"modules,omitempty"`
	Persistence       *Persistence                      `json:"persistence,omitempty"`
	Port              *int64                            `json:"port,omitempty"`
	ProvisioningState *ProvisioningState                `json:"provisioningState,omitempty"`
	ResourceState     *ResourceState                    `json:"resourceState,omitempty"`
}

type DatabasePropertiesGeoReplication

type DatabasePropertiesGeoReplication struct {
	GroupNickname   *string           `json:"groupNickname,omitempty"`
	LinkedDatabases *[]LinkedDatabase `json:"linkedDatabases,omitempty"`
}

type DatabaseUpdate

type DatabaseUpdate struct {
	Properties *DatabaseProperties `json:"properties,omitempty"`
}

type DatabasesCreateOperationResponse

type DatabasesCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Database
}

type DatabasesDeleteOperationResponse

type DatabasesDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DatabasesExportOperationResponse

type DatabasesExportOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DatabasesFlushOperationResponse

type DatabasesFlushOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DatabasesForceUnlinkOperationResponse

type DatabasesForceUnlinkOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DatabasesGetOperationResponse

type DatabasesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Database
}

type DatabasesImportOperationResponse

type DatabasesImportOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DatabasesListByClusterCompleteResult

type DatabasesListByClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Database
}

type DatabasesListByClusterOperationResponse

type DatabasesListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Database
}

type DatabasesListKeysOperationResponse

type DatabasesListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccessKeys
}

type DatabasesRegenerateKeyOperationResponse

type DatabasesRegenerateKeyOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccessKeys
}

type DatabasesUpdateOperationResponse

type DatabasesUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Database
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type EvictionPolicy

type EvictionPolicy string
const (
	EvictionPolicyAllKeysLFU     EvictionPolicy = "AllKeysLFU"
	EvictionPolicyAllKeysLRU     EvictionPolicy = "AllKeysLRU"
	EvictionPolicyAllKeysRandom  EvictionPolicy = "AllKeysRandom"
	EvictionPolicyNoEviction     EvictionPolicy = "NoEviction"
	EvictionPolicyVolatileLFU    EvictionPolicy = "VolatileLFU"
	EvictionPolicyVolatileLRU    EvictionPolicy = "VolatileLRU"
	EvictionPolicyVolatileRandom EvictionPolicy = "VolatileRandom"
	EvictionPolicyVolatileTTL    EvictionPolicy = "VolatileTTL"
)

func (*EvictionPolicy) UnmarshalJSON

func (s *EvictionPolicy) UnmarshalJSON(bytes []byte) error

type ExportClusterParameters

type ExportClusterParameters struct {
	SasUri string `json:"sasUri"`
}

type FlushParameters

type FlushParameters struct {
	Ids *[]string `json:"ids,omitempty"`
}

type ForceUnlinkParameters

type ForceUnlinkParameters struct {
	Ids []string `json:"ids"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Cluster
}

type ImportClusterParameters

type ImportClusterParameters struct {
	SasUris []string `json:"sasUris"`
}

type LinkState

type LinkState string
const (
	LinkStateLinkFailed   LinkState = "LinkFailed"
	LinkStateLinked       LinkState = "Linked"
	LinkStateLinking      LinkState = "Linking"
	LinkStateUnlinkFailed LinkState = "UnlinkFailed"
	LinkStateUnlinking    LinkState = "Unlinking"
)

func (*LinkState) UnmarshalJSON

func (s *LinkState) UnmarshalJSON(bytes []byte) error

type LinkedDatabase

type LinkedDatabase struct {
	Id    *string    `json:"id,omitempty"`
	State *LinkState `json:"state,omitempty"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Cluster
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Cluster
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Cluster
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Cluster
}

type Module

type Module struct {
	Args    *string `json:"args,omitempty"`
	Name    string  `json:"name"`
	Version *string `json:"version,omitempty"`
}

type Persistence

type Persistence struct {
	AofEnabled   *bool         `json:"aofEnabled,omitempty"`
	AofFrequency *AofFrequency `json:"aofFrequency,omitempty"`
	RdbEnabled   *bool         `json:"rdbEnabled,omitempty"`
	RdbFrequency *RdbFrequency `json:"rdbFrequency,omitempty"`
}

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON

func (s *PrivateEndpointConnectionProvisioningState) UnmarshalJSON(bytes []byte) error

type PrivateEndpointServiceConnectionStatus

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON

func (s *PrivateEndpointServiceConnectionStatus) UnmarshalJSON(bytes []byte) error

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type Protocol

type Protocol string
const (
	ProtocolEncrypted Protocol = "Encrypted"
	ProtocolPlaintext Protocol = "Plaintext"
)

func (*Protocol) UnmarshalJSON

func (s *Protocol) UnmarshalJSON(bytes []byte) error

type ProvisioningState

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

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type RdbFrequency

type RdbFrequency string
const (
	RdbFrequencyOneTwoh RdbFrequency = "12h"
	RdbFrequencyOneh    RdbFrequency = "1h"
	RdbFrequencySixh    RdbFrequency = "6h"
)

func (*RdbFrequency) UnmarshalJSON

func (s *RdbFrequency) UnmarshalJSON(bytes []byte) error

type RedisEnterpriseClient

type RedisEnterpriseClient struct {
	Client *resourcemanager.Client
}

func NewRedisEnterpriseClientWithBaseURI

func NewRedisEnterpriseClientWithBaseURI(sdkApi sdkEnv.Api) (*RedisEnterpriseClient, error)

func (RedisEnterpriseClient) CheckNameAvailability

CheckNameAvailability ...

func (RedisEnterpriseClient) Create

Create ...

func (RedisEnterpriseClient) CreateThenPoll

func (c RedisEnterpriseClient) CreateThenPoll(ctx context.Context, id RedisEnterpriseId, input Cluster) error

CreateThenPoll performs Create then polls until it's completed

func (RedisEnterpriseClient) DatabasesCreate

func (c RedisEnterpriseClient) DatabasesCreate(ctx context.Context, id DatabaseId, input Database) (result DatabasesCreateOperationResponse, err error)

DatabasesCreate ...

func (RedisEnterpriseClient) DatabasesCreateThenPoll

func (c RedisEnterpriseClient) DatabasesCreateThenPoll(ctx context.Context, id DatabaseId, input Database) error

DatabasesCreateThenPoll performs DatabasesCreate then polls until it's completed

func (RedisEnterpriseClient) DatabasesDelete

func (c RedisEnterpriseClient) DatabasesDelete(ctx context.Context, id DatabaseId) (result DatabasesDeleteOperationResponse, err error)

DatabasesDelete ...

func (RedisEnterpriseClient) DatabasesDeleteThenPoll

func (c RedisEnterpriseClient) DatabasesDeleteThenPoll(ctx context.Context, id DatabaseId) error

DatabasesDeleteThenPoll performs DatabasesDelete then polls until it's completed

func (RedisEnterpriseClient) DatabasesExport

DatabasesExport ...

func (RedisEnterpriseClient) DatabasesExportThenPoll

func (c RedisEnterpriseClient) DatabasesExportThenPoll(ctx context.Context, id DatabaseId, input ExportClusterParameters) error

DatabasesExportThenPoll performs DatabasesExport then polls until it's completed

func (RedisEnterpriseClient) DatabasesFlush

DatabasesFlush ...

func (RedisEnterpriseClient) DatabasesFlushThenPoll

func (c RedisEnterpriseClient) DatabasesFlushThenPoll(ctx context.Context, id DatabaseId, input FlushParameters) error

DatabasesFlushThenPoll performs DatabasesFlush then polls until it's completed

DatabasesForceUnlink ...

func (RedisEnterpriseClient) DatabasesForceUnlinkThenPoll

func (c RedisEnterpriseClient) DatabasesForceUnlinkThenPoll(ctx context.Context, id DatabaseId, input ForceUnlinkParameters) error

DatabasesForceUnlinkThenPoll performs DatabasesForceUnlink then polls until it's completed

func (RedisEnterpriseClient) DatabasesGet

DatabasesGet ...

func (RedisEnterpriseClient) DatabasesImport

DatabasesImport ...

func (RedisEnterpriseClient) DatabasesImportThenPoll

func (c RedisEnterpriseClient) DatabasesImportThenPoll(ctx context.Context, id DatabaseId, input ImportClusterParameters) error

DatabasesImportThenPoll performs DatabasesImport then polls until it's completed

func (RedisEnterpriseClient) DatabasesListByCluster

DatabasesListByCluster ...

func (RedisEnterpriseClient) DatabasesListByClusterComplete

DatabasesListByClusterComplete retrieves all the results into a single object

func (RedisEnterpriseClient) DatabasesListByClusterCompleteMatchingPredicate

func (c RedisEnterpriseClient) DatabasesListByClusterCompleteMatchingPredicate(ctx context.Context, id RedisEnterpriseId, predicate DatabaseOperationPredicate) (result DatabasesListByClusterCompleteResult, err error)

DatabasesListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RedisEnterpriseClient) DatabasesListKeys

func (c RedisEnterpriseClient) DatabasesListKeys(ctx context.Context, id DatabaseId) (result DatabasesListKeysOperationResponse, err error)

DatabasesListKeys ...

func (RedisEnterpriseClient) DatabasesRegenerateKey

DatabasesRegenerateKey ...

func (RedisEnterpriseClient) DatabasesRegenerateKeyThenPoll

func (c RedisEnterpriseClient) DatabasesRegenerateKeyThenPoll(ctx context.Context, id DatabaseId, input RegenerateKeyParameters) error

DatabasesRegenerateKeyThenPoll performs DatabasesRegenerateKey then polls until it's completed

func (RedisEnterpriseClient) DatabasesUpdate

DatabasesUpdate ...

func (RedisEnterpriseClient) DatabasesUpdateThenPoll

func (c RedisEnterpriseClient) DatabasesUpdateThenPoll(ctx context.Context, id DatabaseId, input DatabaseUpdate) error

DatabasesUpdateThenPoll performs DatabasesUpdate then polls until it's completed

func (RedisEnterpriseClient) Delete

Delete ...

func (RedisEnterpriseClient) DeleteThenPoll

func (c RedisEnterpriseClient) DeleteThenPoll(ctx context.Context, id RedisEnterpriseId) error

DeleteThenPoll performs Delete then polls until it's completed

func (RedisEnterpriseClient) Get

Get ...

func (RedisEnterpriseClient) List

List ...

func (RedisEnterpriseClient) ListByResourceGroup

ListByResourceGroup ...

func (RedisEnterpriseClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (RedisEnterpriseClient) ListByResourceGroupCompleteMatchingPredicate

func (c RedisEnterpriseClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ClusterOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RedisEnterpriseClient) ListComplete

ListComplete retrieves all the results into a single object

func (RedisEnterpriseClient) ListCompleteMatchingPredicate

func (c RedisEnterpriseClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ClusterOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RedisEnterpriseClient) Update

Update ...

func (RedisEnterpriseClient) UpdateThenPoll

func (c RedisEnterpriseClient) UpdateThenPoll(ctx context.Context, id RedisEnterpriseId, input ClusterUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type RedisEnterpriseId

type RedisEnterpriseId struct {
	SubscriptionId      string
	ResourceGroupName   string
	RedisEnterpriseName string
}

RedisEnterpriseId is a struct representing the Resource ID for a Redis Enterprise

func NewRedisEnterpriseID

func NewRedisEnterpriseID(subscriptionId string, resourceGroupName string, redisEnterpriseName string) RedisEnterpriseId

NewRedisEnterpriseID returns a new RedisEnterpriseId struct

func ParseRedisEnterpriseID

func ParseRedisEnterpriseID(input string) (*RedisEnterpriseId, error)

ParseRedisEnterpriseID parses 'input' into a RedisEnterpriseId

func ParseRedisEnterpriseIDInsensitively

func ParseRedisEnterpriseIDInsensitively(input string) (*RedisEnterpriseId, error)

ParseRedisEnterpriseIDInsensitively parses 'input' case-insensitively into a RedisEnterpriseId note: this method should only be used for API response data and not user input

func (*RedisEnterpriseId) FromParseResult

func (id *RedisEnterpriseId) FromParseResult(input resourceids.ParseResult) error

func (RedisEnterpriseId) ID

func (id RedisEnterpriseId) ID() string

ID returns the formatted Redis Enterprise ID

func (RedisEnterpriseId) Segments

func (id RedisEnterpriseId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Redis Enterprise ID

func (RedisEnterpriseId) String

func (id RedisEnterpriseId) String() string

String returns a human-readable description of this Redis Enterprise ID

type RegenerateKeyParameters

type RegenerateKeyParameters struct {
	KeyType AccessKeyType `json:"keyType"`
}

type ResourceState

type ResourceState string
const (
	ResourceStateCreateFailed  ResourceState = "CreateFailed"
	ResourceStateCreating      ResourceState = "Creating"
	ResourceStateDeleteFailed  ResourceState = "DeleteFailed"
	ResourceStateDeleting      ResourceState = "Deleting"
	ResourceStateDisableFailed ResourceState = "DisableFailed"
	ResourceStateDisabled      ResourceState = "Disabled"
	ResourceStateDisabling     ResourceState = "Disabling"
	ResourceStateEnableFailed  ResourceState = "EnableFailed"
	ResourceStateEnabling      ResourceState = "Enabling"
	ResourceStateRunning       ResourceState = "Running"
	ResourceStateScaling       ResourceState = "Scaling"
	ResourceStateScalingFailed ResourceState = "ScalingFailed"
	ResourceStateUpdateFailed  ResourceState = "UpdateFailed"
	ResourceStateUpdating      ResourceState = "Updating"
)

func (*ResourceState) UnmarshalJSON

func (s *ResourceState) UnmarshalJSON(bytes []byte) error

type Sku

type Sku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Name     SkuName `json:"name"`
}

type SkuName

type SkuName string
const (
	SkuNameEnterpriseEFive                SkuName = "Enterprise_E5"
	SkuNameEnterpriseEFiveZero            SkuName = "Enterprise_E50"
	SkuNameEnterpriseEFourHundred         SkuName = "Enterprise_E400"
	SkuNameEnterpriseEOneHundred          SkuName = "Enterprise_E100"
	SkuNameEnterpriseEOneZero             SkuName = "Enterprise_E10"
	SkuNameEnterpriseETwoHundred          SkuName = "Enterprise_E200"
	SkuNameEnterpriseETwoZero             SkuName = "Enterprise_E20"
	SkuNameEnterpriseFlashFOneFiveHundred SkuName = "EnterpriseFlash_F1500"
	SkuNameEnterpriseFlashFSevenHundred   SkuName = "EnterpriseFlash_F700"
	SkuNameEnterpriseFlashFThreeHundred   SkuName = "EnterpriseFlash_F300"
)

func (*SkuName) UnmarshalJSON

func (s *SkuName) UnmarshalJSON(bytes []byte) error

type TlsVersion

type TlsVersion string
const (
	TlsVersionOnePointOne  TlsVersion = "1.1"
	TlsVersionOnePointTwo  TlsVersion = "1.2"
	TlsVersionOnePointZero TlsVersion = "1.0"
)

func (*TlsVersion) UnmarshalJSON

func (s *TlsVersion) UnmarshalJSON(bytes []byte) error

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Cluster
}

Jump to

Keyboard shortcuts

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