Update-AzWebPubSub

リファレンス

モジュール:: Az.SignalR

終了しているリソースを更新する操作。

構文

Update-AzWebPubSub
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DisableAadAuth]
      [-DisableLocalAuth]
      [-EnableTlsClientCert]
      [-IdentityType <ManagedIdentityType>]
      [-LiveTraceCategory <ILiveTraceCategory[]>]
      [-LiveTraceEnabled <String>]
      [-NetworkAcLDefaultAction <AclAction>]
      [-PrivateEndpointAcl <IPrivateEndpointAcl[]>]
      [-PublicNetworkAccess <String>]
      [-PublicNetworkAllow <WebPubSubRequestType[]>]
      [-PublicNetworkDeny <WebPubSubRequestType[]>]
      [-ResourceLogCategory <IResourceLogCategory[]>]
      [-SkuCapacity <Int32>]
      [-SkuName <String>]
      [-SkuTier <WebPubSubSkuTier>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzWebPubSub
      -InputObject <IWebPubSubIdentity>
      [-DisableAadAuth]
      [-DisableLocalAuth]
      [-EnableTlsClientCert]
      [-IdentityType <ManagedIdentityType>]
      [-LiveTraceCategory <ILiveTraceCategory[]>]
      [-LiveTraceEnabled <String>]
      [-NetworkAcLDefaultAction <AclAction>]
      [-PrivateEndpointAcl <IPrivateEndpointAcl[]>]
      [-PublicNetworkAccess <String>]
      [-PublicNetworkAllow <WebPubSubRequestType[]>]
      [-PublicNetworkDeny <WebPubSubRequestType[]>]
      [-ResourceLogCategory <IResourceLogCategory[]>]
      [-SkuCapacity <Int32>]
      [-SkuName <String>]
      [-SkuTier <WebPubSubSkuTier>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

終了しているリソースを更新する操作。

例

例 1: Web PubSub リソースを更新する

$wps = Update-AzWebPubSub -ResourceGroupName psdemo -Name psdemo-wps `
-IdentityType SystemAssigned -LiveTraceEnabled true `
-LiveTraceCategory @{ Name='ConnectivityLogs' ; Enabled = 'true' }, @{ Name='MessageLogs' ; Enabled = 'true' }

Name       Location SkuName
----       -------- -------
psdemo-wps eastus   Standard_S1

例 2: ID を使用して Web PubSub リソースを更新する

$identity = @{ ResourceGroupName = 'psdemo'
ResourceName = 'psdemo-wps'
SubscriptionId = $(Get-AzContext).Subscription.Id }
$identity | Update-AzWebPubSub -EnableTlsClientCert

$wps | Format-List

DisableAadAuth               : False
DisableLocalAuth             : False
EnableTlsClientCert          : True
ExternalIP                   : 20.62.134.186
HostName                     : psdemo-wps.webpubsub.azure.com
......
Version                      : 1.0

この例では、Web PubSub リソースの ID を表すハッシュテーブルを作成し、その ID オブジェクトをコマンドレットに Update パイプ処理します。最後に、コマンドレットの Update 結果をパイプ処理して Format-List 、すべてのプロパティ値を表示します。

パラメーター

-AsJob

コマンドをジョブとして実行する

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

DefaultProfile パラメーターは機能しません。別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

型:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableAadAuth

DisableLocalAuthEnable または disable aad authWhen set as true, connection with AuthType=aad won't work.

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableLocalAuth

DisableLocalAuthEnable または AccessKeyWhen を true に設定してローカル認証を無効にすると、AccessKey=xxx との接続は機能しません。

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableTlsClientCert

TLS ハンドシェイク中にクライアント証明書を要求する (有効な場合)

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityType

id の種類を表します: systemAssigned、userAssigned、None

型:	ManagedIdentityType
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IWebPubSubIdentity
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-LiveTraceCategory

カテゴリ構成の一覧を取得または設定します。構築するには、LIVETRACECATEGORY プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	ILiveTraceCategory[]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LiveTraceEnabled

ライブトレースを有効にするかどうかを示します。true に設定すると、ライブトレースクライアントはサービスに接続できます。それ以外の場合、ライブトレースクライアントはサービスに接続できないため、"カテゴリ" で構成した内容に関係なく、ログを受信できなくなります。使用可能な値: true、false。大文字と小文字は区別されません。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

リソースの名前。

型:	String
Aliases:	ResourceName
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NetworkAcLDefaultAction

Azure ネットワーク ACL アクション。

型:	AclAction
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

コマンドを非同期的に実行する

型:	SwitchParameter
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PrivateEndpointAcl

プライベートエンドポイントからの要求の ACL 構築するには、PRIVAT Enterprise Edition NDPOINTACL プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IPrivateEndpointAcl[]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAccess

パブリックネットワークアクセスを有効または無効にします。既定値は "Enabled" です。有効になっている場合でも、ネットワーク ACL が適用されます。無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリックネットワークアクセスは常に無効になります。

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAllow

許可される要求の種類。値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。

型:	WebPubSubRequestType[]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkDeny

拒否された要求の種類。値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。

型:	WebPubSubRequestType[]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。

型:	String
Position:	Named
既定値:	None
必須:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceLogCategory

カテゴリ構成の一覧を取得または設定します。構築するには、RESOURCELOGCATEGORY プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

型:	IResourceLogCategory[]
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuCapacity

省略可能、整数。リソースの単位数。既定では 1。存在する場合、次の値が許可されます: Free: 1。標準: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;プレミアム: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

型:	Int32
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuName

SKU の名前。 Required.Allowed 値: Standard_S1、Free_F1、プレミアム_P1

型:	String
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuTier

この特定の SKU のオプションレベル。 'Standard' または 'Free'。 Basic は非推奨です。代わりに Standard を使用してください。

型:	WebPubSubSkuTier
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション ID を取得します。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

型:	String
Position:	Named
既定値:	(Get-AzContext).Subscription.Id
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

リソースを記述するキー値ペアの一覧であるサービスのタグ。

型:	Hashtable
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAssignedIdentity

ユーザー割り当て ID を取得または設定する

型:	Hashtable
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
Position:	Named
既定値:	None
必須:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

IWebPubSubIdentity

出力

IWebPubSubResource

次の方法で共有