< Back
Set-AzureRmWcfRelay
Post
NAME Set-AzureRmWcfRelay
SYNOPSIS
Updates the description of a WcfRelay in the specified Relay namespace.
SYNTAX
Set-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-InputObject
<WcfRelayAttributes>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-UserMetadata
<String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmWcfRelay cmdlet updates the description for the WcfRelay 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 <WcfRelayAttributes>
WcfRelay object.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
WcfRelay 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.WcfRelayAttributes
-WcfRelayType
System.String
-UserMetadata
System.String
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.WcfRelayAttributes
Example 1 - InputObject
Microsoft.Azure.Commands.Relay.Models.WcfRelayAttributes
RelayType : Http CreatedAt : 4/26/2017 5:14:46 PM UpdatedAt : 4/26/2017 5:16:50 PM
ListenerCount : RequiresClientAuthorization : False RequiresTransportSecurity : True IsDynamic : False
UserMetadata : usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be
used to store desc riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
Id :
/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel
ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay2 Name : TestWCFRelay2 Type :
Microsoft.Relay/WcfRelays
Example 2 - Properties
Microsoft.Azure.Commands.Relay.Models.WcfRelayAttributes
RelayType : NetTcp CreatedAt : 4/26/2017 5:20:08 PM UpdatedAt : 4/26/2017 5:26:09 PM
ListenerCount : RequiresClientAuthorization : True RequiresTransportSecurity : True IsDynamic : False
UserMetadata : User Meta data Id :
/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel
ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay Name : TestWCFRelay Type :
Microsoft.Relay/WcfRelays
NOTES
Example 1 - InputObject
PS C:\\>
PS C:\\> $getWcfRelay = Get-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -WcfRelayName
TestWCFRelay
PS C:\\> $getWcfRelay.UserMetadata = "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can
be used to store desc
riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored."
PS C:\\> Set-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -InputObject
$getWcfRelay
Example 2 - Properties
PS C:\\> Set-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -UserMetadata "User
Meta data"
Updates the specified WcfRelay 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 ... rmwcfrelay
SYNOPSIS
Updates the description of a WcfRelay in the specified Relay namespace.
SYNTAX
Set-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-InputObject
<WcfRelayAttributes>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmWcfRelay [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>] [-UserMetadata
<String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmWcfRelay cmdlet updates the description for the WcfRelay 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 <WcfRelayAttributes>
WcfRelay object.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
WcfRelay 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.WcfRelayAttributes
-WcfRelayType
System.String
-UserMetadata
System.String
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.WcfRelayAttributes
Example 1 - InputObject
Microsoft.Azure.Commands.Relay.Models.WcfRelayAttributes
RelayType : Http CreatedAt : 4/26/2017 5:14:46 PM UpdatedAt : 4/26/2017 5:16:50 PM
ListenerCount : RequiresClientAuthorization : False RequiresTransportSecurity : True IsDynamic : False
UserMetadata : usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be
used to store desc riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.
Id :
/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel
ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay2 Name : TestWCFRelay2 Type :
Microsoft.Relay/WcfRelays
Example 2 - Properties
Microsoft.Azure.Commands.Relay.Models.WcfRelayAttributes
RelayType : NetTcp CreatedAt : 4/26/2017 5:20:08 PM UpdatedAt : 4/26/2017 5:26:09 PM
ListenerCount : RequiresClientAuthorization : True RequiresTransportSecurity : True IsDynamic : False
UserMetadata : User Meta data Id :
/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/Default-Storage-WestUS/providers/Microsoft.Rel
ay/namespaces/TestNameSpace-Relay1/WcfRelays/TestWCFRelay Name : TestWCFRelay Type :
Microsoft.Relay/WcfRelays
NOTES
Example 1 - InputObject
PS C:\\>
PS C:\\> $getWcfRelay = Get-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName TestNameSpace-Relay1 -WcfRelayName
TestWCFRelay
PS C:\\> $getWcfRelay.UserMetadata = "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can
be used to store desc
riptive data, such as list of teams and their contact information also user-defined configuration settings can be stored."
PS C:\\> Set-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -InputObject
$getWcfRelay
Example 2 - Properties
PS C:\\> Set-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -UserMetadata "User
Meta data"
Updates the specified WcfRelay 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 ... rmwcfrelay