@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. Known values supported by the serviceInternal |
AofFrequency |
Defines values for AofFrequency. Known values supported by the service1s |
ClusteringPolicy |
Defines values for ClusteringPolicy. Known values supported by the serviceEnterpriseCluster |
CmkIdentityType |
Defines values for CmkIdentityType. Known values supported by the servicesystemAssignedIdentity |
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. Known values supported by the serviceAllKeysLFU |
LinkState |
Defines values for LinkState. Known values supported by the serviceLinked |
ManagedServiceIdentityType |
Defines values for ManagedServiceIdentityType. Known values supported by the serviceNone |
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. Known values supported by the serviceuser |
PrivateEndpointConnectionProvisioningState |
Defines values for PrivateEndpointConnectionProvisioningState. Known values supported by the serviceSucceeded |
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. Known values supported by the servicePending |
PrivateLinkResourcesListByClusterResponse |
Contains response data for the listByCluster operation. |
Protocol |
Defines values for Protocol. Known values supported by the serviceEncrypted |
ProvisioningState |
Defines values for ProvisioningState. Known values supported by the serviceSucceeded |
RdbFrequency |
Defines values for RdbFrequency. Known values supported by the service1h |
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. Known values supported by the serviceRunning |
SkuName |
Defines values for SkuName. Known values supported by the serviceEnterprise_E10 |
TlsVersion |
Defines values for TlsVersion. Known values supported by the service1.0 |
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
get |
Given the last |
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.