@azure/arm-rediscache package

Classes

RedisManagementClient

Interfaces

AccessPolicyAssignmentCreateUpdateOptionalParams	Optional parameters.
AccessPolicyAssignmentDeleteOptionalParams	Optional parameters.
AccessPolicyAssignmentGetOptionalParams	Optional parameters.
AccessPolicyAssignmentListOptionalParams	Optional parameters.
AccessPolicyAssignmentOperations	Interface representing a AccessPolicyAssignment operations.
AccessPolicyCreateUpdateOptionalParams	Optional parameters.
AccessPolicyDeleteOptionalParams	Optional parameters.
AccessPolicyGetOptionalParams	Optional parameters.
AccessPolicyListOptionalParams	Optional parameters.
AccessPolicyOperations	Interface representing a AccessPolicy operations.
AsyncOperationStatusGetOptionalParams	Optional parameters.
AsyncOperationStatusOperations	Interface representing a AsyncOperationStatus operations.
CheckNameAvailabilityParameters	Parameters body to pass for resource name availability check.
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.
ExportRDBParameters	Parameters for Redis export operation.
FirewallRulesCreateOrUpdateOptionalParams	Optional parameters.
FirewallRulesDeleteOptionalParams	Optional parameters.
FirewallRulesGetOptionalParams	Optional parameters.
FirewallRulesListOptionalParams	Optional parameters.
FirewallRulesOperations	Interface representing a FirewallRules operations.
ImportRDBParameters	Parameters for Redis import operation.
LinkedServerCreateOptionalParams	Optional parameters.
LinkedServerDeleteOptionalParams	Optional parameters.
LinkedServerGetOptionalParams	Optional parameters.
LinkedServerListOptionalParams	Optional parameters.
LinkedServerOperations	Interface representing a LinkedServer operations.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
Operation	REST API operation
OperationDisplay	The object that describes the operation.
OperationStatus	Asynchronous operation status
OperationStatusResult	The current status of an async operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PatchSchedulesCreateOrUpdateOptionalParams	Optional parameters.
PatchSchedulesDeleteOptionalParams	Optional parameters.
PatchSchedulesGetOptionalParams	Optional parameters.
PatchSchedulesListByRedisResourceOptionalParams	Optional parameters.
PatchSchedulesOperations	Interface representing a PatchSchedules operations.
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.
PrivateLinkResourcesListByRedisCacheOptionalParams	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
RedisAccessKeys	Redis cache access keys.
RedisCacheAccessPolicy	Response to get/put access policy.
RedisCacheAccessPolicyAssignment	Response to an operation on access policy assignment
RedisCacheAccessPolicyAssignmentProperties	Properties for an access policy assignment
RedisCacheAccessPolicyProperties	All properties of an access policy.
RedisCheckNameAvailabilityOptionalParams	Optional parameters.
RedisCommonProperties	Create/Update/Get common properties of the redis cache.
RedisCommonPropertiesRedisConfiguration	All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.
RedisCreateOptionalParams	Optional parameters.
RedisCreateParameters	Parameters supplied to the Create Redis operation.
RedisCreateProperties	Properties supplied to Create Redis operation.
RedisDeleteOptionalParams	Optional parameters.
RedisExportDataOptionalParams	Optional parameters.
RedisFirewallRule	A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect
RedisFirewallRuleProperties	Specifies a range of IP addresses permitted to connect to the cache
RedisFlushCacheOptionalParams	Optional parameters.
RedisForceRebootOptionalParams	Optional parameters.
RedisForceRebootResponse	Response to force reboot for Redis cache.
RedisGetOptionalParams	Optional parameters.
RedisImportDataOptionalParams	Optional parameters.
RedisInstanceDetails	Details of single instance of redis.
RedisLinkedServer	Linked server Id
RedisLinkedServerCreateParameters	Parameter required for creating a linked server to redis cache.
RedisLinkedServerCreateProperties	Create properties for a linked server
RedisLinkedServerProperties	Properties of a linked server to be returned in get/put response
RedisLinkedServerWithProperties	Response to put/get linked server (with properties) for Redis cache.
RedisListByResourceGroupOptionalParams	Optional parameters.
RedisListBySubscriptionOptionalParams	Optional parameters.
RedisListKeysOptionalParams	Optional parameters.
RedisListUpgradeNotificationsOptionalParams	Optional parameters.
RedisManagementClientOptionalParams	Optional parameters for the client.
RedisOperations	Interface representing a Redis operations.
RedisPatchSchedule	Response to put/get patch schedules for Redis cache.
RedisProperties	Properties of the redis cache.
RedisRebootParameters	Specifies which Redis node(s) to reboot.
RedisRegenerateKeyOptionalParams	Optional parameters.
RedisRegenerateKeyParameters	Specifies which Redis access keys to reset.
RedisResource	A single Redis item in List or Get Operation.
RedisUpdateOptionalParams	Optional parameters.
RedisUpdateParameters	Parameters supplied to the Update Redis operation.
RedisUpdateProperties	Patchable properties of the redis cache.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
ScheduleEntries	List of patch schedules for a Redis cache.
ScheduleEntry	Patch schedule entry for a Premium Redis Cache.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	SKU parameters supplied to the create Redis 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'
UpgradeNotification	Properties of upgrade notification.
UserAssignedIdentity	User assigned identity properties

Type Aliases

AccessPolicyAssignmentProvisioningState	Provisioning state of an access policy assignment set KnownAccessPolicyAssignmentProvisioningState can be used interchangeably with AccessPolicyAssignmentProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Updating: The access policy assignments are being updated Succeeded: The access policy assignments were successfully updated Deleting: The access policy assignments are being deleted Deleted: The access policy assignments are considered deleted, meaning no custom access policies are applied. Canceled: The operation was canceled. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state. Failed: The operation failed. Access policy assignments may be in a partially updated state. Update them again to have a well-defined state.
AccessPolicyProvisioningState	Provisioning state of access policy KnownAccessPolicyProvisioningState can be used interchangeably with AccessPolicyProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Updating: An operation is in progress. Succeeded: The operation succeeded. Deleting: A delete operation is in progress. Deleted: The access policy is considered deleted, if it still exists. Canceled: The operation was canceled. Access policies may be in a partially updated state. Update them again to have a well-defined state. Failed: The operation failed. Access policies may be in a partially updated state. Update them again to have a well-defined state.
AccessPolicyType	Built-In or Custom access policy KnownAccessPolicyType can be used interchangeably with AccessPolicyType, this enum contains the known values that the service supports. Known values supported by the service Custom: User-configurable access policy, using the redis access policy authoring language BuiltIn: Built-in or well-known access policies, whose policy is not configurable.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DayOfWeek	Day of the week when a cache can be patched.
DefaultName	The name of the resource that is the target of a particular operation. For singleton resources, it must be 'Default'. KnownDefaultName can be used interchangeably with DefaultName, this enum contains the known values that the service supports. Known values supported by the service default: The name of e.g. the patch schedules resource, which is a singleton, must always be 'Default'
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned, UserAssigned: System and user assigned managed identity.
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Connection has been provisioned Creating: Connection is being created Deleting: Connection is being deleted Failed: Connection provisioning has failed
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Connection waiting for approval or rejection Approved: Connection approved Rejected: Connection Rejected
ProvisioningState	Redis instance provisioning status. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating: A create operation is in progress. Deleting: A delete operation is in progress. Disabled: The cache is disabled and cannot be used. Failed: An operation such as create or update failed. If you failed to create the cache it will not be in a usable state, so you should delete and recreate it. Linking: Georeplication link is in progress Provisioning: An operation is in progress RecoveringScaleFailure: A scaling operation encountered an error and recovery is in progress. Scaling: A scaling operation is in progress Succeeded: The most recent operation successfully completed Unlinking: Georeplication unlink is in progress Unprovisioning: The cache may be being disabled Updating: An update operation is in progress. ConfiguringAAD: An AAD configuration update operation is in progress. Migrating: A migration to Azure Managed Redis is in progress. MigrationFailed: A migration to Azure Managed Redis failed. MigrationSucceeded: A migration to Azure Managed Redis succeeded. MigrationCancelling: A cancellation (rollback) of a migration to Azure Managed Redis is in progress. MigrationCancellationFailed: A cancellation (rollback) of a migration to Azure Managed Redis has failed.
PublicNetworkAccess	Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled' KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled: Public internet access to the cache, via its public IP address, is enabled. Connections may use any network path. Disabled: Public internet access to the cache, via its public IP address, is disabled. Connections must use be made via private endpoints.
RebootType	Which Redis node(s) to reboot. Depending on this value data loss is possible. KnownRebootType can be used interchangeably with RebootType, this enum contains the known values that the service supports. Known values supported by the service PrimaryNode: Reboot the primary nodes used for redis write operations. (This may trigger role changes.) SecondaryNode: Reboot only the secondary or replica nodes AllNodes: Reboot all nodes, not guaranteed to happen simultaneously.
RedisKeyType	The Redis access key to regenerate.
ReplicationRole	Role of the linked server.
SkuFamily	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). KnownSkuFamily can be used interchangeably with SkuFamily, this enum contains the known values that the service supports. Known values supported by the service C: The SKU family to use - must be 'C' for Basic/Standard SKU redis caches. P: The SKU family to use - must be 'P' for Premium SKU redis caches.
SkuName	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports. Known values supported by the service Basic: The well known 'Basic' SKU for Azure Cache for Redis. Basic SKU does not have an availability SLA. Standard: The well known 'Standard' SKU for Azure Cache for Redis. Standard SKU has an availability SLA. Premium: The well known 'Premium' SKU for Azure Cache for Redis. Premium SKU has an availability SLA, and higher performance tiers and more features compared with Standard SKU.
TlsVersion	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2') 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: TLS protocol version 1.0 -- deprecated for security reasons. Do not use this value for new caches. 1.1: TLS protocol version 1.1 -- deprecated for security reasons. Do not use this value for new caches. 1.2: TLS protocol version 1.2 -- use this value, or higher, for new caches. Or do not specify, so that your cache uses the recommended default value
UpdateChannel	Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'. KnownUpdateChannel can be used interchangeably with UpdateChannel, this enum contains the known values that the service supports. Known values supported by the service Stable: Stable channel receives updates, which may include important security and stability updates, later than Preview channel. Preview: Preview channel normally receives updates before Stable channel, and is the recommended channel for non-production workloads.
ZonalAllocationPolicy	Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported. KnownZonalAllocationPolicy can be used interchangeably with ZonalAllocationPolicy, this enum contains the known values that the service supports. Known values supported by the service Automatic: The zones for the cache will be selected automatically based on availability and capacity. UserDefined: UserDefined means the zones for the cache are manually configured using the 'zones' property, and can not be automatically selected. NoZones: The cache will not use multiple availability zones.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccessPolicyAssignmentProvisioningState	Provisioning state of an access policy assignment set
KnownAccessPolicyProvisioningState	Provisioning state of access policy
KnownAccessPolicyType	Built-In or Custom access policy
KnownCreatedByType	The kind of entity that created the resource.
KnownDefaultName	The name of the resource that is the target of a particular operation. For singleton resources, it must be 'Default'.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProvisioningState	Redis instance provisioning status.
KnownPublicNetworkAccess	Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
KnownRebootType	Which Redis node(s) to reboot. Depending on this value data loss is possible.
KnownSkuFamily	The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).
KnownSkuName	The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)
KnownTlsVersion	Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')
KnownUpdateChannel	Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'.
KnownVersions	The available API versions.
KnownZonalAllocationPolicy	Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(RedisManagementClient, 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.

Variables

RestError

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>(RedisManagementClient, 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: RedisManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

RedisManagementClient

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

Type

RestErrorConstructor