Remove-AzCosmosDBMongoDBUserDefinition

Módulo:
Az.CosmosDB Module

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

Sintaxe

ByNameParameterSet (Predefinição) 

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>]

Descrição

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

Exemplos

Exemplo 1

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

O cmdlet retorna um objeto do tipo bool(quando -PassThru é passado) 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(quando -PassThru é passado) que é true, se a exclusão foi bem-sucedida.

Parâmetros

-AccountName

Nome da conta de banco de dados do Cosmos DB.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByNameParameterSet
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DatabaseAccountObject

Objeto CosmosDB Account

Propriedades dos parâmetros

Tipo:PSDatabaseAccountGetResults
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByParentObjectParameterSet
Posto:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DefaultProfile

As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Id

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

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InputObject

Objeto PSMongoDBUserDefinitionGetResults

Propriedades dos parâmetros

Tipo:PSMongoDBUserDefinitionGetResults
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByObjectParameterSet
Posto:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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 é lançado se não.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ResourceGroupName

Nome do grupo de recursos.

Propriedades dos parâmetros

Tipo:String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ByNameParameterSet
Posto:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults

Saídas

Void

Boolean