Remove-AzCosmosDBMongoDBUserDefinition

  • Referência
Módulo:
Az.CosmosDB

Exclui uma definição de usuário existente do CosmosDB MongoDB.

Sintaxe

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

O cmdlet Remove-AzCosmosDBMongoDBUserDefinition exclui uma Definição de Usuário do MongoDB do CosmosDB existente.

Exemplos

Exemplo 1

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

O cmdlet retorna um objeto do tipo bool(when -PassThru is passed) que é true, se a exclusão foi bem-sucedida.

Exemplo 2

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

Remove-AzCosmosDBMongoDBUserDefinition -InputObject $UserDef

O cmdlet retorna um objeto do tipo bool(when -PassThru is passed) que é true, se a exclusão foi bem-sucedida.

Parâmetros

-AccountName

Nome da conta de banco de dados do Cosmos DB.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DatabaseAccountObject

Objeto de conta do CosmosDB

Tipo:PSDatabaseAccountGetResults
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Id

ID de definição de usuário do Mongo.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InputObject

Objeto PSMongoDBUserDefinitionGetResults

Tipo:PSMongoDBUserDefinitionGetResults
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

A ser definido como true se o usuário quiser receber uma saída. A saída é verdadeira se a operação foi bem-sucedida e um erro é gerado se não.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

Nome do grupo de recursos.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults

Saídas

Void

Boolean