RestartReplicaRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-restart-replica-request-schema.json",
  "title": "RestartReplicaRequest",
  "description": "Request to restart a replica.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-service-fabric-managed-clusters-api-openapi.yml#/components/schemas/RestartReplicaRequest",
  "type": "object",
  "properties": {
    "partitionId": {
      "type": "string",
      "description": "The ID of the partition."
    },
    "replicaIds": {
      "type": "array",
      "description": "The IDs of the replicas to be restarted.",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    },
    "restartKind": {
      "$ref": "#/$defs/RestartKind"
    },
    "forceRestart": {
      "type": "boolean",
      "description": "If true, the restart operation will be forced. Use this option with care, as it may cause data loss."
    },
    "timeout": {
      "type": "integer",
      "format": "int64",
      "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds."
    }
  },
  "required": [
    "partitionId",
    "replicaIds",
    "restartKind"
  ],
  "$defs": {
    "RestartKind": {
      "type": "string",
      "description": "The kind of restart to perform.",
      "enum": [
        "Simultaneous"
      ],
      "x-ms-enum": {
        "name": "RestartKind",
        "modelAsString": true,
        "values": [
          {
            "name": "Simultaneous",
            "value": "Simultaneous",
            "description": "Restart all listed replicas at the same time."
          }
        ]
      }
    }
  }
}