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=2016-04-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

name
path True
  • string

The name of the Redis cache.

api-version
query True
  • string

Client Api Version.

Request Body

Name Required Type Description
rebootType True

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

Reboot operation successfully enqueued

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=2016-04-01
{
  "shardId": 0,
  "rebootType": "AllNodes"
}

Sample Response

{
  "Message": "reboot operation enqueued"
}

Definitions

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.

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
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.