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

スポンサーリンク

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

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

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

Set-AzureRmEventGridTopic コマンドレット

名前

Set-AzureRmEventGridTopic

概要

Event Grid トピックのプロパティを設定します。

構文

Set-AzureRmEventGridTopic
  [-InputObject] <PSTopic>
  [-Tag] <Hashtable>
  [-DefaultProfile <IAzureContextContainer>]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

Set-AzureRmEventGridTopic
  [-ResourceGroupName] <String>
  [-Name] <String>
  [-Tag] <Hashtable>
  [-DefaultProfile <IAzureContextContainer>]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

Set-AzureRmEventGridTopic
  [-ResourceId] <String>
  [-Tag] <Hashtable>
  [-DefaultProfile <IAzureContextContainer>]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

説明

Set-AzureRmEventGridTopic コマンドレットは、Event Grid トピックのプロパティを設定します。これは、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

-ResourceGroupName <String>

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

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

-ResourceId <String>

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

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

-Tag <Hashtable>

リソース タグを表すハッシュテーブルを指定します。

必須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
    • System.Collections.Hashtable

出力

  • Microsoft.Azure.Management.EventGrid.Models.Topic

メモ

  • なし

例 1 :

コマンド

 Set-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 -Tag @{ Department="Finance"; Environment="Test" } 

コマンドの説明

指定したタグ Department と Environment を持つタグに置き換えるため、リソース グループ MyResourceGroupName 内の Event Grid トピック Topic1 のプロパティを設定します。

参考