Set-AzWcfRelay

モジュール:

Az.Relay Module

WCF リレーを作成または更新します。 この操作はべき等です。

構文

UpdateExpanded (既定)

Set-AzWcfRelay
    -Name <String>
    -Namespace <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-UserMetadata <String>]
    [-WcfRelayType <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Set-AzWcfRelay
    -Name <String>
    -Namespace <String>
    -ResourceGroupName <String>
    -InputObject <IWcfRelay>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

WCF リレーを作成または更新します。 この操作はべき等です。

例

例 1: InputObject を使用して、指定された Relay 名前空間の WcfRelay の説明を更新します。

$wcf = Get-AzWcfRelay -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name wcfRelay-01
$wcf.UserMetadata = "User Meta Data"
Set-AzWcfRelay -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name wcfRelay-01 -InputObject $wcf | Format-List

CreatedAt                    : 1/1/0001 12:00:00 AM
Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/wcfrelays/wcfRe
                               lay-01
IsDynamic                    : False
ListenerCount                : 0
Location                     : eastus
Name                         : wcfRelay-01
RelayType                    : NetTcp
RequiresClientAuthorization  : False
RequiresTransportSecurity    : False
ResourceGroupName            : Relay-ServiceBus-EastUS
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         : Microsoft.Relay/namespaces/wcfrelays
UpdatedAt                    : 1/1/0001 12:00:00 AM
UserMetadata                 : User Meta Data

このコマンドは、指定された Relay 名前空間の WcfRelay の説明を更新します。

例 2: プロパティを使用して、指定した Relay 名前空間の WcfRelay の説明を更新します。

Set-AzWcfRelay -ResourceGroupName Relay-ServiceBus-EastUS -Namespace namespace-pwsh01 -Name wcfRelay-01 -UserMetadata "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." | Format-List

CreatedAt                    : 3/30/2023 1:56:56 AM
Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/Relay-ServiceBus-EastUS/providers/Microsoft.Relay/namespaces/namespace-pwsh01/wcfrelays/wcfRe
                               lay-01
IsDynamic                    : False
ListenerCount                : 0
Location                     : eastus
Name                         : wcfRelay-01
RelayType                    : NetTcp
RequiresClientAuthorization  : False
RequiresTransportSecurity    : False
ResourceGroupName            : Relay-ServiceBus-EastUS
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         : Microsoft.Relay/namespaces/wcfrelays
UpdatedAt                    : 3/30/2023 2:53:03 AM
UserMetadata                 : usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list
                               of teams and their contact information also user-defined configuration settings can be stored.

このコマンドは、指定した名前空間の新しい説明を使用して、指定した WcfRelay を更新します。 次の使用例は、UserMetadata プロパティを新しい値で更新します。

パラメーター

-Confirm

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	Cf

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-DefaultProfile

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

パラメーターのプロパティ

型:	PSObject
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	AzureRMContext, AzureCredential

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-InputObject

WCF リレー リソースの説明。 構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

パラメーターのプロパティ

型:	IWcfRelay
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

Update

配置:	Named
必須:	True
パイプラインからの値:	True
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Name

リレー名。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Namespace

名前空間名

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ResourceGroupName

Azure サブスクリプション内のリソース グループの名前。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。

パラメーターのプロパティ

型:	String
規定値:	(Get-AzContext).Subscription.Id
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UserMetadata

usermetadata は、WCF Relay エンドポイントのユーザー定義文字列データを格納するためのプレースホルダーです。 たとえば、チームのリストや連絡先情報などの説明データを格納するために使用できます。 また、ユーザー定義の構成設定を格納することもできます。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WcfRelayType

WCF リレーの種類。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	wi

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

IWcfRelay

出力

IWcfRelay