< Back
Set-AzureRmRelayHybridConnection
Post
NAME Set-AzureRmRelayHybridConnection
SYNOPSIS
Updates the description of a HybridConnection in the specified Relay namespace.
SYNTAX
Set-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-InputObject <HybridConnectionAttibutes>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-UserMetadata <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRelayHybridConnection cmdlet updates the description for the HybridConnection in the specified Relay namespace.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <HybridConnectionAttibutes>
HybridConnections object.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
HybridConnections Name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace <String>
Namespace Name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserMetadata <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
-ResourceGroupName
System.String
-NamespaceName
System.String
-WcfRelayName
System.String
-InputObject
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
-UserMetadata
System.String
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
NOTES
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
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
Example 2
PS C:\\> Set-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection
-UserMetadata = "Test UserMetadata updated"
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
Updates the specified HybridConnection with a new description in the specified namespace. This example updates the UserMetadata property with new
value.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... connection
SYNOPSIS
Updates the description of a HybridConnection in the specified Relay namespace.
SYNTAX
Set-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-InputObject <HybridConnectionAttibutes>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-UserMetadata <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmRelayHybridConnection cmdlet updates the description for the HybridConnection in the specified Relay namespace.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <HybridConnectionAttibutes>
HybridConnections object.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
HybridConnections Name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Namespace <String>
Namespace Name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Resource Group Name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UserMetadata <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
-ResourceGroupName
System.String
-NamespaceName
System.String
-WcfRelayName
System.String
-InputObject
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
-UserMetadata
System.String
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
NOTES
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
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
Example 2
PS C:\\> Set-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestHybridConnection
-UserMetadata = "Test UserMetadata updated"
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
Updates the specified HybridConnection with a new description in the specified namespace. This example updates the UserMetadata property with new
value.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... connection