New-AzRelayHybridConnection
サービス ハイブリッド接続を作成または更新します。 この操作はべき等です。
構文
New-AzRelayHybridConnection
-Name <String>
-Namespace <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-RequiresClientAuthorization]
[-UserMetadata <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzRelayHybridConnection
-Name <String>
-Namespace <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-InputObject <IHybridConnection>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
サービス ハイブリッド接続を作成または更新します。 この操作はべき等です。
例
例 1: 指定した Relay 名前空間にハイブリッド接続を作成する
New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01 -UserMetadata "test 01" | Format-List
CreatedAt : 1/1/0001 12:00:00 AM
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microso
ft.Relay/namespaces/namespace-pwsh01/hybridconnections/connection-01
ListenerCount : 0
Location : eastus
Name : connection-01
RequiresClientAuthorization : True
ResourceGroupName : lucas-relay-rg
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Relay/namespaces/hybridconnections
UpdatedAt : 1/1/0001 12:00:00 AM
UserMetadata :
このコマンドレットは、指定された Relay 名前空間にハイブリッド接続を作成します。
例 2: 既存のハイブリッド接続をパラメーターとして使用して新しいハイブリッド接続を作成する
$connection = Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01
$connection.RequiresClientAuthorization = $false
New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02 -InputObject $connection | Format-List
CreatedAt : 12/20/2022 9:13:18 AM
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa
ce-pwsh01/hybridconnections/connection-02
ListenerCount : 0
Location : eastus
Name : connection-02
RequiresClientAuthorization : False
ResourceGroupName : lucas-relay-rg
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Relay/namespaces/hybridconnections
UpdatedAt : 12/20/2022 9:13:18 AM
UserMetadata : test 03
このコマンドレットは、既存のハイブリッド接続をパラメーターとして使用して、新しいハイブリッド接続を作成します。
例 3: 既存のハイブリッド接続を更新する
$connection = Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02
$connection.UserMetadata = "TestHybirdConnection2"
New-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-02 -InputObject $connection | Format-List
CreatedAt : 1/1/0001 12:00:00 AM
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa
ce-pwsh01/hybridconnections/connection-02
ListenerCount : 0
Location : eastus
Name : connection-02
RequiresClientAuthorization : False
ResourceGroupName : lucas-relay-rg
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Relay/namespaces/hybridconnections
UpdatedAt : 1/1/0001 12:00:00 AM
UserMetadata : TestHybirdConnection2
このコマンドレットは、既存のハイブリッド接続を更新します。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
型: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
ハイブリッド接続リソースの説明。 構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。
型: | IHybridConnection |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
ハイブリッド接続名。
型: | String |
Aliases: | HybridConnectionName |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Namespace
名前空間名
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiresClientAuthorization
このハイブリッド接続にクライアント承認が必要な場合は true を返します。それ以外の場合は false。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
Azure サブスクリプション内のリソース グループの名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-SubscriptionId
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
型: | String |
配置: | Named |
規定値: | (Get-AzContext).Subscription.Id |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-UserMetadata
usermetadata は、ハイブリッド接続エンドポイントのユーザー定義文字列データを格納するためのプレースホルダーです。 たとえば、チームとその連絡先情報の一覧などの説明データを格納するために使用できます。 また、ユーザー定義の構成設定を格納することもできます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |