New-AzWcfRelay

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

構文

New-AzWcfRelay
   -Name <String>
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-RequiresClientAuthorization]
   [-RequiresTransportSecurity]
   [-UserMetadata <String>]
   [-WcfRelayType <Relaytype>]
   [-DefaultProfile <PSObject>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
New-AzWcfRelay
   -Name <String>
   -Namespace <String>
   -ResourceGroupName <String>
   -InputObject <IWcfRelay>
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

説明

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

例 1: 新しい Wcf Relay を作成する

New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 -WcfRelayType 'NetTcp' -UserMetadata "test 01"

CreatedAt                    : 12/20/2022 9:01:10 AM
Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa
                               ce-pwsh01/wcfrelays/wcf-02
IsDynamic                    : False
ListenerCount                : 0
Location                     : eastus
Name                         : wcf-02
RelayType                    : NetTcp
RequiresClientAuthorization  : False
RequiresTransportSecurity    : False
ResourceGroupName            : lucas-relay-rg
SystemDataCreatedAt          : 
SystemDataCreatedBy          : 
SystemDataCreatedByType      : 
SystemDataLastModifiedAt     : 
SystemDataLastModifiedBy     : 
SystemDataLastModifiedByType : 
Type                         : Microsoft.Relay/namespaces/wcfrelays
UpdatedAt                    : 12/20/2022 9:01:10 AM
UserMetadata                 : test 01

このコマンドは、新しい Wcf Relay を作成します。

例 2: 既存の Wcf Relay をパラメーターとして使用して新しい Wcf Relay を作成する

$wcf = Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02
$wcf.UserMetadata = "User Date"
New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-03 -InputObject $wcf

Location Name   ResourceGroupName
-------- ----   -----------------
eastus   wcf-03 lucas-relay-rg

このコマンドは、既存の Wcf Relay をパラメーターとして使用して、新しい Wcf Relay を作成します。

例 3: 既存の WCF Relay を更新する

$wcf = Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02
$wcf.UserMetadata = "User Date"
New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 -InputObject $wcf

Location Name   ResourceGroupName
-------- ----   -----------------
eastus   wcf-02 lucas-relay-rg

このコマンドは、既存の Wcf Relay を更新します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

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

-Name

リレー名。

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

-Namespace

名前空間名

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

-RequiresClientAuthorization

このリレーにクライアント承認が必要な場合は true を返します。それ以外の場合は false。

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

-RequiresTransportSecurity

このリレーにトランスポート セキュリティが必要な場合は true を返します。それ以外の場合は false。

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

-ResourceGroupName

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

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

-SubscriptionId

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

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserMetadata

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

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

-WcfRelayType

WCF リレーの種類。

Type:Relaytype
Position:Named
Default value:None
Required:False
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

入力

IWcfRelay

出力

IWcfRelay

メモ

別名

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

以下で説明するパラメーターを作成するには、適切なプロパティを含むハッシュ テーブルを作成します。 ハッシュ テーブルの詳細については、Get-Help about_Hash_Tablesを実行します。

INPUTOBJECT <IWcfRelay>: WCF リレー リソースの説明。

  • [RelayType <Relaytype?>]: WCF リレーの種類。
  • [RequiresClientAuthorization <Boolean?>]: このリレーにクライアント承認が必要な場合は true を返します。それ以外の場合は false。
  • [RequiresTransportSecurity <Boolean?>]: このリレーにトランスポート セキュリティが必要な場合は true を返します。それ以外の場合は false。
  • [SystemDataCreatedAt <DateTime?>]: リソース作成のタイムスタンプ (UTC)。
  • [SystemDataCreatedBy <String>]: リソースを作成した ID。
  • [SystemDataCreatedByType <CreatedByType?>]: リソースを作成した ID の種類。
  • [SystemDataLastModifiedAt <DateTime?>]: リソースの最終変更のタイムスタンプ (UTC)
  • [SystemDataLastModifiedBy <String>]: リソースを最後に変更した ID。
  • [SystemDataLastModifiedByType <CreatedByType?>]: リソースを最後に変更した ID の種類。
  • [UserMetadata <String>]: usermetadata は、WCF Relay エンドポイントのユーザー定義文字列データを格納するためのプレースホルダーです。 たとえば、チームのリストや連絡先情報などの説明データを格納するために使用できます。 また、ユーザー定義の構成設定を格納することもできます。