@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. |
| AccessPolicyAssignmentDeleteOptionalParams |
Optional parameters. |
| AccessPolicyAssignmentGetOptionalParams |
Optional parameters. |
| AccessPolicyAssignmentListOptionalParams |
Optional parameters. |
| AccessPolicyAssignmentOperations |
Interface representing a AccessPolicyAssignment operations. |
| AccessPolicyAssignmentProperties |
Properties of Redis Enterprise database access policy assignment. |
| AccessPolicyAssignmentPropertiesUser |
The user associated with the access policy. |
| AzureCacheForRedisMigrationProperties |
Properties for Redis Enterprise migration operation for Azure Cache for Redis. |
| 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 |
| 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 |
| DatabaseUpdate |
A partial update to the Redis Enterprise database |
| DatabaseUpdateProperties |
Properties for updating Redis Enterprise databases |
| DatabasesCreateOptionalParams |
Optional parameters. |
| DatabasesDeleteOptionalParams |
Optional parameters. |
| DatabasesExportOptionalParams |
Optional parameters. |
| DatabasesFlushOptionalParams |
Optional parameters. |
| DatabasesForceLinkToReplicationGroupOptionalParams |
Optional parameters. |
| DatabasesForceUnlinkOptionalParams |
Optional parameters. |
| DatabasesGetOptionalParams |
Optional parameters. |
| DatabasesImportOptionalParams |
Optional parameters. |
| DatabasesListByClusterOptionalParams |
Optional parameters. |
| DatabasesListKeysOptionalParams |
Optional parameters. |
| DatabasesOperations |
Interface representing a Databases operations. |
| DatabasesRegenerateKeyOptionalParams |
Optional parameters. |
| DatabasesUpdateOptionalParams |
Optional parameters. |
| DatabasesUpgradeDBRedisVersionOptionalParams |
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. |
| 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. |
| MaintenanceConfiguration |
Cluster-level maintenance configuration. |
| MaintenanceWindow |
A single custom maintenance window. |
| MaintenanceWindowSchedule |
Schedule details for a maintenance window. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| Migration |
Describes the current migration operation on a Redis Enterprise cluster. |
| MigrationCancelOptionalParams |
Optional parameters. |
| MigrationGetOptionalParams |
Optional parameters. |
| MigrationListOptionalParams |
Optional parameters. |
| MigrationOperations |
Interface representing a Migration operations. |
| MigrationProperties |
Properties for Redis Enterprise migration operation. |
| MigrationStartOptionalParams |
Optional parameters. |
| MigrationValidationDisparity |
Represents a specific validation issue found during migration validation. |
| MigrationValidationError |
Represents a validation error that prevents migration. |
| MigrationValidationRequest |
Properties for validating migration from Azure Cache for Redis to Redis Enterprise. |
| MigrationValidationResponse |
Response for migration validation operation. |
| MigrationValidationWarning |
Represents a validation warning that may impact migration. |
| MigrationsOperations |
Interface representing a Migrations operations. |
| MigrationsValidateOptionalParams |
Optional parameters. |
| 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 an operation. |
| OperationStatus |
The status of a long-running operation. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| OperationsStatusGetOptionalParams |
Optional parameters. |
| OperationsStatusOperations |
Interface representing a OperationsStatus operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| Persistence |
Persistence-related configuration for the Redis Enterprise database |
| PrivateEndpoint |
The private endpoint resource. |
| PrivateEndpointConnection |
The Private Endpoint Connection resource. |
| PrivateEndpointConnectionProperties |
Properties of the private endpoint connection. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsListOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsOperations |
Interface representing a PrivateEndpointConnections operations. |
| PrivateEndpointConnectionsPutOptionalParams |
Optional parameters. |
| PrivateLinkResource |
A private link resource. |
| PrivateLinkResourceProperties |
Properties of a private link resource. |
| PrivateLinkResourcesListByClusterOptionalParams |
Optional parameters. |
| PrivateLinkResourcesOperations |
Interface representing a PrivateLinkResources operations. |
| 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 |
| RedisEnterpriseCreateOptionalParams |
Optional parameters. |
| RedisEnterpriseDeleteOptionalParams |
Optional parameters. |
| RedisEnterpriseGetOptionalParams |
Optional parameters. |
| RedisEnterpriseListByResourceGroupOptionalParams |
Optional parameters. |
| RedisEnterpriseListOptionalParams |
Optional parameters. |
| RedisEnterpriseListSkusForScalingOptionalParams |
Optional parameters. |
| RedisEnterpriseManagementClientOptionalParams |
Optional parameters for the client. |
| RedisEnterpriseOperations |
Interface representing a RedisEnterprise operations. |
| 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 |
| RestorePollerOptions | |
| SimplePollerLike |
A simple poller that can be used to poll a long running operation. |
| 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 |
Which access key to regenerate. |
| AccessKeysAuthentication |
This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. Known values supported by the serviceDisabled: Disabled |
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| AofFrequency |
Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. Known values supported by the service1s: 1s |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| ClusteringPolicy |
Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database. Known values supported by the serviceEnterpriseCluster: Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands. |
| CmkIdentityType |
Only userAssignedIdentity is supported in this API version; other types may be supported in the future Known values supported by the servicesystemAssignedIdentity: systemAssignedIdentity |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DeferUpgradeSetting |
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade Known values supported by the serviceDeferred: Deferred |
| EvictionPolicy |
Redis eviction policy - default is VolatileLRU Known values supported by the serviceAllKeysLFU: AllKeysLFU |
| HighAvailability |
Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. Known values supported by the serviceEnabled: Enabled |
| Kind |
Distinguishes the kind of cluster. Read-only. Known values supported by the servicev1: v1 |
| LinkState |
State of the link between the database resources. Known values supported by the serviceLinked: Linked |
| MaintenanceDayOfWeek |
Day of week. Required when the maintenance window type is 'Weekly'. Known values supported by the serviceSunday |
| MaintenanceWindowType |
Maintenance window type. Known values supported by the serviceWeekly: Weekly maintenance window. |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| MigrationPropertiesUnion |
Alias for MigrationPropertiesUnion |
| MigrationProvisioningState |
Current provisioning status Known values supported by the serviceAccepted: The request has been accepted and the migration operation is being initialized. |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| PrivateEndpointConnectionProvisioningState |
The current provisioning state. Known values supported by the serviceSucceeded: Connection has been provisioned |
| PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. Known values supported by the servicePending: Connection waiting for approval or rejection |
| Protocol |
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Known values supported by the serviceEncrypted: Encrypted |
| ProvisioningState |
Current provisioning status Known values supported by the serviceSucceeded: Succeeded |
| PublicNetworkAccess |
Whether or not public network traffic can access the Redis cluster. Only 'Enabled' or 'Disabled' can be set. null is returned only for clusters created using an old API version which do not have this property and cannot be set. Known values supported by the serviceEnabled: Enabled |
| RdbFrequency |
Sets the frequency at which a snapshot of the database is created. Known values supported by the service1h: 1h |
| RedundancyMode |
Explains the current redundancy strategy of the cluster, which affects the expected SLA. Known values supported by the serviceNone: No redundancy. Availability loss will occur. |
| ResourceState |
Current resource status Known values supported by the serviceRunning: Running |
| SkuName |
The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. Known values supported by the serviceEnterprise_E1: Enterprise_E1 |
| SourceType |
Describes the source of the migration operation. Known values supported by the serviceAzureCacheForRedis: Migration from Azure Cache for Redis to Redis Enterprise. |
| TlsVersion |
The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. Known values supported by the service1.0: 1.0 |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAccessKeysAuthentication |
This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. |
| KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
| KnownAofFrequency |
Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. |
| KnownClusteringPolicy |
Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database. |
| KnownCmkIdentityType |
Only userAssignedIdentity is supported in this API version; other types may be supported in the future |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDeferUpgradeSetting |
Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade |
| KnownEvictionPolicy |
Redis eviction policy - default is VolatileLRU |
| KnownHighAvailability |
Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. |
| KnownKind |
Distinguishes the kind of cluster. Read-only. |
| KnownLinkState |
State of the link between the database resources. |
| KnownMaintenanceDayOfWeek |
Day of week. Required when the maintenance window type is 'Weekly'. |
| KnownMaintenanceWindowType |
Maintenance window type. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| KnownMigrationProvisioningState |
Current provisioning status |
| KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
| KnownPrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| KnownPrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
| KnownProtocol |
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. |
| KnownProvisioningState |
Current provisioning status |
| KnownPublicNetworkAccess |
Whether or not public network traffic can access the Redis cluster. Only 'Enabled' or 'Disabled' can be set. null is returned only for clusters created using an old API version which do not have this property and cannot be set. |
| KnownRdbFrequency |
Sets the frequency at which a snapshot of the database is created. |
| KnownRedundancyMode |
Explains the current redundancy strategy of the cluster, which affects the expected SLA. |
| KnownResourceState |
Current resource status |
| KnownSkuName |
The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. |
| KnownSourceType |
Describes the source of the migration operation. |
| KnownTlsVersion |
The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. |
| KnownVersions |
The available API versions. |
Functions
| is |
Typeguard for RestError |
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(RedisEnterpriseManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: RedisEnterpriseManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor