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

スポンサーリンク
Rise of the Tomb Raider

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

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

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

New-AzureRmEventGridTopicKey コマンドレット

名前

New-AzureRmEventGridTopicKey

概要

Azure Event Grid トピック用の共有アクセス キーを再生成します。

構文

New-AzureRmEventGridTopicKey
  [-InputObject] <PSTopic>
  [-KeyName] <String>
  [-DefaultProfile <IAzureContextContainer>]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

New-AzureRmEventGridTopicKey
  [-ResourceGroupName] <String>
  [-TopicName] <String>
  [-KeyName] <String>
  [-DefaultProfile <IAzureContextContainer>]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

New-AzureRmEventGridTopicKey
  [-ResourceId] <String>
  [-KeyName] <String>
  [-DefaultProfile <IAzureContextContainer>]
  [-Confirm]
  [-WhatIf]
  [<CommonParameters>]

説明

New-AzureRmEventGridTopicKey コマンドレットは、Azure Event Grid トピック用の共有アクセス キーを再生成します。

パラメーター

-DefaultProfile <IAzureContextContainer>

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

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

-InputObject <PSTopic>

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

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

-KeyName <String>

再生成に必要なキー名を指定します。

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

-ResourceGroupName <String>

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

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

-ResourceId <String>

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

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

-TopicName <String>

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

必須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.Management.EventGrid.Models.TopicSharedAccessKeys

メモ

  • なし

例 1 :

コマンド

 New-AzureRmEventGridTopicKey -ResourceGroup MyResourceGroupName -TopicName Topic1 -KeyName key1 

コマンドの説明

リソース グループ MyResourceGroupName 内の Event Grid トピック Topic1 のキー “key1′ に対応するキーを再生成します。

例 1 :

コマンド

 Get-AzureRmEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 | New-AzureRmEventGridTopicKey -KeyName "key1" 

コマンドの説明

リソース グループ MyResourceGroupName 内の Event Grid トピック Topic1 のキー “key1” に対応するキーを再生成します。

参考