Remove-AzCosmosDBMongoDBUserDefinition
Deletes an existing CosmosDB MongoDB User Definition.
Syntax
Remove-AzCosmosDBMongoDBUserDefinition
-ResourceGroupName <String>
-AccountName <String>
-Id <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzCosmosDBMongoDBUserDefinition
-Id <String>
-DatabaseAccountObject <PSDatabaseAccountGetResults>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzCosmosDBMongoDBUserDefinition
-Id <String>
-InputObject <PSMongoDBUserDefinitionGetResults>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Remove-AzCosmosDBMongoDBUserDefinition cmdlet deletes an existing CosmosDB MongoDB User Definition.
Examples
Example 1
Remove-AzCosmosDBMongoDBUserDefinition -ResourceGroupName rgName -AccountName accountName -Id userDefIdThe cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful.
Example 2
$UserDef = Get-AzCosmosDBMongoDBUserDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id
Remove-AzCosmosDBMongoDBUserDefinition -InputObject $UserDefThe cmdlet returns an object of type bool(when -PassThru is passed) which is true, if the delete was successful.
Parameters
-AccountName
Name of the Cosmos DB database account.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabaseAccountObject
CosmosDB Account object
| Type: | PSDatabaseAccountGetResults |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Mongo User Definition ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
PSMongoDBUserDefinitionGetResults Object
| Type: | PSMongoDBUserDefinitionGetResults |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
To be set to true if the user wants to receive an output. The output is true if the operation was successful and an error is thrown if not.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Name of resource group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults