@@ -9,13 +9,11 @@ Locale: en-US
9
9
# Az.CosmosDB Module
10
10
## Description
11
11
The topics in this section document the Azure PowerShell cmdlets for Azure Cosmos DB and Azure Managed Instance for Apache Cassandra in the Azure Resource Manager (ARM) framework. The cmdlets exist in the Microsoft.Azure.Commands.CosmosDB namespace.
12
-
13
- ## Az.CosmosDB Cmdlets
14
12
### [ Get-AzCosmosDBAccount] ( Get-AzCosmosDBAccount.md )
15
- Get Cosmos DB Account.
13
+ Get CosmosDB Account.
16
14
17
15
### [ Get-AzCosmosDBAccountKey] ( Get-AzCosmosDBAccountKey.md )
18
- Get Keys{"ConnectionKeys", "PrimaryReadOnly" or "Keys"} for the given Cosmos DB Account.
16
+ Get Keys{"ConnectionKeys", "PrimaryReadOnly" or "Keys"} for the given CosmosDB Account.
19
17
20
18
### [ Get-AzCosmosDBCassandraKeyspace] ( Get-AzCosmosDBCassandraKeyspace.md )
21
19
Gets a CosmosDB Cassandra Keyspace.
@@ -57,8 +55,7 @@ Lists all the restorable Azure Cosmos DB Gremlin graphs available for a specific
57
55
Lists all the restorable Azure Cosmos DB Gremlin resources available for a specific database account at a given time and location.
58
56
59
57
### [ Get-AzCosmosDBLocation] ( Get-AzCosmosDBLocation.md )
60
- List Azure Cosmos DB locations and their properties.
61
- Get Azure Cosmos DB location properties for a specific location.
58
+ List Azure Cosmos DB locations and their properties. Get Azure Cosmos DB location properties for a specific location.
62
59
63
60
### [ Get-AzCosmosDBMongoDBCollection] ( Get-AzCosmosDBMongoDBCollection.md )
64
61
Gets the CosmosDB MongoDB Collection.
@@ -93,6 +90,9 @@ Gets the CosmosDB MongoDB User Definition.
93
90
### [ Get-AzCosmosDBRestorableDatabaseAccount] ( Get-AzCosmosDBRestorableDatabaseAccount.md )
94
91
Gets the restorable database account object
95
92
93
+ ### [ Get-AzCosmosDBService] ( Get-AzCosmosDBService.md )
94
+ Gets the CosmosDB Service
95
+
96
96
### [ Get-AzCosmosDBSqlContainer] ( Get-AzCosmosDBSqlContainer.md )
97
97
Gets the CosmosDB Sql Container.
98
98
@@ -148,7 +148,7 @@ Lists all the restorable Azure Cosmos DB Tables available for a specific databas
148
148
Gets the CosmosDB Table Role Assignment.
149
149
150
150
### [ Get-AzCosmosDBTableRoleDefinition] ( Get-AzCosmosDBTableRoleDefinition.md )
151
- Gets the CosmosDB Table Role Definition.
151
+ Gets the CosmosDB Role Definition.
152
152
153
153
### [ Get-AzCosmosDBTableThroughput] ( Get-AzCosmosDBTableThroughput.md )
154
154
Gets the throughput of a CosmosDB Table.
@@ -159,9 +159,6 @@ Gets a Azure Managed Instances for Apache Cassandra cluster.
159
159
### [ Get-AzManagedCassandraDatacenter] ( Get-AzManagedCassandraDatacenter.md )
160
160
Gets a Azure Managed Instances for Apache Cassandra data center.
161
161
162
- ### [ Get-AzCosmosDBService] ( Get-AzCosmosDBService.md )
163
- Gets the Cosmos DB Service
164
-
165
162
### [ Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration] ( Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration.md )
166
163
Use this to migrate autoscale throughput to manual throughput and vice versa.
167
164
@@ -190,10 +187,10 @@ Use this to migrate autoscale throughput to manual throughput and vice versa.
190
187
Use this to migrate autoscale throughput to manual throughput and vice versa.
191
188
192
189
### [ New-AzCosmosDBAccount] ( New-AzCosmosDBAccount.md )
193
- Create a new Cosmos DB Account.
190
+ Create a new CosmosDB Account.
194
191
195
192
### [ New-AzCosmosDBAccountKey] ( New-AzCosmosDBAccountKey.md )
196
- Regenerate a given Cosmos DB Account Key.
193
+ Regenerate a given CosmosDB Account Key.
197
194
198
195
### [ New-AzCosmosDBCassandraClusterKey] ( New-AzCosmosDBCassandraClusterKey.md )
199
196
Creates a new CosmosDB Cassandra Cluster Key.
@@ -279,6 +276,9 @@ Creates a new CosmosDB MongoDB User Definition.
279
276
### [ New-AzCosmosDBPermission] ( New-AzCosmosDBPermission.md )
280
277
Creates a new CosmosDB Permission object to be used to create or update a Role Definition.
281
278
279
+ ### [ New-AzCosmosDBService] ( New-AzCosmosDBService.md )
280
+ Creates a new CosmosDB Service.
281
+
282
282
### [ New-AzCosmosDBSqlCompositePath] ( New-AzCosmosDBSqlCompositePath.md )
283
283
Creates a new object of type PSCompositePath. It can be passed as a parameter value for Set-AzCosmosDBSqlContainer.
284
284
@@ -300,9 +300,6 @@ Creates a new object of type PSIndexes. It can be passed as a parameter value fo
300
300
### [ New-AzCosmosDBSqlIndexingPolicy] ( New-AzCosmosDBSqlIndexingPolicy.md )
301
301
Creates a new CosmosDB Sql IndexingPolicy object.
302
302
303
- ### [ New-AzCosmosDBSqlVectorEmbeddingPolicy] ( New-AzCosmosDBSqlVectorEmbeddingPolicy.md )
304
- Creates a new CosmosDB Sql VectorEmbeddingPolicy object.
305
-
306
303
### [ New-AzCosmosDBSqlRoleAssignment] ( New-AzCosmosDBSqlRoleAssignment.md )
307
304
Creates a new CosmosDB Sql Role Assignment.
308
305
@@ -327,6 +324,15 @@ Creates a new CosmosDB SqlUniqueKeyPolicy object.
327
324
### [ New-AzCosmosDBSqlUserDefinedFunction] ( New-AzCosmosDBSqlUserDefinedFunction.md )
328
325
Creates a new CosmosDB Sql UserDefinedFunction.
329
326
327
+ ### [ New-AzCosmosDBSqlVectorEmbedding] ( New-AzCosmosDBSqlVectorEmbedding.md )
328
+ Creates a new CosmosDB Sql VectorEmbedding object.
329
+
330
+ ### [ New-AzCosmosDBSqlVectorEmbeddingPolicy] ( New-AzCosmosDBSqlVectorEmbeddingPolicy.md )
331
+ Creates a new CosmosDB Sql VectorEmbeddingPolicy object.
332
+
333
+ ### [ New-AzCosmosDBSqlVectorIndex] ( New-AzCosmosDBSqlVectorIndex.md )
334
+ Creates a new CosmosDB Sql VectorIndex object.
335
+
330
336
### [ New-AzCosmosDBTable] ( New-AzCosmosDBTable.md )
331
337
Creates a new CosmosDB Table.
332
338
@@ -348,9 +354,6 @@ Creates a new Azure Managed Instances for Apache Cassandra cluster.
348
354
### [ New-AzManagedCassandraDatacenter] ( New-AzManagedCassandraDatacenter.md )
349
355
Create a new Azure Managed Instances for Apache Cassandra data center.
350
356
351
- ### [ New-AzCosmosDBService] ( New-AzCosmosDBService.md )
352
- Creates a new Cosmos DB Service
353
-
354
357
### [ Remove-AzCosmosDBAccount] ( Remove-AzCosmosDBAccount.md )
355
358
Remove a Cosmos DB Account.
356
359
@@ -372,12 +375,15 @@ Deletes a CosmosDB MongoDB Collection.
372
375
### [ Remove-AzCosmosDBMongoDBDatabase] ( Remove-AzCosmosDBMongoDBDatabase.md )
373
376
Deletes a CosmosDB MongoDB Database.
374
377
375
- ### [ Remove-AzCosmosDBMongoDBDatabase ] ( Remove-AzCosmosDBMongoDBDatabase .md )
378
+ ### [ Remove-AzCosmosDBMongoDBRoleDefinition ] ( Remove-AzCosmosDBMongoDBRoleDefinition .md )
376
379
Deletes a CosmosDB MongoDB Database.
377
380
378
381
### [ Remove-AzCosmosDBMongoDBUserDefinition] ( Remove-AzCosmosDBMongoDBUserDefinition.md )
379
382
Deletes an existing CosmosDB MongoDB User Definition.
380
383
384
+ ### [ Remove-AzCosmosDBService] ( Remove-AzCosmosDBService.md )
385
+ Deletes the CosmosDB Service.
386
+
381
387
### [ Remove-AzCosmosDBSqlContainer] ( Remove-AzCosmosDBSqlContainer.md )
382
388
Deletes the CosmosDB Sql Container.
383
389
@@ -414,14 +420,32 @@ Deletes a Azure Managed Instances for Apache Cassandra cluster.
414
420
### [ Remove-AzManagedCassandraDatacenter] ( Remove-AzManagedCassandraDatacenter.md )
415
421
Deletes a Azure Managed Instances for Apache Cassandra data center.
416
422
417
- ### [ Remove-AzCosmosDBService] ( Remove-AzCosmosDBService.md )
418
- Deletes a Cosmos DB Service
419
-
420
423
### [ Restore-AzCosmosDBAccount] ( Restore-AzCosmosDBAccount.md )
421
424
Restores an existing CosmosDB account (live or deleted) to a given timestamp to a new account
422
425
426
+ ### [ Restore-AzCosmosDBGremlinDatabase] ( Restore-AzCosmosDBGremlinDatabase.md )
427
+ Restore a deleted gremlin database to a given timestamp in the same account
428
+
429
+ ### [ Restore-AzCosmosDBGremlinGraph] ( Restore-AzCosmosDBGremlinGraph.md )
430
+ Restore a deleted gremlin graph in a database to a given timestamp in the same account
431
+
432
+ ### [ Restore-AzCosmosDBMongoDBCollection] ( Restore-AzCosmosDBMongoDBCollection.md )
433
+ Restore a deleted mongodb collection in a database to a given timestamp in the same account
434
+
435
+ ### [ Restore-AzCosmosDBMongoDBDatabase] ( Restore-AzCosmosDBMongoDBDatabase.md )
436
+ Restore a deleted mongodb database to a given timestamp in the same account
437
+
438
+ ### [ Restore-AzCosmosDBSqlContainer] ( Restore-AzCosmosDBSqlContainer.md )
439
+ Restore a deleted sql container in a database to a given timestamp in the same account
440
+
441
+ ### [ Restore-AzCosmosDBSqlDatabase] ( Restore-AzCosmosDBSqlDatabase.md )
442
+ Restore a deleted sql database to a given timestamp in the same account
443
+
444
+ ### [ Restore-AzCosmosDBTable] ( Restore-AzCosmosDBTable.md )
445
+ Restore a deleted table to a given timestamp in the same account
446
+
423
447
### [ Update-AzCosmosDBAccount] ( Update-AzCosmosDBAccount.md )
424
- Update a CosmosDB account attributes.
448
+ Update a Cosmos DB Account attributes.
425
449
426
450
### [ Update-AzCosmosDBAccountFailoverPriority] ( Update-AzCosmosDBAccountFailoverPriority.md )
427
451
Update Failover Region Priority of a Cosmos DB Account.
@@ -468,10 +492,10 @@ Updates the CosmosDB MongoDB Database. Performs a client side patch operation by
468
492
### [ Update-AzCosmosDBMongoDBDatabaseThroughput] ( Update-AzCosmosDBMongoDBDatabaseThroughput.md )
469
493
Updates the throughput value of a CosmosDB MongoDB Database.
470
494
471
- ### [ New -AzCosmosDBMongoDBRoleDefinition] ( New -AzCosmosDBMongoDBRoleDefinition.md)
495
+ ### [ Update -AzCosmosDBMongoDBRoleDefinition] ( Update -AzCosmosDBMongoDBRoleDefinition.md)
472
496
Update an existing CosmosDB MongoDB Role Definition.
473
497
474
- ### [ New -AzCosmosDBMongoDBUserDefinition] ( New -AzCosmosDBMongoDBUserDefinition.md)
498
+ ### [ Update -AzCosmosDBMongoDBUserDefinition] ( Update -AzCosmosDBMongoDBUserDefinition.md)
475
499
Update an existing CosmosDB MongoDB User Definition.
476
500
477
501
### [ Update-AzCosmosDBSqlContainer] ( Update-AzCosmosDBSqlContainer.md )
@@ -518,24 +542,3 @@ Update an existing Azure Managed Instances for Apache Cassandra cluster.
518
542
519
543
### [ Update-AzManagedCassandraDatacenter] ( Update-AzManagedCassandraDatacenter.md )
520
544
Update an existing Azure Managed Instances for Apache Cassandra data center.
521
-
522
- ### [ Restore-AzCosmosDBSqlDatabase] ( Restore-AzCosmosDBSqlDatabase )
523
- Restore a deleted sql database to a given timestamp in the same account
524
-
525
- ### [ Restore-AzCosmosDBSqlContainer] ( Restore-AzCosmosDBSqlContainer )
526
- Restore a deleted sql container in a database to a given timestamp in the same account
527
-
528
- ### [ Restore-AzCosmosDBMongoDBDatabase] ( Restore-AzCosmosDBMongoDBDatabase )
529
- Restore a deleted mongodb database to a given timestamp in the same account
530
-
531
- ### [ Restore-AzCosmosDBMongoDBCollection] ( Restore-AzCosmosDBMongoDBCollection )
532
- Restore a deleted mongodb collection in a database to a given timestamp in the same account
533
-
534
- ### [ Restore-AzCosmosDBGremlinDatabase] ( Restore-AzCosmosDBGremlinDatabase.md )
535
- Restore a deleted gremlin database to a given timestamp in the same account
536
-
537
- ### [ Restore-AzCosmosDBGremlinGraph] ( Restore-AzCosmosDBGremlinGraph.md )
538
- Restore a deleted gremlin graph in a database to a given timestamp in the same account
539
-
540
- ### [ Restore-AzCosmosDBTable] ( Restore-AzCosmosDBTable.md )
541
- Restore a deleted table to a given timestamp in the same account
0 commit comments