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

スポンサーリンク

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

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

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

Get-AzureRmEventGridTopic コマンドレット

名前

Get-AzureRmEventGridTopic

概要

Event Grid トピックの詳細、もしくは現在の Azure サブスクリプション内にあるすべての Event Grid トピックの一覧を取得します。

構文

Get-AzureRmEventGridTopic
  [-ResourceGroupName] <String>
  [-Name] <String>
  [-DefaultProfile <IAzureContextContainer>]
  [<CommonParameters>]

Get-AzureRmEventGridTopic
  [[-ResourceGroupName] <String>]
  [-DefaultProfile <IAzureContextContainer>]
  [<CommonParameters>]

Get-AzureRmEventGridTopic
  [-ResourceId] <String>
  [-DefaultProfile <IAzureContextContainer>]
  [<CommonParameters>]

説明

Get-AzureRmEventGridTopic コマンドレットは、Event Grid トピックの詳細、もしくは現在の Azure サブスクリプション内にあるすべての Event Grid トピックの一覧を取得します。トピック名が指定されている場合、1つの Event Grid トピックの詳細を返します。トピック名が指定されていない場合、トピックの一覧を返します。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-Name <String>

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

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

-ResourceGroupName <String>

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

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

-ResourceId <String>

Event Grid トピックを表すリソース ID を指定します。

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

<CommonParameters>

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

入力

  • System.String
    • Microsoft.Azure.Commands.EventGrid.Models.PSTopic

出力

  • Microsoft.Azure.Commands.EventGrid.Models.PSTopic
    • System.Collections.Generic.List`1[[Microsoft.Azure.Commands.EventGrid.Models.PSTopicListInstance, Microsoft.Azure.Commands.EventGrid, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

メモ

  • なし

例 1 :

コマンド

 Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 

コマンドの説明

リソース グループ MyResourceGroupName 内の Event Grid トピック Topic1 の詳細を取得します。

例 2 :

コマンド

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

コマンドの説明

リソース グループ MyResourceGroupName 内の Event Grid トピック Topic1 の詳細を取得します。

例 3 :

コマンド

 Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName 

コマンドの説明

リソース グループ MyResourceGroupName 内にあるすべての Event Grid トピックの一覧を取得します。

例 4 :

コマンド

 Get-AzureRmEventGridTopic 

コマンドの説明

サブスクリプション内にあるすべての Event Grid トピックの一覧を取得します。

参考