Skip to content

Commit b6b35be

Browse files
isra-felYeming Liuvidai-msft
authored
Fix mongo db doc issues (#28006)
Co-authored-by: Yeming Liu <[email protected]> Co-authored-by: Vincent Dai <[email protected]>
1 parent 9de8e47 commit b6b35be

File tree

130 files changed

+1088
-813
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+1088
-813
lines changed

src/CosmosDB/CosmosDB/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-->
2020

2121
## Upcoming Release
22+
* Fixed incorrect help documents for MongoDB cmdlets.
2223

2324
## Version 1.18.0
2425
* Added support for creating containers with Vector Embedding Policy.

src/CosmosDB/CosmosDB/help/Az.CosmosDB.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The topics in this section document the Azure PowerShell cmdlets for Azure Cosmo
1515
Get CosmosDB Account.
1616

1717
### [Get-AzCosmosDBAccountKey](Get-AzCosmosDBAccountKey.md)
18-
Get Keys{"ConnectionKeys", "PrimaryReadOnly" or "Keys"} for the given CosmosDB Account.
18+
Get Keys{"ConnectionKeys", "PrimaryReadOnly" or "Keys"} for the given CosmosDB Account.
1919

2020
### [Get-AzCosmosDBCassandraKeyspace](Get-AzCosmosDBCassandraKeyspace.md)
2121
Gets a CosmosDB Cassandra Keyspace.
@@ -57,7 +57,8 @@ Lists all the restorable Azure Cosmos DB Gremlin graphs available for a specific
5757
Lists all the restorable Azure Cosmos DB Gremlin resources available for a specific database account at a given time and location.
5858

5959
### [Get-AzCosmosDBLocation](Get-AzCosmosDBLocation.md)
60-
List Azure Cosmos DB locations and their properties. Get Azure Cosmos DB location properties for a specific location.
60+
List Azure Cosmos DB locations and their properties.
61+
Get Azure Cosmos DB location properties for a specific location.
6162

6263
### [Get-AzCosmosDBMongoDBCollection](Get-AzCosmosDBMongoDBCollection.md)
6364
Gets the CosmosDB MongoDB Collection.
@@ -333,7 +334,7 @@ Creates a new CosmosDB Sql VectorEmbedding object.
333334
Creates a new CosmosDB Sql VectorEmbeddingPolicy object.
334335

335336
### [New-AzCosmosDBSqlVectorIndex](New-AzCosmosDBSqlVectorIndex.md)
336-
Creates a new CosmosDB Sql VectorIndex object.
337+
Creates a new CosmosDB Sql VectorIndex object.
337338

338339
### [New-AzCosmosDBTable](New-AzCosmosDBTable.md)
339340
Creates a new CosmosDB Table.
@@ -378,7 +379,7 @@ Deletes a CosmosDB MongoDB Collection.
378379
Deletes a CosmosDB MongoDB Database.
379380

380381
### [Remove-AzCosmosDBMongoDBRoleDefinition](Remove-AzCosmosDBMongoDBRoleDefinition.md)
381-
Deletes a CosmosDB MongoDB Database.
382+
This cmdlet removes a MongoDB role definition from a specified Cosmos DB account.
382383

383384
### [Remove-AzCosmosDBMongoDBUserDefinition](Remove-AzCosmosDBMongoDBUserDefinition.md)
384385
Deletes an existing CosmosDB MongoDB User Definition.
@@ -495,10 +496,10 @@ Updates the CosmosDB MongoDB Database. Performs a client side patch operation by
495496
Updates the throughput value of a CosmosDB MongoDB Database.
496497

497498
### [Update-AzCosmosDBMongoDBRoleDefinition](Update-AzCosmosDBMongoDBRoleDefinition.md)
498-
Update an existing CosmosDB MongoDB Role Definition.
499+
This cmdlet updates an existing MongoDB role definition in a specified Cosmos DB account.
499500

500501
### [Update-AzCosmosDBMongoDBUserDefinition](Update-AzCosmosDBMongoDBUserDefinition.md)
501-
Update an existing CosmosDB MongoDB User Definition.
502+
This cmdlet updates an existing MongoDB user definition in a specified Cosmos DB account.
502503

503504
### [Update-AzCosmosDBSqlContainer](Update-AzCosmosDBSqlContainer.md)
504505
Updates the CosmosDB Sql Container. Performs a client side patch operation by reading the existing Container.
@@ -544,3 +545,4 @@ Update an existing Azure Managed Instances for Apache Cassandra cluster.
544545

545546
### [Update-AzManagedCassandraDatacenter](Update-AzManagedCassandraDatacenter.md)
546547
Update an existing Azure Managed Instances for Apache Cassandra data center.
548+

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBAccount.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Get-AzCosmosDBAccount -ResourceGroupName <String> [-Name <String>] [-DefaultProf
2020

2121
### ByResourceIdParameterSet
2222
```
23-
Get-AzCosmosDBAccount -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
23+
Get-AzCosmosDBAccount -ResourceId <String> [-DefaultProfile <IAzureContextContainer>]
24+
[<CommonParameters>]
2425
```
2526

2627
## DESCRIPTION

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraTable.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Gets a CosmosDB Cassandra Table.
1515
### ByNameParameterSet (Default)
1616
```
1717
Get-AzCosmosDBCassandraTable -AccountName <String> -KeyspaceName <String> -ResourceGroupName <String>
18-
[-Name <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
18+
[-Name <String>] [-DefaultProfile <IAzureContextContainer>]
19+
[<CommonParameters>]
1920
```
2021

2122
### ByParentObjectParameterSet

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBCassandraTableThroughput.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ Gets the throughput value of the Cassandra Table.
1515
### ByNameParameterSet (Default)
1616
```
1717
Get-AzCosmosDBCassandraTableThroughput -ResourceGroupName <String> -AccountName <String> -KeyspaceName <String>
18-
-Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
-Name <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
19+
[-Confirm] [<CommonParameters>]
1920
```
2021

2122
### ByParentObjectParameterSet
2223
```
2324
Get-AzCosmosDBCassandraTableThroughput -InputObject <PSCassandraKeyspaceGetResults>
24-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
2527
```
2628

2729
## DESCRIPTION

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraph.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Gets the CosmosDB Gremlin Graph.
1515
### ByNameParameterSet (Default)
1616
```
1717
Get-AzCosmosDBGremlinGraph -ResourceGroupName <String> [-Name <String>]
18-
[-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String> [<CommonParameters>]
18+
[-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String>
19+
[<CommonParameters>]
1920
```
2021

2122
### ByParentObjectParameterSet

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBGremlinGraphThroughput.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ Gets the throughput of a CosmosDB Gremlin Graph.
1515
### ByNameParameterSet (Default)
1616
```
1717
Get-AzCosmosDBGremlinGraphThroughput -ResourceGroupName <String> -AccountName <String> -DatabaseName <String>
18-
[-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
19+
[-Confirm] [<CommonParameters>]
1920
```
2021

2122
### ByParentObjectParameterSet
2223
```
2324
Get-AzCosmosDBGremlinGraphThroughput [-Name <String>] -InputObject <PSGremlinGraphGetResults>
24-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
2527
```
2628

2729
## DESCRIPTION

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBLocation.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Get Azure Cosmos DB location properties for a specific location.
1414
## SYNTAX
1515

1616
```
17-
Get-AzCosmosDBLocation [-Location <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
17+
Get-AzCosmosDBLocation [-Location <String>] [-DefaultProfile <IAzureContextContainer>]
18+
[<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -24,6 +25,8 @@ List Azure Cosmos DB locations with their location properties. It includes Locat
2425

2526
### Example 1: Get Azure Cosmos DB Account Location Properties for Given Location
2627
<!-- Skip: Output cannot be splitted from code -->
28+
29+
2730
```powershell
2831
Get-AzCosmosDBLocation -Location "Central US"
2932
@@ -54,6 +57,8 @@ Get-AzCosmosDBLocation -Location "Central US" | ConvertTo-Json
5457

5558
### Example 2: List Azure Cosmos DB Account Locations and their properties
5659
<!-- Skip: Output cannot be splitted from code -->
60+
61+
5762
```powershell
5863
Get-AzCosmosDBLocation
5964

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollection.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Gets the CosmosDB MongoDB Collection.
1515
### ByNameParameterSet (Default)
1616
```
1717
Get-AzCosmosDBMongoDBCollection -ResourceGroupName <String> [-Name <String>]
18-
[-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String> [<CommonParameters>]
18+
[-DefaultProfile <IAzureContextContainer>] -AccountName <String> -DatabaseName <String>
19+
[<CommonParameters>]
1920
```
2021

2122
### ByParentObjectParameterSet

src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBCollectionThroughput.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ Gets the CosmosDB throughput properties of MongoDB Collection.
1515
### ByNameParameterSet (Default)
1616
```
1717
Get-AzCosmosDBMongoDBCollectionThroughput -ResourceGroupName <String> -AccountName <String>
18-
-DatabaseName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
19-
[<CommonParameters>]
18+
-DatabaseName <String> [-Name <String>] [-DefaultProfile <IAzureContextContainer>]
19+
[-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

2222
### ByParentObjectParameterSet
2323
```
2424
Get-AzCosmosDBMongoDBCollectionThroughput [-Name <String>] -InputObject <PSMongoDBCollectionGetResults>
25-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
2627
```
2728

2829
## DESCRIPTION

0 commit comments

Comments
 (0)