Get-AzRelayNamespace

Module:

Az.Relay

Returns the description for the specified namespace.

Syntax

Get-AzRelayNamespace
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

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

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

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

Description

Returns the description for the specified namespace.

Examples

Example 1: List all Relay namespaces within the resource group

Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg

Name             ResourceGroupName Location        Status SkuName  ServiceBusEndpoint
----             ----------------- --------        ------ -------  ------------------
lucasrelay       lucas-relay-rg    West Central US Active Standard https://lucasrelay.servicebus.windows.net:443/
namespace-pwsh01 lucas-relay-rg    East US         Active Standard https://namespace-pwsh01.servicebus.windows.net:443/

The cmdlet lists all Relay namespaces within the resource group.

Example 2: Gets a description for the specified Relay namespace within the resource group

Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 | Format-List

CreatedAt                    : 12/20/2022 3:20:46 AM
Id                           : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microso
                               ft.Relay/namespaces/namespace-pwsh01
Location                     : East US
MetricId                     : 9e223dbe-3399-4e19-88eb-0975f02ac87f:namespace-pwsh01
Name                         : namespace-pwsh01
PrivateEndpointConnection    : 
ProvisioningState            : Succeeded
PublicNetworkAccess          : 
ResourceGroupName            : lucas-relay-rg
ServiceBusEndpoint           : https://namespace-pwsh01.servicebus.windows.net:443/
SkuName                      : Standard
SkuTier                      : Standard
Status                       : Active
SystemDataCreatedAt          : 
SystemDataCreatedBy          : 
SystemDataCreatedByType      : 
SystemDataLastModifiedAt     : 
SystemDataLastModifiedBy     : 
SystemDataLastModifiedByType : 
Tag                          : {
                               }
Type                         : Microsoft.Relay/Namespaces
UpdatedAt                    : 12/20/2022 3:21:28 AM

The cmdlet gets a description for the specified Relay namespace within the resource group.

Example 3: Gets a description for the specified Relay namespace by pipeline

$namespaces = Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg 
$namespaces[0] | Get-AzRelayNamespace

Name       ResourceGroupName Location        Status SkuName  ServiceBusEndpoint
----       ----------------- --------        ------ -------  ------------------
lucasrelay lucas-relay-rg    West Central US Active Standard https://lucasrelay.servicebus.windows.net:443/

The cmdlet gets a description for the specified 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 namespace name

Type:	String
Aliases:	NamespaceName
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

IRelayNamespace