通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Remove-AzCosmosDBMongoDBUserDefinition

模块:
Az.CosmosDB Module

删除现有的 CosmosDB MongoDB 用户定义。

语法

ByNameParameterSet (默认值) 

Remove-AzCosmosDBMongoDBUserDefinition
    -ResourceGroupName <String>
    -AccountName <String>
    -Id <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByParentObjectParameterSet 

Remove-AzCosmosDBMongoDBUserDefinition
    -Id <String>
    -DatabaseAccountObject <PSDatabaseAccountGetResults>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectParameterSet 

Remove-AzCosmosDBMongoDBUserDefinition
    -Id <String>
    -InputObject <PSMongoDBUserDefinitionGetResults>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Remove-AzCosmosDBMongoDBUserDefinition cmdlet 删除现有的 CosmosDB MongoDB 用户定义。

示例

示例 1

Remove-AzCosmosDBMongoDBUserDefinition -ResourceGroupName rgName -AccountName accountName -Id userDefId

如果删除成功，cmdlet 将返回 bool 类型的对象（当传递 -PassThru 时），该对象为 true。

示例 2

$UserDef = Get-AzCosmosDBMongoDBUserDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id

Remove-AzCosmosDBMongoDBUserDefinition -InputObject $UserDef

如果删除成功，cmdlet 将返回 bool 类型的对象（当传递 -PassThru 时），该对象为 true。

参数

-AccountName

Cosmos DB 数据库帐户的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ByNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-DatabaseAccountObject

CosmosDB Account 对象

参数属性

类型:PSDatabaseAccountGetResults
默认值:None
支持通配符:False
不显示:False

参数集

ByParentObjectParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Id

Mongo 用户定义 ID。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-InputObject

PSMongoDBUserDefinitionGetResults 对象

参数属性

类型:PSMongoDBUserDefinitionGetResults
默认值:None
支持通配符:False
不显示:False

参数集

ByObjectParameterSet
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-PassThru

如果用户想要接收输出，则设置为 true。 如果作成功，则输出为 true，如果未成功，则引发错误。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ResourceGroupName

资源组的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ByNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults

输出

Void

Boolean