@azure/arm-rediscache package

Classes

RedisManagementClient

Interfaces

AccessPolicy	Interface representing a AccessPolicy.
AccessPolicyAssignment	Interface representing a AccessPolicyAssignment.
AccessPolicyAssignmentCreateUpdateOptionalParams	Optional parameters.
AccessPolicyAssignmentDeleteHeaders	Defines headers for AccessPolicyAssignment_delete operation.
AccessPolicyAssignmentDeleteOptionalParams	Optional parameters.
AccessPolicyAssignmentGetOptionalParams	Optional parameters.
AccessPolicyAssignmentListNextOptionalParams	Optional parameters.
AccessPolicyAssignmentListOptionalParams	Optional parameters.
AccessPolicyCreateUpdateOptionalParams	Optional parameters.
AccessPolicyDeleteHeaders	Defines headers for AccessPolicy_delete operation.
AccessPolicyDeleteOptionalParams	Optional parameters.
AccessPolicyGetOptionalParams	Optional parameters.
AccessPolicyListNextOptionalParams	Optional parameters.
AccessPolicyListOptionalParams	Optional parameters.
AsyncOperationStatus	Interface representing a AsyncOperationStatus.
AsyncOperationStatusGetOptionalParams	Optional parameters.
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. (This also follows the OData error response format.).
ExportRDBParameters	Parameters for Redis export operation.
FirewallRules	Interface representing a FirewallRules.
FirewallRulesCreateOrUpdateOptionalParams	Optional parameters.
FirewallRulesDeleteOptionalParams	Optional parameters.
FirewallRulesGetOptionalParams	Optional parameters.
FirewallRulesListNextOptionalParams	Optional parameters.
FirewallRulesListOptionalParams	Optional parameters.
ImportRDBParameters	Parameters for Redis import operation.
LinkedServer	Interface representing a LinkedServer.
LinkedServerCreateOptionalParams	Optional parameters.
LinkedServerDeleteHeaders	Defines headers for LinkedServer_delete operation.
LinkedServerDeleteOptionalParams	Optional parameters.
LinkedServerGetOptionalParams	Optional parameters.
LinkedServerListNextOptionalParams	Optional parameters.
LinkedServerListOptionalParams	Optional parameters.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
NotificationListResponse	The response of listUpgradeNotifications.
Operation	REST API operation
OperationDisplay	The object that describes the operation.
OperationListResult	Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.
OperationStatus	Asynchronous operation status
OperationStatusResult	The current status of an async operation.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PatchSchedules	Interface representing a PatchSchedules.
PatchSchedulesCreateOrUpdateOptionalParams	Optional parameters.
PatchSchedulesDeleteOptionalParams	Optional parameters.
PatchSchedulesGetOptionalParams	Optional parameters.
PatchSchedulesListByRedisResourceNextOptionalParams	Optional parameters.
PatchSchedulesListByRedisResourceOptionalParams	Optional parameters.
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.
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.
PrivateLinkResourcesListByRedisCacheOptionalParams	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
Redis	Interface representing a Redis.
RedisAccessKeys	Redis cache access keys.
RedisCacheAccessPolicy	Response to get/put access policy.
RedisCacheAccessPolicyAssignment	Response to an operation on access policy assignment
RedisCacheAccessPolicyAssignmentList	List of access policies assignments (with properties) of a Redis cache.
RedisCacheAccessPolicyList	List of access policies (with properties) of a Redis cache.
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,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value 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
RedisFirewallRuleCreateParameters	Parameters required for creating a firewall rule on redis cache. (Note, you can just use the FirewallRule type instead now.)
RedisFirewallRuleListResult	The response of list firewall rules Redis operation.
RedisFlushCacheHeaders	Defines headers for Redis_flushCache operation.
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.
RedisLinkedServerWithPropertiesList	List of linked servers (with properties) of a Redis cache.
RedisListByResourceGroupNextOptionalParams	Optional parameters.
RedisListByResourceGroupOptionalParams	Optional parameters.
RedisListBySubscriptionNextOptionalParams	Optional parameters.
RedisListBySubscriptionOptionalParams	Optional parameters.
RedisListKeysOptionalParams	Optional parameters.
RedisListResult	The response of list Redis operation.
RedisListUpgradeNotificationsNextOptionalParams	Optional parameters.
RedisListUpgradeNotificationsOptionalParams	Optional parameters.
RedisManagementClientOptionalParams	Optional parameters.
RedisPatchSchedule	Response to put/get patch schedules for Redis cache.
RedisPatchScheduleListResult	The response of list patch schedules Redis operation.
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
ScheduleEntry	Patch schedule entry for a Premium Redis Cache.
Sku	SKU parameters supplied to the create Redis operation.
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

AccessPolicyAssignmentCreateUpdateResponse	Contains response data for the createUpdate 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.
AccessPolicyAssignmentProvisioningState	Defines values for AccessPolicyAssignmentProvisioningState. KnownAccessPolicyAssignmentProvisioningState can be used interchangeably with AccessPolicyAssignmentProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Updating Succeeded Deleting Deleted Canceled Failed
AccessPolicyCreateUpdateResponse	Contains response data for the createUpdate operation.
AccessPolicyGetResponse	Contains response data for the get operation.
AccessPolicyListNextResponse	Contains response data for the listNext operation.
AccessPolicyListResponse	Contains response data for the list operation.
AccessPolicyProvisioningState	Defines values for AccessPolicyProvisioningState. KnownAccessPolicyProvisioningState can be used interchangeably with AccessPolicyProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Updating Succeeded Deleting Deleted Canceled Failed
AccessPolicyType	Defines values for AccessPolicyType. KnownAccessPolicyType can be used interchangeably with AccessPolicyType, this enum contains the known values that the service supports. Known values supported by the service Custom BuiltIn
AsyncOperationStatusGetResponse	Contains response data for the get operation.
DayOfWeek	Defines values for DayOfWeek.
DefaultName	Defines values for DefaultName. KnownDefaultName can be used interchangeably with DefaultName, this enum contains the known values that the service supports. Known values supported by the service default
FirewallRulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
FirewallRulesGetResponse	Contains response data for the get operation.
FirewallRulesListNextResponse	Contains response data for the listNext operation.
FirewallRulesListResponse	Contains response data for the list operation.
LinkedServerCreateResponse	Contains response data for the create operation.
LinkedServerGetResponse	Contains response data for the get operation.
LinkedServerListNextResponse	Contains response data for the listNext operation.
LinkedServerListResponse	Contains response data for the list operation.
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.
PatchSchedulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PatchSchedulesGetResponse	Contains response data for the get operation.
PatchSchedulesListByRedisResourceNextResponse	Contains response data for the listByRedisResourceNext operation.
PatchSchedulesListByRedisResourceResponse	Contains response data for the listByRedisResource operation.
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
PrivateLinkResourcesListByRedisCacheResponse	Contains response data for the listByRedisCache operation.
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 Creating Deleting Disabled Failed Linking Provisioning RecoveringScaleFailure Scaling Succeeded Unlinking Unprovisioning Updating ConfiguringAAD
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
RebootType	Defines values for RebootType. KnownRebootType can be used interchangeably with RebootType, this enum contains the known values that the service supports. Known values supported by the service PrimaryNode SecondaryNode AllNodes
RedisCreateResponse	Contains response data for the create operation.
RedisFlushCacheResponse	Contains response data for the flushCache operation.
RedisForceRebootOperationResponse	Contains response data for the forceReboot operation.
RedisGetResponse	Contains response data for the get operation.
RedisKeyType	Defines values for RedisKeyType.
RedisListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
RedisListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
RedisListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
RedisListBySubscriptionResponse	Contains response data for the listBySubscription operation.
RedisListKeysResponse	Contains response data for the listKeys operation.
RedisListUpgradeNotificationsNextResponse	Contains response data for the listUpgradeNotificationsNext operation.
RedisListUpgradeNotificationsResponse	Contains response data for the listUpgradeNotifications operation.
RedisRegenerateKeyResponse	Contains response data for the regenerateKey operation.
RedisUpdateResponse	Contains response data for the update operation.
ReplicationRole	Defines values for ReplicationRole.
SkuFamily	Defines values for SkuFamily. KnownSkuFamily can be used interchangeably with SkuFamily, this enum contains the known values that the service supports. Known values supported by the service C P
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 Basic Standard Premium
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
UpdateChannel	Defines values for UpdateChannel. KnownUpdateChannel can be used interchangeably with UpdateChannel, this enum contains the known values that the service supports. Known values supported by the service Stable Preview

Enums

KnownAccessPolicyAssignmentProvisioningState	Known values of AccessPolicyAssignmentProvisioningState that the service accepts.
KnownAccessPolicyProvisioningState	Known values of AccessPolicyProvisioningState that the service accepts.
KnownAccessPolicyType	Known values of AccessPolicyType that the service accepts.
KnownDefaultName	Known values of DefaultName that the service accepts.
KnownManagedServiceIdentityType	Known values of ManagedServiceIdentityType that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownRebootType	Known values of RebootType that the service accepts.
KnownSkuFamily	Known values of SkuFamily that the service accepts.
KnownSkuName	Known values of SkuName that the service accepts.
KnownTlsVersion	Known values of TlsVersion that the service accepts.
KnownUpdateChannel	Known values of UpdateChannel 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.