< Back
New-AzureRmRelayHybridConnection
Post
NAME New-AzureRmRelayHybridConnection
SYNOPSIS
Creates a HybridConnection in the specified Relay namespace.
SYNTAX
New-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-InputObject <HybridConnectionAttibutes>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-RequiresClientAuthorization <Boolean>] [-UserMetadata <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmRelayHybridConnection cmdlet creates a 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 (ByPropertyName)
Accept wildcard characters? false
-Name <String>
HybridConnections Name.
Required? true
Position? 3
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
-RequiresClientAuthorization <Boolean>
true if client authorization is needed for this HybridConnections; otherwise, false
Required? false
Position? named
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
-HybridConnectionsName
System.String
-InputObject
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
-RequiresClientAuthorization
System.Boolean
-UserMetadata
System.String
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
NOTES
Example 1 - InputObject
PS C:\\> $getHybirdConnection = Get-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName
TestNameSpace-HybirdConnection -Name TestHybirdConnection1
PS C:\\> $getHybirdConnection.UserMetadata = "TestHybirdConnection2"
PS C:\\> $getHybirdConnection.RequiresClientAuthorization = $False
PS C:\\> New-AzureRmRelayHybridConnection -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-HybirdConnection -Name
TestHybirdConnection2 -InputObject $getHybirdConnection
CreatedAt : 4/26/2017 10:04:15 PM
UpdatedAt : 4/26/2017 10:04:15 PM
ListenerCount :
RequiresClientAuthorization : True
UserMetadata : User Meta data
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
Creates a new HybirdConnection `TestHybirdConnection2` in the specified Relay namespace `TestNameSpace-HybirdConnection`.
Example 2 - Properties
PS C:\\> New-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-HybirdConnection -Name TestHybirdConnection1
-RequiresClientAuthorization $True -UserMetadata "User Meta data"
CreatedAt : 4/26/2017 10:04:15 PM
UpdatedAt : 4/26/2017 10:04:15 PM
ListenerCount :
RequiresClientAuthorization : True
UserMetadata : User Meta data
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
Creates a new HybirdConnection `TestHybirdConnection1` in the specified Relay namespace `TestNameSpace-HybirdConnection`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... connection
SYNOPSIS
Creates a HybridConnection in the specified Relay namespace.
SYNTAX
New-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-InputObject <HybridConnectionAttibutes>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-AzureRmRelayHybridConnection [-ResourceGroupName] <String> [-Namespace] <String> [-Name] <String> [-DefaultProfile <IAzureContextContainer>]
[-RequiresClientAuthorization <Boolean>] [-UserMetadata <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmRelayHybridConnection cmdlet creates a 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 (ByPropertyName)
Accept wildcard characters? false
-Name <String>
HybridConnections Name.
Required? true
Position? 3
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
-RequiresClientAuthorization <Boolean>
true if client authorization is needed for this HybridConnections; otherwise, false
Required? false
Position? named
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
-HybridConnectionsName
System.String
-InputObject
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
-RequiresClientAuthorization
System.Boolean
-UserMetadata
System.String
OUTPUTS
Microsoft.Azure.Commands.Relay.Models.HybridConnectionAttibutes
NOTES
Example 1 - InputObject
PS C:\\> $getHybirdConnection = Get-AzureRmRelayHybridConnection -ResourceGroupName Default-ServiceBus-WestUS -NamespaceName
TestNameSpace-HybirdConnection -Name TestHybirdConnection1
PS C:\\> $getHybirdConnection.UserMetadata = "TestHybirdConnection2"
PS C:\\> $getHybirdConnection.RequiresClientAuthorization = $False
PS C:\\> New-AzureRmRelayHybridConnection -ResourceGroupName Default-Storage-WestUS -Namespace TestNameSpace-HybirdConnection -Name
TestHybirdConnection2 -InputObject $getHybirdConnection
CreatedAt : 4/26/2017 10:04:15 PM
UpdatedAt : 4/26/2017 10:04:15 PM
ListenerCount :
RequiresClientAuthorization : True
UserMetadata : User Meta data
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
Creates a new HybirdConnection `TestHybirdConnection2` in the specified Relay namespace `TestNameSpace-HybirdConnection`.
Example 2 - Properties
PS C:\\> New-AzureRmWcfRelay -ResourceGroupName Default-ServiceBus-WestUS -Namespace TestNameSpace-HybirdConnection -Name TestHybirdConnection1
-RequiresClientAuthorization $True -UserMetadata "User Meta data"
CreatedAt : 4/26/2017 10:04:15 PM
UpdatedAt : 4/26/2017 10:04:15 PM
ListenerCount :
RequiresClientAuthorization : True
UserMetadata : User Meta data
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
Creates a new HybirdConnection `TestHybirdConnection1` in the specified Relay namespace `TestNameSpace-HybirdConnection`.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... connection