RedisRebootParameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-cache-for-redis/json-schema/microsoft-azure-cache-for-redis-redis-reboot-parameters-schema.json",
  "title": "RedisRebootParameters",
  "description": "Specifies which Redis node(s) to reboot.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-cache-for-redis-redisresources-api-openapi.yml#/components/schemas/RedisRebootParameters",
  "type": "object",
  "properties": {
    "rebootType": {
      "$ref": "#/$defs/RebootType",
      "description": "Which Redis node(s) to reboot. Depending on this value data loss is possible."
    },
    "shardId": {
      "type": "integer",
      "format": "int32",
      "description": "If clustering is enabled, the ID of the shard to be rebooted."
    },
    "ports": {
      "type": "array",
      "description": "A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports.",
      "items": {
        "type": "integer",
        "format": "int32"
      }
    }
  },
  "$defs": {
    "RebootType": {
      "type": "string",
      "description": "Which Redis node(s) to reboot. Depending on this value data loss is possible.",
      "enum": [
        "PrimaryNode",
        "SecondaryNode",
        "AllNodes"
      ],
      "x-ms-enum": {
        "name": "RebootType",
        "modelAsString": true,
        "values": [
          {
            "name": "PrimaryNode",
            "value": "PrimaryNode",
            "description": "Reboot the primary nodes used for redis write operations. (This may trigger role changes.)"
          },
          {
            "name": "SecondaryNode",
            "value": "SecondaryNode",
            "description": "Reboot only the secondary or replica nodes"
          },
          {
            "name": "AllNodes",
            "value": "AllNodes",
            "description": "Reboot all nodes, not guaranteed to happen simultaneously."
          }
        ]
      }
    }
  }
}