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

スポンサーリンク
Microsoft Public Affiliate Program (JP)(マイクロソフトアフィリエイトプログラム)

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

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

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

Get-AzureRmEventGridTopicType コマンドレット

名前

Get-AzureRmEventGridTopicType

概要

Azure Event Grid によってサポートされるトピックの型の詳細を取得します。

構文

Get-AzureRmEventGridTopicType
  [[-Name] <String>]
  [-DefaultProfile <IAzureContextContainer>]
  [-IncludeEventTypeData]
  [<CommonParameters>]

説明

Get-AzureRmEventGridTopicType コマンドレットは、Azure Event Grid によってサポートされるトピックの型の詳細を取得します。トピックの型の名前が指定されている場合、トピックの型に関する詳細を返します。トピックの型の名前が指定されていない場合、すべてのトピックの型に関する詳細を返します。IncludeEventTypes が指定されている場合、各トピックの型ででサポートされているイベントの型に関する情報がレスポンスに含まれます。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-IncludeEventTypeData [<SwitchParameter>]

このパラメーターが指定されている場合、レスポンスはトピックの型によってサポートされているイベントの型を含みます。

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

-Name <String>

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

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

<CommonParameters>

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

入力

  • System.String
    • System.Management.Automation.SwitchParameter

出力

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

メモ

  • なし

例 1 :

コマンド

 Get-AzureRmEventGridTopicType 

コマンドの説明

トピックの型の一覧を取得します。

例 2 :

コマンド

 Get-AzureRmEventGridTopicType -Name "Microsoft.Storage.StorageAccounts" 

コマンドの説明

StorageAccounts トピックの型に関する情報を取得します。

例 3 :

コマンド

 Get-AzureRmEventGridTopicType -Name "Microsoft.Storage.StorageAccounts" -IncludeEventTypeData 

コマンドの説明

StorageAccounts によってサポートされているイベントの型を含む StorageAccounts トピックの型に関する情報を取得します。

参考