Get-AzRelayHybridConnection

Reference

Module:: Az.Relay

Returns the description for the specified hybrid connection.

Syntax

Get-AzRelayHybridConnection
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzRelayHybridConnection
   -Name <String>
   -Namespace <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzRelayHybridConnection
   -InputObject <IRelayIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns the description for the specified hybrid connection.

Examples

Example 1: List all Hybrid Connections within the Relay namespace

Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01

Location Name          ResourceGroupName
-------- ----          -----------------
eastus   connection-01 lucas-relay-rg

This cmdlet lists all Hybrid Connections within the Relay namespace.

Example 2: Gets a HybridConnection within the Relay namespace

Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name connection-01 | Format-List

CreatedAt                    : 12/20/2022 6:29:13 AM
Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microso
                               ft.Relay/namespaces/namespace-pwsh01/hybridconnections/connection-01
ListenerCount                : 0
Location                     : eastus
Name                         : connection-01
RequiresClientAuthorization  : True
ResourceGroupName            : lucas-relay-rg
SystemDataCreatedAt          : 
SystemDataCreatedBy          : 
SystemDataCreatedByType      : 
SystemDataLastModifiedAt     : 
SystemDataLastModifiedBy     : 
SystemDataLastModifiedByType : 
Type                         : Microsoft.Relay/namespaces/hybridconnections
UpdatedAt                    : 12/20/2022 6:29:40 AM
UserMetadata                 :

This cmdlet gets a HybridConnection within the Relay namespace.

Example 3: Gets a HybridConnection within the Relay namespace by pipeline

Get-AzRelayHybridConnection -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 | Get-AzRelayHybridConnection

Location Name          ResourceGroupName
-------- ----          -----------------
eastus   connection-01 lucas-relay-rg

This command gets a HybridConnection within the Relay namespace by pipeline.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IRelayIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The hybrid connection name.

Type:	String
Aliases:	HybridConnectionName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Namespace

The namespace name

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Name of the Resource group within the Azure subscription.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IRelayIdentity

Outputs

IHybridConnection

Share via