@azure/arm-redisenterprisecache package

Classes

RedisEnterpriseManagementClient

Interfaces

AccessKeys	The secret access keys used for authenticating connections to redis
Cluster	Describes the RedisEnterprise cluster
ClusterList	The response of a list-all operation.
ClusterPropertiesEncryption	Encryption-at-rest configuration for the cluster.
ClusterPropertiesEncryptionCustomerManagedKeyEncryption	All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity	All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
ClusterUpdate	A partial update to the RedisEnterprise cluster
Database	Describes a database on the RedisEnterprise cluster
DatabaseList	The response of a list-all operation.
DatabasePropertiesGeoReplication	Optional set of properties to configure geo replication for this database.
DatabaseUpdate	A partial update to the RedisEnterprise database
Databases	Interface representing a Databases.
DatabasesCreateOptionalParams	Optional parameters.
DatabasesDeleteOptionalParams	Optional parameters.
DatabasesExportOptionalParams	Optional parameters.
DatabasesFlushHeaders	Defines headers for Databases_flush operation.
DatabasesFlushOptionalParams	Optional parameters.
DatabasesForceUnlinkOptionalParams	Optional parameters.
DatabasesGetOptionalParams	Optional parameters.
DatabasesImportOptionalParams	Optional parameters.
DatabasesListByClusterNextOptionalParams	Optional parameters.
DatabasesListByClusterOptionalParams	Optional parameters.
DatabasesListKeysOptionalParams	Optional parameters.
DatabasesRegenerateKeyOptionalParams	Optional parameters.
DatabasesUpdateOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	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.).
ExportClusterParameters	Parameters for a Redis Enterprise export operation.
FlushParameters	Parameters for a Redis Enterprise active geo-replication flush operation
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 RedisEnterprise 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
RedisEnterprise	Interface representing a RedisEnterprise.
RedisEnterpriseCreateOptionalParams	Optional parameters.
RedisEnterpriseDeleteOptionalParams	Optional parameters.
RedisEnterpriseGetOptionalParams	Optional parameters.
RedisEnterpriseListByResourceGroupNextOptionalParams	Optional parameters.
RedisEnterpriseListByResourceGroupOptionalParams	Optional parameters.
RedisEnterpriseListNextOptionalParams	Optional parameters.
RedisEnterpriseListOptionalParams	Optional parameters.
RedisEnterpriseManagementClientOptionalParams	Optional parameters.
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
Sku	SKU parameters supplied to the create RedisEnterprise operation.
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.
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 OSSCluster
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
DatabasesCreateResponse	Contains response data for the create 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.
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
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
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.
RedisEnterpriseUpdateResponse	Contains response data for the update operation.
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
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_E10 Enterprise_E20 Enterprise_E50 Enterprise_E100 EnterpriseFlash_F300 EnterpriseFlash_F700 EnterpriseFlash_F1500
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

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.
KnownEvictionPolicy	Known values of EvictionPolicy 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.
KnownRdbFrequency	Known values of RdbFrequency 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.