Set-AzureRmRelayHybridConnection

Updates the description of a HybridConnection in the specified Relay namespace.

Syntax

Set-AzureRmRelayHybridConnection
   -ResourceGroupName <String>
   -Namespace <String>
   -Name <String>
   [-InputObject <HybridConnectionAttibutes>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmRelayHybridConnection
   -ResourceGroupName <String>
   -Namespace <String>
   -Name <String>
   [-UserMetadata <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureRmRelayHybridConnection cmdlet updates the description for the HybridConnection in the specified Relay namespace.

Examples

Example 1

PS C:\>
PS C:\> $GetHybrid = Get-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection
PS C:\> $GetHybrid.UserMetadata = "Test UserMetadata"
PS C:\> Set-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -InputObject $GetHybrid

Example 2

PS C:\> Set-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection -UserMetadata = "Test UserMetadata updated"

Updates the specified HybridConnection with a new description in the specified namespace. This example updates the UserMetadata property with new value.

Required Parameters

-Name

HybridConnections Name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Namespace

Namespace Name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Resource Group Name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:System.Management.Automation.SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

HybridConnections object.

Type:Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-UserMetadata

Gets or sets 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.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:System.Management.Automation.SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

-ResourceGroupName

System.String

Inputs

-NamespaceName

System.String

Inputs

-WcfRelayName

System.String

Inputs

-InputObject

Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes

Inputs

-UserMetadata

System.String

Outputs

Examples - 1 : InputObject

CreatedAt : 4/26/2017 10:04:15 PM UpdatedAt : 4/26/2017 10:08:11 PM ListenerCount : RequiresClientAuthorization : True UserMetadata : Test UserMetadata Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-ServiceBus-WestUS /providers/Microsoft.Relay/namespaces/TestNameSpace-HybirdConnection/HybridConnections/TestHybirdConnectio n2 Name : TestHybirdConnection2 Type : Microsoft.Relay/HybridConnections

Outputs

Examples - 2 : Properties

CreatedAt : 4/26/2017 10:04:15 PM UpdatedAt : 4/26/2017 10:10:25 PM ListenerCount : RequiresClientAuthorization : True UserMetadata : Test UserMetadata updated Id : /subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-ServiceBus-WestUS /providers/Microsoft.Relay/namespaces/TestNameSpace-HybirdConnection/HybridConnections/TestHybirdConnectio n1 Name : TestHybirdConnection1 Type : Microsoft.Relay/HybridConnections