Set-AzNotificationHubAuthorizationRule

  • リファレンス
モジュール:
Az.NotificationHubs

通知ハブの承認規則を設定します。

構文

Set-AzNotificationHubAuthorizationRule
   [-ResourceGroup] <String>
   [-Namespace] <String>
   [-NotificationHub] <String>
   [-InputFile] <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzNotificationHubAuthorizationRule
   [-ResourceGroup] <String>
   [-Namespace] <String>
   [-NotificationHub] <String>
   [-SASRule] <SharedAccessAuthorizationRuleAttributes>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzNotificationHubAuthorizationRule コマンドレットは、通知ハブに割り当てられた Shared Access Signature (SAS) 承認規則を変更します。 承認規則では、さまざまなアクセス許可レベルに基づいて、URI としてリンクを作成することで、通知ハブへのアクセスを管理します。 アクセス許可レベルには、次のいずれかを指定できます。

  • 聞く
  • Send
  • 管理クライアントは、適切なアクセス許可レベルに基づいて、これらの URI のいずれかに転送されます。 たとえば、リッスンアクセス許可を与えられたクライアントは、そのアクセス許可の URI に転送されます。 このコマンドレットでは、通知ハブに割り当てられた承認規則を変更する 2 つの方法を提供します。 1 つの場合は、SharedAccessAuthorizationRuleAttributes オブジェクトのインスタンスを作成し、そのオブジェクトをルールに保持するプロパティ値を使用して構成できます。 .NET Framework を使用してオブジェクトを構成できます。 その後、SASRule パラメーターを使用して、これらのプロパティ値をルールにコピーできます。 または、関連する構成値を含む JSON (JavaScript Object Notation) ファイルを作成し、InputFile パラメーターを使用してそれらの値を適用することもできます。 JSON ファイルは、{ "Name": "ContosoAuthorizationRule"、
    "PrimaryKey": "WE4qH0398AyXjlekt56gg1gMR3NHoMs29KkUnnpUk01Y=",
    "Rights": [
    "Listen",
    "送信"
    ]
    } New-AzNotificationHubAuthorizationRule コマンドレットと組み合わせて使用すると、前の JSON サンプルでは、ユーザーにハブへのリッスン権限と送信権限を付与するために、ContosoAuthorizationRule という名前の承認規則が変更されます。

例

例 1: 通知ハブに割り当てられた承認規則を変更する

Set-AzNotificationHubAuthorizationRule -Namespace "ContosoNamespace" -ResourceGroup "ContosoNotificationGroup" -NotificationHub "ContosoExternalHub" -InputFile "C:\Configuration\AuthorizationRules.json"

このコマンドは、ContosoExternalHub という名前の通知ハブに割り当てられた承認規則を変更します。 ハブが配置されている名前空間と、ハブが割り当てられているリソース グループを指定する必要があります。 変更されたルールに関する情報は、コマンド自体には含まれません。 代わりに、その情報は入力ファイル C:\Configuration\AuthorizationRules.json にあります。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

確認を求めないでください。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputFile

新しい規則の構成情報を含む JSON ファイルへのパスを指定します。

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Namespace

通知ハブが割り当てられる名前空間を指定します。 名前空間は、通知ハブをグループ化して分類する方法を提供します。

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NotificationHub

このコマンドレットで承認規則を割り当てる通知ハブを指定します。 通知ハブは、それらのクライアントが使用するに関係なく、複数のクライアントにプッシュ通知を送信するために使用されます。

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroup

通知ハブが割り当てられるリソース グループを指定します。 リソース グループは、名前空間、通知ハブ、承認規則などの項目を、インベントリ管理と Azure 管理に役立つ方法で整理します。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SASRule

変更される承認規則の 構成情報を含む SharedAccessAuthorizationRuleAttributes オブジェクトを指定します。

Type:SharedAccessAuthorizationRuleAttributes
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

出力

SharedAccessAuthorizationRuleAttributes