イベント ドリブン型サーバーレス アプリを推進、信頼性の高いクラウド アプリが構築可能な 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 New-AzureRmEventGridTopicKey |
説明
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” に対応するキーを再生成します。
参考
- Microsoft Azure Cloud Computing Platform & Services
https://azure.microsoft.com/ja-jp/ - Azure Event Grid のドキュメント – チュートリアル、API リファレンス | Microsoft Docs
https://docs.microsoft.com/ja-jp/azure/event-grid/ - 価格 – Event Grid | Microsoft Azure
https://azure.microsoft.com/ja-jp/pricing/details/event-grid/ - Azure Event Grid – イベント ハンドリング | Microsoft Azure
https://azure.microsoft.com/ja-jp/services/event-grid/ - 各種コンテンツの扱い – Azure Logic Apps | Microsoft Docs
https://docs.microsoft.com/ja-jp/azure/logic-apps/logic-apps-content-type - AzureRM.EventGrid | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/?view=azurermps-5.1.1#event_grid - New-AzureRmEventGridTopicKey (AzureRM.EventGrid) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/azurerm.eventgrid/new-azurermeventgridtopickey?view=azurermps-5.1.1