Redis - Force Reboot

Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/forceReboot?api-version=2024-03-01

URI Parameters

Name In Required Type Description
name
path True

string

The name of the Redis cache.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Type Description
ports

integer[]

A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports.

rebootType

RebootType

Which Redis node(s) to reboot. Depending on this value data loss is possible.

shardId

integer

If clustering is enabled, the ID of the shard to be rebooted.

Responses

Name Type Description
200 OK

RedisForceRebootResponse

Reboot operation successfully enqueued

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

RedisCacheForceReboot

Sample request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/forceReboot?api-version=2024-03-01

{
  "shardId": 0,
  "rebootType": "AllNodes",
  "ports": [
    13000,
    15001
  ]
}

Sample response

{
  "message": "reboot operation enqueued"
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

RebootType

Which Redis node(s) to reboot. Depending on this value data loss is possible.

RedisForceRebootResponse

Response to force reboot for Redis cache.

RedisRebootParameters

Specifies which Redis node(s) to reboot.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

RebootType

Which Redis node(s) to reboot. Depending on this value data loss is possible.

Name Type Description
AllNodes

string

PrimaryNode

string

SecondaryNode

string

RedisForceRebootResponse

Response to force reboot for Redis cache.

Name Type Description
message

string

Status message

RedisRebootParameters

Specifies which Redis node(s) to reboot.

Name Type Description
ports

integer[]

A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports.

rebootType

RebootType

Which Redis node(s) to reboot. Depending on this value data loss is possible.

shardId

integer

If clustering is enabled, the ID of the shard to be rebooted.