forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentdb.pycliyml
More file actions
522 lines (522 loc) · 19 KB
/
documentdb.pycliyml
File metadata and controls
522 lines (522 loc) · 19 KB
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
commandList:
- name: az documentdb check-name-exists
description: Checks that the Azure DocumentDB account name already exists.
href: documentdb#check-name-exists
- name: az documentdb create
description: Create a new Azure DocumentDB database account.
href: documentdb#create
- name: az documentdb delete
description: Deletes an existing Azure DocumentDB database account.
href: documentdb#delete
- name: az documentdb failover-priority-change
description: Changes the failover priority for the Azure DocumentDB database account.
href: documentdb#failover-priority-change
- name: az documentdb list
description: Lists all Azure DocumentDB database accounts within a given resource group or subscription.
href: documentdb#list
- name: az documentdb list-keys
description: Lists the access keys for the specified Azure DocumentDB database account.
href: documentdb#list-keys
- name: az documentdb list-read-only-keys
description: Lists the read-only access keys for the specified Azure DocumentDB database account.
href: documentdb#list-read-only-keys
- name: az documentdb regenerate-key
description: Regenerates an access key for the specified Azure DocumentDB database account.
href: documentdb#regenerate-key
- name: az documentdb show
description: Retrieves the properties of an existing Azure DocumentDB database account.
href: documentdb#show
- name: az documentdb update
description: Update an existing Azure DocumentDB database account.
href: documentdb#update
htmlId: documentdb
examples: []
children:
- commandList: []
htmlId: check-name-exists
examples: []
parameters:
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_check-name-exists
name: az documentdb check-name-exists
description: A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.
summary: Checks that the Azure DocumentDB account name already exists.
Metadata: {}
- commandList: []
htmlId: create
examples: []
parameters:
- name: --name -n
isRequired: True
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: True
summary: Name of the resource group.
description: ''
- name: --default-consistency-level
isRequired: False
summary: Default consistency level of the DocumentDB database account.
description: ''
parameterValueGroup: BoundedStaleness, Eventual, Session, Strong
- name: --ip-range-filter
isRequired: False
summary: Firewall support. Specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
description: ''
- name: --kind
isRequired: False
summary: The type of DocumentDB database account to create.
description: ''
defaultValue: GlobalDocumentDB
parameterValueGroup: GlobalDocumentDB, MongoDB, Parse
- name: --locations
isRequired: False
summary: 'Space separated locations in ''regionName=failoverPriority'' format. E.g "East US"=0 "West US"=1. Failover priority values are 0 for write regions and greater than 0 for read regions. A failover priority value must be unique and less than the total number of regions. Default: single region account in the location of the specified resource group.'
description: ''
- name: --max-interval
isRequired: False
summary: When used with Bounded Staleness consistency, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 1 - 100.
description: ''
defaultValue: 5
- name: --max-staleness-prefix
isRequired: False
summary: When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. Accepted range for this value is 1 - 2,147,483,647.
description: ''
defaultValue: 100
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_create
name: az documentdb create
description: ''
summary: Create a new Azure DocumentDB database account.
Metadata: {}
- commandList: []
htmlId: delete
examples: []
parameters:
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: False
summary: Name of resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_delete
name: az documentdb delete
description: ''
summary: Deletes an existing Azure DocumentDB database account.
Metadata: {}
- commandList: []
htmlId: failover-priority-change
examples: []
parameters:
- name: --failover-policies
isRequired: False
summary: Space separated failover policies in 'regionName=failoverPriority' format. E.g "East US"=0 "West US"=1.
description: ''
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: False
summary: Name of resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_failover-priority-change
name: az documentdb failover-priority-change
description: A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
summary: Changes the failover priority for the Azure DocumentDB database account.
Metadata: {}
- commandList: []
htmlId: list
examples: []
parameters:
- name: --resource-group -g
isRequired: False
summary: Name of resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_list
name: az documentdb list
description: ''
summary: Lists all Azure DocumentDB database accounts within a given resource group or subscription.
Metadata: {}
- commandList: []
htmlId: list-keys
examples: []
parameters:
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: False
summary: Name of resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_list-keys
name: az documentdb list-keys
description: ''
summary: Lists the access keys for the specified Azure DocumentDB database account.
Metadata: {}
- commandList: []
htmlId: list-read-only-keys
examples: []
parameters:
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: False
summary: Name of resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_list-read-only-keys
name: az documentdb list-read-only-keys
description: ''
summary: Lists the read-only access keys for the specified Azure DocumentDB database account.
Metadata: {}
- commandList: []
htmlId: regenerate-key
examples: []
parameters:
- name: --key-kind
isRequired: True
summary: The access key to regenerate.
description: ''
parameterValueGroup: primary, primaryReadonly, secondary, secondaryReadonly
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: False
summary: Name of resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_regenerate-key
name: az documentdb regenerate-key
description: ''
summary: Regenerates an access key for the specified Azure DocumentDB database account.
Metadata: {}
- commandList: []
htmlId: show
examples: []
parameters:
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: False
summary: Name of resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_show
name: az documentdb show
description: ''
summary: Retrieves the properties of an existing Azure DocumentDB database account.
Metadata: {}
- commandList: []
htmlId: update
examples: []
parameters:
- name: --default-consistency-level
isRequired: False
summary: Default consistency level of the DocumentDB database account.
description: ''
parameterValueGroup: BoundedStaleness, Eventual, Session, Strong
- name: --ip-range-filter
isRequired: False
summary: Firewall support. Specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
description: ''
- name: --locations
isRequired: False
summary: Space separated locations in 'regionName=failoverPriority' format. E.g "East US"=0. Failover priority values are 0 for write regions and greater than 0 for read regions. A failover priority value must be unique and less than the total number of regions.
description: ''
- name: --max-interval
isRequired: False
summary: When used with Bounded Staleness consistency, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 1 - 100.
description: ''
- name: --max-staleness-prefix
isRequired: False
summary: When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. Accepted range for this value is 1 - 2,147,483,647.
description: ''
- name: --ids
isRequired: False
summary: One or more resource IDs (space delimited). If provided, no other 'Resource Id' arguments should be specified.
description: ''
- name: --name -n
isRequired: False
summary: Name of the DocumentDB database account.
description: ''
- name: --resource-group -g
isRequired: False
summary: Name of the resource group.
description: ''
- name: --debug
isRequired: False
summary: Increase logging verbosity to show all debug logs.
description: ''
- name: --help -h
isRequired: False
summary: Show this help message and exit.
description: ''
- name: --output -o
isRequired: False
summary: Output format.
description: ''
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
- name: --query
isRequired: False
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
description: ''
- name: --verbose
isRequired: False
summary: Increase logging verbosity. Use --debug for full debug logs.
description: ''
children: []
uid: az_documentdb_update
name: az documentdb update
description: ''
summary: Update an existing Azure DocumentDB database account.
Metadata: {}
uid: az_documentdb
name: 'DocumentDB (Preview) - az documentdb'
description: ''
summary: Commands to manage your Azure DocumentDB (NoSQL) database accounts.
Metadata: {}