Skip to content

Commit b99f29d

Browse files
authored
Corrected content of CosmosDB ref docs (MicrosoftDocs#3652)
1 parent e355ad9 commit b99f29d

9 files changed

+552
-708
lines changed

azps-12.5.0/Az.CosmosDB/Remove-AzCosmosDBMongoDBRoleDefinition.md

Lines changed: 47 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,45 @@ content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosD
77
original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBRoleDefinition.md
88
---
99

10-
# Remove-AzCosmosDBMongoDBDatabase
10+
# Remove-AzCosmosDBMongoDBRoleDefinition
1111

1212
## SYNOPSIS
13-
Deletes a CosmosDB MongoDB Database.
13+
This cmdlet removes a MongoDB role definition from a specified Cosmos DB account.
1414

1515
## SYNTAX
1616

17-
### ByNameParameterSet
17+
### ByNameParameterSet (Default)
1818
```
19-
Remove-AzCosmosDBMongoDBDatabase -AccountName <String> -Name <String> -ResourceGroupName <String> [-PassThru]
20-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
Remove-AzCosmosDBMongoDBRoleDefinition -ResourceGroupName <String> -AccountName <String> -Id <String>
20+
[-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
21+
[-Confirm] [<CommonParameters>]
22+
```
23+
24+
### ByParentObjectParameterSet
25+
```
26+
Remove-AzCosmosDBMongoDBRoleDefinition -Id <String> -DatabaseAccountObject <PSDatabaseAccountGetResults>
27+
[-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
28+
[-Confirm] [<CommonParameters>]
2129
```
2230

2331
### ByObjectParameterSet
2432
```
25-
Remove-AzCosmosDBMongoDBDatabase -InputObject <PSMongoDBDatabaseGetResults> [-PassThru]
26-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
33+
Remove-AzCosmosDBMongoDBRoleDefinition -Id <String> -InputObject <PSMongoDBRoleDefinitionGetResults>
34+
[-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
35+
[-Confirm] [<CommonParameters>]
2736
```
2837

2938
## DESCRIPTION
30-
The **Remove-AzCosmosDBMongoDBDatabase** cmdlet deletes a CosmosDB MongoDB Database.
39+
This cmdlet removes a MongoDB role definition from a specified Cosmos DB account.
3140

3241
## EXAMPLES
3342

3443
### Example 1
3544
```powershell
36-
Remove-AzCosmosDBMongoDBDatabase -ResourceGroupName "rgName" -AccountName "accountName" -Name "dbName"
45+
Remove-AzCosmosDBMongoDBRoleDefinition -AccountName "account-name" -ResourceGroupName "resource-group-name" -Id "role-id"
3746
```
3847

39-
The cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful.
48+
This command removes a MongoDB role definition from a specified Cosmos DB account.
4049

4150
## PARAMETERS
4251

@@ -55,6 +64,21 @@ Accept pipeline input: False
5564
Accept wildcard characters: False
5665
```
5766
67+
### -DatabaseAccountObject
68+
CosmosDB Account object
69+
70+
```yaml
71+
Type: Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults
72+
Parameter Sets: ByParentObjectParameterSet
73+
Aliases:
74+
75+
Required: True
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: True (ByValue)
79+
Accept wildcard characters: False
80+
```
81+
5882
### -DefaultProfile
5983
The credentials, account, tenant, and subscription used for communication with Azure.
6084
@@ -70,33 +94,33 @@ Accept pipeline input: False
7094
Accept wildcard characters: False
7195
```
7296
73-
### -InputObject
74-
Mongo Database object.
97+
### -Id
98+
Unique ID (\<Databasename\>.\<RoleName\>) for the MongoDB Role Definition.
7599
76100
```yaml
77-
Type: Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults
78-
Parameter Sets: ByObjectParameterSet
101+
Type: System.String
102+
Parameter Sets: (All)
79103
Aliases:
80104

81105
Required: True
82106
Position: Named
83107
Default value: None
84-
Accept pipeline input: True (ByValue)
108+
Accept pipeline input: False
85109
Accept wildcard characters: False
86110
```
87111
88-
### -Name
89-
Database name.
112+
### -InputObject
113+
A MongoDB Role Definition For Mongo DB.
90114
91115
```yaml
92-
Type: System.String
93-
Parameter Sets: ByNameParameterSet
116+
Type: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoDBRoleDefinitionGetResults
117+
Parameter Sets: ByObjectParameterSet
94118
Aliases:
95119

96120
Required: True
97121
Position: Named
98122
Default value: None
99-
Accept pipeline input: False
123+
Accept pipeline input: True (ByValue)
100124
Accept wildcard characters: False
101125
```
102126
@@ -167,11 +191,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
167191
168192
## INPUTS
169193
170-
### Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults
194+
### Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountGetResults
171195
172-
## OUTPUTS
196+
### Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.Models.MongoDB.PSMongoDBRoleDefinitionGetResults
173197
174-
### System.Void
198+
## OUTPUTS
175199
176200
### System.Boolean
177201

0 commit comments

Comments
 (0)