Set-​Azure​Rm​Wcf​Relay

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

Syntax

Set-AzureRmWcfRelay
   [-RequiresClientAuthorization <Boolean>]
   [-UserMetadata <String>]
   [-Confirm]
   [-WhatIf]
   -Name <String>
   -Namespace <String>
   -ResourceGroupName <String>
   [<CommonParameters>]
Set-AzureRmWcfRelay
   [-Confirm]
   [-WhatIf]
   [-InputObject <WcfRelayAttributes>]
   -Name <String>
   -Namespace <String>
   -ResourceGroupName <String>
   [<CommonParameters>]

Description

The Set-AzureRmWcfRelay cmdlet updates the description for the WcfRelay in the specified Relay namespace.

Examples

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.

Required Parameters

-Name

WcfRelay 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:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

WcfRelay object.

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

true if client authorization is needed for this relay; otherwise, false

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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: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.WcfRelayAttributes

Inputs

-WcfRelayType

System.String

Inputs

-UserMetadata

System.String

Outputs

Microsoft.Azure.Commands.Relay.Models.WcfRelayAttributes

Outputs

Example 1 - InputObject

Outputs

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

Outputs

Example 2 - Properties

Outputs

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