Remove-AzCosmosDBMongoDBCollection

Referência

Módulo:: Az.CosmosDB

Exclui uma coleção do CosmosDB MongoDB.

Syntax

Remove-AzCosmosDBMongoDBCollection
      -ResourceGroupName <String>
      -AccountName <String>
      -DatabaseName <String>
      -Name <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-AzCosmosDBMongoDBCollection
      -InputObject <PSMongoDBCollectionGetResults>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzCosmosDBMongoDBCollection exclui uma coleção do CosmosDB MongoDB.

Exemplos

Exemplo 1

Remove-AzCosmosDBMongoDBCollection -ResourceGroupName "rgName" -AccountName "accountName" -DatabaseName "dbName" -Name "collectionName"

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
Position:	Named
valor padrão:	None
Obrigatório:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

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

Tipo:	SwitchParameter
Aliases:	cf
Position:	Named
valor padrão:	None
Obrigatório:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

nome do banco de dados.

Tipo:	String
Position:	Named
valor padrão:	None
Obrigatório:	True
Accept pipeline input:	False
Accept wildcard characters:	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
Position:	Named
valor padrão:	None
Obrigatório:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Objeto Container SQL.

Tipo:	PSMongoDBCollectionGetResults
Position:	Named
valor padrão:	None
Obrigatório:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Nome da coleção.

Tipo:	String
Position:	Named
valor padrão:	None
Obrigatório:	True
Accept pipeline input:	False
Accept wildcard characters:	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.

Tipo:	SwitchParameter
Position:	Named
valor padrão:	None
Obrigatório:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Nome do grupo de recursos.

Tipo:	String
Position:	Named
valor padrão:	None
Obrigatório:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Tipo:	SwitchParameter
Aliases:	wi
Position:	Named
valor padrão:	None
Obrigatório:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

PSMongoDBCollectionGetResults

Saídas

Void

Boolean

Compartilhar via