Share via


@azure/arm-redisenterprisecache package

Classes

RedisEnterpriseManagementClient

Interfaces

AccessKeys

The secret access keys used for authenticating connections to redis

AccessPolicyAssignment

Describes the access policy assignment of Redis Enterprise database

AccessPolicyAssignmentCreateUpdateOptionalParams

Optional parameters.

AccessPolicyAssignmentDeleteHeaders

Defines headers for AccessPolicyAssignment_delete operation.

AccessPolicyAssignmentDeleteOptionalParams

Optional parameters.

AccessPolicyAssignmentGetOptionalParams

Optional parameters.

AccessPolicyAssignmentList

The response of a list-all operation.

AccessPolicyAssignmentListNextOptionalParams

Optional parameters.

AccessPolicyAssignmentListOptionalParams

Optional parameters.

AccessPolicyAssignmentOperations

Interface representing a AccessPolicyAssignmentOperations.

AccessPolicyAssignmentPropertiesUser

The user associated with the access policy.

Cluster

Describes the Redis Enterprise cluster

ClusterCommonProperties

Properties of Redis Enterprise clusters, as opposed to general resource properties like location, tags

ClusterCommonPropertiesEncryption

Encryption-at-rest configuration for the cluster.

ClusterCommonPropertiesEncryptionCustomerManagedKeyEncryption

All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.

ClusterCommonPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

ClusterCreateProperties

Properties of Redis Enterprise clusters for create operations

ClusterList

The response of a list-all operation.

ClusterUpdate

A partial update to the Redis Enterprise cluster

ClusterUpdateProperties

Properties of Redis Enterprise clusters for update operations

Database

Describes a database on the Redis Enterprise cluster

DatabaseCommonProperties

Properties of Redis Enterprise databases, as opposed to general resource properties like location, tags

DatabaseCommonPropertiesGeoReplication

Optional set of properties to configure geo replication for this database.

DatabaseCreateProperties

Properties for creating Redis Enterprise databases

DatabaseList

The response of a list-all operation.

DatabaseUpdate

A partial update to the Redis Enterprise database

DatabaseUpdateProperties

Properties for updating Redis Enterprise databases

Databases

Interface representing a Databases.

DatabasesCreateOptionalParams

Optional parameters.

DatabasesDeleteHeaders

Defines headers for Databases_delete operation.

DatabasesDeleteOptionalParams

Optional parameters.

DatabasesExportHeaders

Defines headers for Databases_export operation.

DatabasesExportOptionalParams

Optional parameters.

DatabasesFlushHeaders

Defines headers for Databases_flush operation.

DatabasesFlushOptionalParams

Optional parameters.

DatabasesForceLinkToReplicationGroupHeaders

Defines headers for Databases_forceLinkToReplicationGroup operation.

DatabasesForceLinkToReplicationGroupOptionalParams

Optional parameters.

DatabasesForceUnlinkHeaders

Defines headers for Databases_forceUnlink operation.

DatabasesForceUnlinkOptionalParams

Optional parameters.

DatabasesGetOptionalParams

Optional parameters.

DatabasesImportHeaders

Defines headers for Databases_import operation.

DatabasesImportOptionalParams

Optional parameters.

DatabasesListByClusterNextOptionalParams

Optional parameters.

DatabasesListByClusterOptionalParams

Optional parameters.

DatabasesListKeysOptionalParams

Optional parameters.

DatabasesRegenerateKeyHeaders

Defines headers for Databases_regenerateKey operation.

DatabasesRegenerateKeyOptionalParams

Optional parameters.

DatabasesUpdateHeaders

Defines headers for Databases_update operation.

DatabasesUpdateOptionalParams

Optional parameters.

DatabasesUpgradeDBRedisVersionHeaders

Defines headers for Databases_upgradeDBRedisVersion operation.

DatabasesUpgradeDBRedisVersionOptionalParams

Optional parameters.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorDetailAutoGenerated

The error detail.

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

ErrorResponseAutoGenerated

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

ExportClusterParameters

Parameters for a Redis Enterprise export operation.

FlushParameters

Parameters for a Redis Enterprise active geo-replication flush operation

ForceLinkParameters

Parameters for reconfiguring active geo-replication, of an existing database that was previously unlinked from a replication group.

ForceLinkParametersGeoReplication

Properties to configure geo replication for this database.

ForceUnlinkParameters

Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation.

ImportClusterParameters

Parameters for a Redis Enterprise import operation.

LinkedDatabase

Specifies details of a linked database resource.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Module

Specifies configuration of a redis module

Operation

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

OperationDisplay

Localized display information for this particular operation.

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.

OperationStatus

The status of a long-running operation.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OperationsStatus

Interface representing a OperationsStatus.

OperationsStatusGetOptionalParams

Optional parameters.

Persistence

Persistence-related configuration for the Redis Enterprise database

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified storage account

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteHeaders

Defines headers for PrivateEndpointConnections_delete operation.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateEndpointConnectionsPutOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesListByClusterOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

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

ProxyResource

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

ProxyResourceAutoGenerated

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

RedisEnterprise

Interface representing a RedisEnterprise.

RedisEnterpriseCreateOptionalParams

Optional parameters.

RedisEnterpriseDeleteHeaders

Defines headers for RedisEnterprise_delete operation.

RedisEnterpriseDeleteOptionalParams

Optional parameters.

RedisEnterpriseGetOptionalParams

Optional parameters.

RedisEnterpriseListByResourceGroupNextOptionalParams

Optional parameters.

RedisEnterpriseListByResourceGroupOptionalParams

Optional parameters.

RedisEnterpriseListNextOptionalParams

Optional parameters.

RedisEnterpriseListOptionalParams

Optional parameters.

RedisEnterpriseListSkusForScalingOptionalParams

Optional parameters.

RedisEnterpriseManagementClientOptionalParams

Optional parameters.

RedisEnterpriseUpdateHeaders

Defines headers for RedisEnterprise_update operation.

RedisEnterpriseUpdateOptionalParams

Optional parameters.

RegenerateKeyParameters

Specifies which access keys to reset to a new random value.

Resource

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

ResourceAutoGenerated

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

Sku

SKU parameters supplied to the create Redis Enterprise cluster operation.

SkuDetails

Details of a Redis Enterprise cluster SKU.

SkuDetailsList

The response of a listSkusForScaling operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

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

UserAssignedIdentity

User assigned identity properties

Type Aliases

AccessKeyType

Defines values for AccessKeyType.

AccessKeysAuthentication

Defines values for AccessKeysAuthentication.
KnownAccessKeysAuthentication can be used interchangeably with AccessKeysAuthentication, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

AccessPolicyAssignmentCreateUpdateResponse

Contains response data for the createUpdate operation.

AccessPolicyAssignmentDeleteResponse

Contains response data for the delete operation.

AccessPolicyAssignmentGetResponse

Contains response data for the get operation.

AccessPolicyAssignmentListNextResponse

Contains response data for the listNext operation.

AccessPolicyAssignmentListResponse

Contains response data for the list operation.

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

AofFrequency

Defines values for AofFrequency.
KnownAofFrequency can be used interchangeably with AofFrequency, this enum contains the known values that the service supports.

Known values supported by the service

1s
always

ClusteringPolicy

Defines values for ClusteringPolicy.
KnownClusteringPolicy can be used interchangeably with ClusteringPolicy, this enum contains the known values that the service supports.

Known values supported by the service

EnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands.
OSSCluster: OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering.
NoCluster: The NoCluster policy is used for non-clustered Redis instances that do not require clustering features.

CmkIdentityType

Defines values for CmkIdentityType.
KnownCmkIdentityType can be used interchangeably with CmkIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

systemAssignedIdentity
userAssignedIdentity

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DatabasesCreateResponse

Contains response data for the create operation.

DatabasesForceLinkToReplicationGroupResponse

Contains response data for the forceLinkToReplicationGroup operation.

DatabasesGetResponse

Contains response data for the get operation.

DatabasesListByClusterNextResponse

Contains response data for the listByClusterNext operation.

DatabasesListByClusterResponse

Contains response data for the listByCluster operation.

DatabasesListKeysResponse

Contains response data for the listKeys operation.

DatabasesRegenerateKeyResponse

Contains response data for the regenerateKey operation.

DatabasesUpdateResponse

Contains response data for the update operation.

DatabasesUpgradeDBRedisVersionResponse

Contains response data for the upgradeDBRedisVersion operation.

DeferUpgradeSetting

Defines values for DeferUpgradeSetting.
KnownDeferUpgradeSetting can be used interchangeably with DeferUpgradeSetting, this enum contains the known values that the service supports.

Known values supported by the service

Deferred
NotDeferred

EvictionPolicy

Defines values for EvictionPolicy.
KnownEvictionPolicy can be used interchangeably with EvictionPolicy, this enum contains the known values that the service supports.

Known values supported by the service

AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

HighAvailability

Defines values for HighAvailability.
KnownHighAvailability can be used interchangeably with HighAvailability, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

Kind

Defines values for Kind.
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

v1
v2

LinkState

Defines values for LinkState.
KnownLinkState can be used interchangeably with LinkState, this enum contains the known values that the service supports.

Known values supported by the service

Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

OperationsStatusGetResponse

Contains response data for the get operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateEndpointConnectionsPutResponse

Contains response data for the put operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

PrivateLinkResourcesListByClusterResponse

Contains response data for the listByCluster operation.

Protocol

Defines values for Protocol.
KnownProtocol can be used interchangeably with Protocol, this enum contains the known values that the service supports.

Known values supported by the service

Encrypted
Plaintext

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled
Creating
Updating
Deleting

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

RdbFrequency

Defines values for RdbFrequency.
KnownRdbFrequency can be used interchangeably with RdbFrequency, this enum contains the known values that the service supports.

Known values supported by the service

1h
6h
12h

RedisEnterpriseCreateResponse

Contains response data for the create operation.

RedisEnterpriseGetResponse

Contains response data for the get operation.

RedisEnterpriseListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

RedisEnterpriseListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

RedisEnterpriseListNextResponse

Contains response data for the listNext operation.

RedisEnterpriseListResponse

Contains response data for the list operation.

RedisEnterpriseListSkusForScalingResponse

Contains response data for the listSkusForScaling operation.

RedisEnterpriseUpdateResponse

Contains response data for the update operation.

RedundancyMode

Defines values for RedundancyMode.
KnownRedundancyMode can be used interchangeably with RedundancyMode, this enum contains the known values that the service supports.

Known values supported by the service

None: No redundancy. Availability loss will occur.
LR: Local redundancy with high availability.
ZR: Zone redundant. Higher availability.

ResourceState

Defines values for ResourceState.
KnownResourceState can be used interchangeably with ResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Running
Creating
CreateFailed
Updating
UpdateFailed
Deleting
DeleteFailed
Enabling
EnableFailed
Disabling
DisableFailed
Disabled
Scaling
ScalingFailed
Moving

SkuName

Defines values for SkuName.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

Enterprise_E1
Enterprise_E5
Enterprise_E10
Enterprise_E20
Enterprise_E50
Enterprise_E100
Enterprise_E200
Enterprise_E400
EnterpriseFlash_F300
EnterpriseFlash_F700
EnterpriseFlash_F1500
Balanced_B0
Balanced_B1
Balanced_B3
Balanced_B5
Balanced_B10
Balanced_B20
Balanced_B50
Balanced_B100
Balanced_B150
Balanced_B250
Balanced_B350
Balanced_B500
Balanced_B700
Balanced_B1000
MemoryOptimized_M10
MemoryOptimized_M20
MemoryOptimized_M50
MemoryOptimized_M100
MemoryOptimized_M150
MemoryOptimized_M250
MemoryOptimized_M350
MemoryOptimized_M500
MemoryOptimized_M700
MemoryOptimized_M1000
MemoryOptimized_M1500
MemoryOptimized_M2000
ComputeOptimized_X3
ComputeOptimized_X5
ComputeOptimized_X10
ComputeOptimized_X20
ComputeOptimized_X50
ComputeOptimized_X100
ComputeOptimized_X150
ComputeOptimized_X250
ComputeOptimized_X350
ComputeOptimized_X500
ComputeOptimized_X700
FlashOptimized_A250
FlashOptimized_A500
FlashOptimized_A700
FlashOptimized_A1000
FlashOptimized_A1500
FlashOptimized_A2000
FlashOptimized_A4500

TlsVersion

Defines values for TlsVersion.
KnownTlsVersion can be used interchangeably with TlsVersion, this enum contains the known values that the service supports.

Known values supported by the service

1.0
1.1
1.2

Enums

KnownAccessKeysAuthentication

Known values of AccessKeysAuthentication that the service accepts.

KnownActionType

Known values of ActionType that the service accepts.

KnownAofFrequency

Known values of AofFrequency that the service accepts.

KnownClusteringPolicy

Known values of ClusteringPolicy that the service accepts.

KnownCmkIdentityType

Known values of CmkIdentityType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDeferUpgradeSetting

Known values of DeferUpgradeSetting that the service accepts.

KnownEvictionPolicy

Known values of EvictionPolicy that the service accepts.

KnownHighAvailability

Known values of HighAvailability that the service accepts.

KnownKind

Known values of Kind that the service accepts.

KnownLinkState

Known values of LinkState that the service accepts.

KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProtocol

Known values of Protocol that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownRdbFrequency

Known values of RdbFrequency that the service accepts.

KnownRedundancyMode

Known values of RedundancyMode that the service accepts.

KnownResourceState

Known values of ResourceState that the service accepts.

KnownSkuName

Known values of SkuName that the service accepts.

KnownTlsVersion

Known values of TlsVersion that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.