Remove-AzCosmosDBMongoDBUserDefinition
既存の CosmosDB MongoDB ユーザー定義を削除します。
構文
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>]
説明
Remove-AzCosmosDBMongoDBUserDefinition コマンドレットは、既存の CosmosDB MongoDB ユーザー定義を削除します。
例
例 1
Remove-AzCosmosDBMongoDBUserDefinition -ResourceGroupName rgName -AccountName accountName -Id userDefId
コマンドレットは、ブール型のオブジェクトを返します (-PassThru が渡された場合)、削除が成功した場合は true です。
例 2
$UserDef = Get-AzCosmosDBMongoDBUserDefinition -AccountName accountName -ResourceGroupName resourceGroupName -Id id
Remove-AzCosmosDBMongoDBUserDefinition -InputObject $UserDef
コマンドレットは、ブール型のオブジェクトを返します (-PassThru が渡された場合)、削除が成功した場合は true です。
パラメーター
-AccountName
Cosmos DB データベース アカウントの名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DatabaseAccountObject
CosmosDB アカウント オブジェクト
型: | PSDatabaseAccountGetResults |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
Mongo ユーザー定義 ID。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
PSMongoDBUserDefinitionGetResults オブジェクト
型: | PSMongoDBUserDefinitionGetResults |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PassThru
ユーザーが出力を受信する場合に true に設定します。 操作が成功した場合は出力が true になり、成功しなかった場合はエラーがスローされます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
リソース グループの名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBUserDefinitionGetResults
出力
関連リンク
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Azure PowerShell