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

スポンサーリンク
Microsoft Public Affiliate Program (JP)

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

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

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

Remove-AzureRmEventGridSubscription コマンドレット

名前

Remove-AzureRmEventGridSubscription

概要

Azure Event Grid イベント サブスクリプションを削除します。

構文

Remove-AzureRmEventGridSubscription
  [-EventSubscriptionName] <String>
  [[-ResourceGroupName] <String>]
  [-DefaultProfile <IAzureContextContainer>]
  [-PassThru]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

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

Remove-AzureRmEventGridSubscription
  [-EventSubscriptionName] <String>
  [-ResourceGroupName] <String>
  [-TopicName] <String>
  [-DefaultProfile <IAzureContextContainer>]
  [-PassThru]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

Remove-AzureRmEventGridSubscription
  [-EventSubscriptionName] <String>
  [-InputObject] <PSTopic>
  [-DefaultProfile <IAzureContextContainer>]
  [-PassThru]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

説明

Remove-AzureRmEventGridSubscription コマンドレットは、Azure Event Grid トピック、リソース、Azure サブスクリプション、もしくはリソース グループのイベント サブスクリプションを削除します。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-EventSubscriptionName <String>

削除するイベント サブスクリプション名を指定します。

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

-InputObject <PSTopic>

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

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

-PassThru [<SwitchParameter>]

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

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

-ResourceGroupName <String>

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

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

-ResourceId <String>

削除するイベント サブスクリプションのリソース ID を指定します。

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

-TopicName <String>

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

必須true
位置2
規定値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.PSEventSubscription

出力

  • System.Object

メモ

  • なし

例 1 :

コマンド

 Remove-AzureRmEventGridSubscription -ResourceGroup MyResourceGroup -TopicName Topic1 -EventSubscriptionName EventSubscription1 

コマンドの説明

リソース グループ MyResourceGroupName 内の Azure Event Grid トピック Topic1 にあるイベント サブスクリプション EventSubscription1 を削除します。

例 2 :

コマンド

 Remove-AzureRmEventGridSubscription -ResourceGroupName MyResourceGroupName -EventSubscriptionName EventSubscription1 

コマンドの説明

リソース グループ MyResourceGroupName のイベント サブスクリプション EventSubscription1 を削除します。

例 3 :

コマンド

 Remove-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 

コマンドの説明

既定の Azure サブスクリプションのイベント サブスクリプション EventSubscription1 を削除します。

例 4 :

コマンド

 Get-AzureRmResource -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" | Remove-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 

コマンドの説明

EventHub 名前空間のイベント サブスクリプション EventSubscription1 を削除します。

例 5 :

コマンド

 Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroup -TopicName Topic1 | Remove-AzureRmEventGridSubscription -EventSubscriptionName EventSubscription1 

コマンドの説明

Event Grid トピックのイベント サブスクリプション EventSubscription1 を削除します。

参考