Set-AzureRmWcfRelay
Updates the description of a WcfRelay in the specified Relay namespace.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Set-AzureRmWcfRelay
[-ResourceGroupName] <String>
[-Namespace] <String>
[-Name] <String>
[-InputObject <WcfRelayAttributes>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzureRmWcfRelay
[-ResourceGroupName] <String>
[-Namespace] <String>
[-Name] <String>
[-UserMetadata <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<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
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
PS C:\> Set-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-Relay1 -Name TestWCFRelay1 -UserMetadata "User Meta data"
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
Updates the specified WcfRelay with a new description in the specified namespace. This example updates the UserMetadata property with new value.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
WcfRelay object.
Type: | Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
WcfRelay Name.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Namespace
Namespace Name.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UserMetadata
Gets or sets usermetadata is a placeholder to store user-defined string data for the WcfRelay 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 |
Required: | False |
Accept pipeline input: | True |
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: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes
Outputs
Microsoft.Azure.Commands.Relay.Models.PSWcfRelayAttributes