Update-AzRelayNamespace

Module:

Az.Relay

Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

Syntax

Update-AzRelayNamespace
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzRelayNamespace
      -InputObject <IRelayIdentity>
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

Examples

Example 1: Updates a Relay namespace

Update-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 -Tag @{'k'='v'}

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

This cmdlet updates a Relay namespace.

Example 2: Updates a Relay namespace by pipeline

Get-AzRelayNamespace -ResourceGroupName lucas-relay-rg -Name namespace-pwsh01 | Update-AzRelayNamespace -Tag @{'k'='v'}

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

This cmdlet updates a Relay namespace by pipeline.

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 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

-Tag

Resource tags.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

IRelayIdentity

Outputs

IRelayNamespace