Remove-AzCosmosDBMongoDBCollection

リファレンス

モジュール:: Az.CosmosDB

CosmosDB MongoDB コレクションを削除します。

構文

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

説明

Remove-AzCosmosDBMongoDBCollection コマンドレットは、CosmosDB MongoDB コレクションを削除します。

例

例 1

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

コマンドレットは、ブール型のオブジェクトを返します (-PassThru が渡された場合)、削除が成功した場合は true です。

パラメーター

-AccountName

Cosmos DB データベースアカウントの名前。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

データベース名。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Sql Container オブジェクト。

Type:	PSMongoDBCollectionGetResults
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

コレクション名。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

ユーザーが出力を受信する場合に true に設定します。操作が成功した場合は出力が true になり、成功しなかった場合はエラーがスローされます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

リソースグループの名前。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSMongoDBCollectionGetResults

出力

Void

Boolean