/
ContainerPartitionKey.yml
67 lines (66 loc) · 1.93 KB
/
ContainerPartitionKey.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
### YamlMime:TSType
name: ContainerPartitionKey
uid: '@azure/arm-cosmosdb.ContainerPartitionKey'
package: '@azure/arm-cosmosdb'
summary: >-
The configuration of the partition key to be used for partitioning data into
multiple partitions
fullName: ContainerPartitionKey
remarks: ''
isDeprecated: false
type: interface
properties:
- name: kind
uid: '@azure/arm-cosmosdb.ContainerPartitionKey.kind'
package: '@azure/arm-cosmosdb'
summary: >-
Indicates the kind of algorithm used for partitioning. For MultiHash,
multiple partition keys (upto three maximum) are supported for container
create
fullName: kind
remarks: ''
isDeprecated: false
syntax:
content: 'kind?: string'
return:
description: ''
type: string
- name: paths
uid: '@azure/arm-cosmosdb.ContainerPartitionKey.paths'
package: '@azure/arm-cosmosdb'
summary: List of paths using which data within the container can be partitioned
fullName: paths
remarks: ''
isDeprecated: false
syntax:
content: 'paths?: string[]'
return:
description: ''
type: string[]
- name: systemKey
uid: '@azure/arm-cosmosdb.ContainerPartitionKey.systemKey'
package: '@azure/arm-cosmosdb'
summary: >-
Indicates if the container is using a system generated partition key
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: systemKey
remarks: ''
isDeprecated: false
syntax:
content: 'systemKey?: boolean'
return:
description: ''
type: boolean
- name: version
uid: '@azure/arm-cosmosdb.ContainerPartitionKey.version'
package: '@azure/arm-cosmosdb'
summary: Indicates the version of the partition key definition
fullName: version
remarks: ''
isDeprecated: false
syntax:
content: 'version?: number'
return:
description: ''
type: number