你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

New-AzRelayHybridConnection

  • 参考
模块:
Az.Relay

创建或更新服务混合连接。 此操作是幂等的。

语法

New-AzRelayHybridConnection
   -Name <String>
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-RequiresClientAuthorization]
   [-UserMetadata <String>]
   [-DefaultProfile <PSObject>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
New-AzRelayHybridConnection
   -Name <String>
   -Namespace <String>
   -ResourceGroupName <String>
   -InputObject <IHybridConnection>
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

说明

创建或更新服务混合连接。 此操作是幂等的。

示例

示例 1：在指定的中继命名空间中创建混合连接

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                 :

此 cmdlet 在指定的中继命名空间中创建混合连接。

示例 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

此 cmdlet 使用现有的混合连接作为参数创建新的混合连接。

示例 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

此 cmdlet 更新现有的混合连接。

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet，请使用 SubscriptionId 参数。

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

-InputObject

混合连接资源的说明。 若要构造，请参阅 INPUTOBJECT 属性的 NOTES 部分并创建哈希表。

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

-Name

混合连接名称。

Type:String
Aliases:HybridConnectionName
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

-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 是用于存储混合连接终结点的用户定义字符串数据的占位符。 例如，它可用于存储描述性数据，例如团队列表及其联系信息。 此外，可以存储用户定义的配置设置。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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

输入

IHybridConnection

输出

IHybridConnection

备注

别名

复杂参数属性

若要创建下面所述的参数，请构造一个包含相应属性的哈希表。 有关哈希表的信息，请运行 Get-Help about_Hash_Tables。

INPUTOBJECT <IHybridConnection>：混合连接资源的说明。

  • [RequiresClientAuthorization <Boolean?>]：如果此混合连接需要客户端授权，则返回 true;否则为 false。
  • [SystemDataCreatedAt <DateTime?>]：资源创建时间戳（UTC）。
  • [SystemDataCreatedBy <String>]：创建资源的标识。
  • [SystemDataCreatedByType <CreatedByType?>]：创建资源的标识的类型。
  • [SystemDataLastModifiedAt <DateTime?>]：资源上次修改的时间戳（UTC）
  • [SystemDataLastModifiedBy <String>]：上次修改资源的标识。
  • [SystemDataLastModifiedByType <CreatedByType?>]：上次修改资源的标识类型。
  • [UserMetadata <String>]：usermetadata 是用于存储混合连接终结点的用户定义字符串数据的占位符。 例如，它可用于存储描述性数据，例如团队列表及其联系信息。 此外，可以存储用户定义的配置设置。