Azure Event Grid で使用できる Azure PowerShell コマンドレット (Remove-AzureRmEventGridTopic) について

イベントドリブン型サーバーレスアプリを推進、信頼性の高いクラウドアプリが構築可能な Azure Event Grid の管理について、Azure ポータルだけではなく、Azure PowerShell でも操作が可能になっています。

Azure PowerShell における Azure Event Grid の管理は、ドキュメントにも公開されていますが、使用するパラメーターに関しては現状、英語の情報のみとなっているため、日本語訳 (意訳) してみました。

ここでは、Remove-AzureRmEventGridTopic コマンドレットのヘルプ情報について、「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※Azure Event Grid で使用できる Azure PowerShell コマンドレット一覧については、「Azure Event Grid で使用できる Azure PowerShell コマンドレット一覧について」を参照。

Remove-AzureRmEventGridTopic コマンドレット

名前

Remove-AzureRmEventGridTopic

概要

Azure Event Grid トピックを削除します。

構文

Remove-AzureRmEventGridTopic
[-InputObject] <PSTopic>
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-Confirm]
[-WhatIf]
[<CommonParameters>]

Remove-AzureRmEventGridTopic
[-ResourceGroupName] <String>
[-Name] <String>
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-Confirm]
[-WhatIf]
[<CommonParameters>]

Remove-AzureRmEventGridTopic
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[-PassThru]
[-Confirm]
[-WhatIf]
[<CommonParameters>]

説明

Remove-AzureRmEventGridTopic コマンドレットは、Azure Event Grid トピックを削除します。

パラメーター

-DefaultProfile <IAzureContextContainer>

Azure と通信するために使用される資格情報、アカウント、テナント、およびサブスクリプション情報を指定します。

必須	false
位置	named
規定値	None
パイプライン入力を許可する	False
ワイルドカード文字を許可する	false

-InputObject <PSTopic>

EventGrid トピックオブジェクトを指定します。

必須	true
位置	0
規定値	None
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Name <String>

EventGrid トピック名を指定します。

必須	true
位置	1
規定値	None
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-PassThru [<SwitchParameter>]

削除操作の状態を返す場合に指定します。既定では、このコマンドレットは出力を生成しません。

必須	false
位置	named
規定値	False
パイプライン入力を許可する	False
ワイルドカード文字を許可する	false

-ResourceGroupName <String>

リソースグループ名を指定します。

必須	true
位置	0
規定値	None
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-ResourceId <String>

EventGrid トピックのリソース ID を指定します。

必須	true
位置	1
規定値	None
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-Confirm [<SwitchParameter>]

コマンドレットを実行する前に、確認のプロンプトを表示します。

必須	false
位置	named
規定値	False
パイプライン入力を許可する	False
ワイルドカード文字を許可する	false

-WhatIf [<SwitchParameter>]

コマンドレットを実行する際、どのように動作するか表示します。コマンドレットは、実際には実行されません。

必須	false
位置	named
規定値	False
パイプライン入力を許可する	False
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。

入力

System.String

Microsoft.Azure.Commands.EventGrid.Models.PSTopic

出力

System.Object

メモ

なし

例

例 1 :

コマンド

 Remove-AzureRmEventGridTopic -ResourceGroupName MyResourceGroupName -Name Topic1

コマンドの説明

リソースグループ MyResourceGroupName 内の Event Grid トピック Topic1 を削除します。

例 2 :

コマンド

 Get-AzureRmResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/topics/Topic1" | Remove-AzureRmEventGridTopic