PartitionKeyDefinition

The partition key definition.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
paths	array	List of paths using which data within the container can be partitioned.
kind	string	The algorithm used for partitioning.
version	integer	The version of the partition key definition.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PartitionKeyDefinition",
  "title": "PartitionKeyDefinition",
  "type": "object",
  "description": "The partition key definition.",
  "properties": {
    "paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of paths using which data within the container can be partitioned.",
      "example": []
    },
    "kind": {
      "type": "string",
      "enum": [
        "Hash",
        "Range",
        "MultiHash"
      ],
      "default": "Hash",
      "description": "The algorithm used for partitioning.",
      "example": "Hash"
    },
    "version": {
      "type": "integer",
      "enum": [
        1,
        2
      ],
      "description": "The version of the partition key definition.",
      "example": 1
    }
  },
  "required": [
    "paths"
  ]
}