-
Notifications
You must be signed in to change notification settings - Fork 180
/
RestorableSqlContainerPropertiesResourceContainer.yml
271 lines (267 loc) · 9.68 KB
/
RestorableSqlContainerPropertiesResourceContainer.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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
### YamlMime:TSType
name: RestorableSqlContainerPropertiesResourceContainer
uid: '@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer'
package: '@azure/arm-cosmosdb'
summary: Cosmos DB SQL container resource object
fullName: RestorableSqlContainerPropertiesResourceContainer
remarks: ''
isDeprecated: false
type: interface
properties:
- name: self
uid: '@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.self'
package: '@azure/arm-cosmosdb'
summary: >-
A system generated property that specifies the addressable path of the
container resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: self
remarks: ''
isDeprecated: false
syntax:
content: 'self?: string'
return:
description: ''
type: string
inheritedProperties:
- name: analyticalStorageTtl
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.analyticalStorageTtl
package: '@azure/arm-cosmosdb'
summary: Analytical TTL.
fullName: analyticalStorageTtl
remarks: ''
isDeprecated: false
syntax:
content: 'analyticalStorageTtl?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.analyticalStorageTtl](xref:@azure/arm-cosmosdb.SqlContainerResource.analyticalStorageTtl)
- name: clientEncryptionPolicy
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.clientEncryptionPolicy
package: '@azure/arm-cosmosdb'
summary: The client encryption policy for the container.
fullName: clientEncryptionPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'clientEncryptionPolicy?: ClientEncryptionPolicy'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.ClientEncryptionPolicy" />
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.clientEncryptionPolicy](xref:@azure/arm-cosmosdb.SqlContainerResource.clientEncryptionPolicy)
- name: computedProperties
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.computedProperties
package: '@azure/arm-cosmosdb'
summary: List of computed properties
fullName: computedProperties
remarks: ''
isDeprecated: false
syntax:
content: 'computedProperties?: ComputedProperty[]'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.ComputedProperty" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.computedProperties](xref:@azure/arm-cosmosdb.SqlContainerResource.computedProperties)
- name: conflictResolutionPolicy
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.conflictResolutionPolicy
package: '@azure/arm-cosmosdb'
summary: The conflict resolution policy for the container.
fullName: conflictResolutionPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'conflictResolutionPolicy?: ConflictResolutionPolicy'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.ConflictResolutionPolicy" />
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.conflictResolutionPolicy](xref:@azure/arm-cosmosdb.SqlContainerResource.conflictResolutionPolicy)
- name: createMode
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.createMode
package: '@azure/arm-cosmosdb'
summary: Enum to indicate the mode of resource creation.
fullName: createMode
remarks: ''
isDeprecated: false
syntax:
content: 'createMode?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.createMode](xref:@azure/arm-cosmosdb.SqlContainerResource.createMode)
- name: defaultTtl
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.defaultTtl
package: '@azure/arm-cosmosdb'
summary: Default time to live
fullName: defaultTtl
remarks: ''
isDeprecated: false
syntax:
content: 'defaultTtl?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.defaultTtl](xref:@azure/arm-cosmosdb.SqlContainerResource.defaultTtl)
- name: etag
uid: '@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.etag'
package: '@azure/arm-cosmosdb'
summary: >-
A system generated property representing the resource etag required for
optimistic concurrency control.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: etag
remarks: ''
isDeprecated: false
syntax:
content: 'etag?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExtendedResourceProperties.etag](xref:@azure/arm-cosmosdb.ExtendedResourceProperties.etag)
- name: id
uid: '@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.id'
package: '@azure/arm-cosmosdb'
summary: Name of the Cosmos DB SQL container
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.id](xref:@azure/arm-cosmosdb.SqlContainerResource.id)
- name: indexingPolicy
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.indexingPolicy
package: '@azure/arm-cosmosdb'
summary: >-
The configuration of the indexing policy. By default, the indexing is
automatic for all document paths within the container
fullName: indexingPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'indexingPolicy?: IndexingPolicy'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.IndexingPolicy" />
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.indexingPolicy](xref:@azure/arm-cosmosdb.SqlContainerResource.indexingPolicy)
- name: partitionKey
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.partitionKey
package: '@azure/arm-cosmosdb'
summary: >-
The configuration of the partition key to be used for partitioning data
into multiple partitions
fullName: partitionKey
remarks: ''
isDeprecated: false
syntax:
content: 'partitionKey?: ContainerPartitionKey'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.ContainerPartitionKey" />
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.partitionKey](xref:@azure/arm-cosmosdb.SqlContainerResource.partitionKey)
- name: restoreParameters
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.restoreParameters
package: '@azure/arm-cosmosdb'
summary: Parameters to indicate the information about the restore
fullName: restoreParameters
remarks: ''
isDeprecated: false
syntax:
content: 'restoreParameters?: ResourceRestoreParameters'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.ResourceRestoreParameters" />
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.restoreParameters](xref:@azure/arm-cosmosdb.SqlContainerResource.restoreParameters)
- name: rid
uid: '@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.rid'
package: '@azure/arm-cosmosdb'
summary: >-
A system generated property. A unique identifier.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: rid
remarks: ''
isDeprecated: false
syntax:
content: 'rid?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExtendedResourceProperties.rid](xref:@azure/arm-cosmosdb.ExtendedResourceProperties.rid)
- name: ts
uid: '@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.ts'
package: '@azure/arm-cosmosdb'
summary: >-
A system generated property that denotes the last updated timestamp of the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: ts
remarks: ''
isDeprecated: false
syntax:
content: 'ts?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[ExtendedResourceProperties.ts](xref:@azure/arm-cosmosdb.ExtendedResourceProperties.ts)
- name: uniqueKeyPolicy
uid: >-
@azure/arm-cosmosdb.RestorableSqlContainerPropertiesResourceContainer.uniqueKeyPolicy
package: '@azure/arm-cosmosdb'
summary: >-
The unique key policy configuration for specifying uniqueness constraints
on documents in the collection in the Azure Cosmos DB service.
fullName: uniqueKeyPolicy
remarks: ''
isDeprecated: false
syntax:
content: 'uniqueKeyPolicy?: UniqueKeyPolicy'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.UniqueKeyPolicy" />
inheritanceDescription: >-
<b>Inherited From</b>
[SqlContainerResource.uniqueKeyPolicy](xref:@azure/arm-cosmosdb.SqlContainerResource.uniqueKeyPolicy)
extends: >-
<xref uid="@azure/arm-cosmosdb.SqlContainerResource" />,<xref
uid="@azure/arm-cosmosdb.ExtendedResourceProperties" />