Edit

Share via

Update-AzEventGridTopicSpace

  • Reference
Module:
Az.EventGrid

update a topic space with the specified parameters.

Syntax

Update-AzEventGridTopicSpace
      -Name <String>
      -NamespaceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Description <String>]
      [-TopicTemplate <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridTopicSpace
      -Name <String>
      -NamespaceInputObject <IEventGridIdentity>
      [-Description <String>]
      [-TopicTemplate <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridTopicSpace
      -InputObject <IEventGridIdentity>
      [-Description <String>]
      [-TopicTemplate <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

update a topic space with the specified parameters.

Examples

Example 1: Create a topic space with the specified parameters.

Update-AzEventGridTopicSpace -Name azps-topicspace -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -TopicTemplate "filter1"

Name            ResourceGroupName
----            -----------------
azps-topicspace azps_test_group_eventgrid

Create a topic space with the specified parameters.

Example 2: Create a topic space with the specified parameters.

$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Update-AzEventGridTopicSpace -Name azps-topicspace -NamespaceInputObject $namespace -TopicTemplate "filter1"

Name            ResourceGroupName
----            -----------------
azps-topicspace azps_test_group_eventgrid

Create a topic space with the specified parameters.

Example 3: Create a topic space with the specified parameters.

$topicspace = Get-AzEventGridTopicSpace -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-topicspace
Update-AzEventGridTopicSpace -InputObject $topicspace -TopicTemplate "filter1"

Name            ResourceGroupName
----            -----------------
azps-topicspace azps_test_group_eventgrid

Create a topic space with the specified parameters.

Parameters

-AsJob

Run the command as a job

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

-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

-Description

Description for the Topic Space resource.

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

-InputObject

Identity Parameter

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

-Name

The topic space name.

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

-NamespaceInputObject

Identity Parameter

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

-NamespaceName

Name of the namespace.

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

-NoWait

Run the command asynchronously

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

-ResourceGroupName

The name of the resource group within the user's subscription.

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

-SubscriptionId

Subscription credentials that uniquely identify a 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

-TopicTemplate

The topic filters in the topic space.Example: "topicTemplates": [ "devices/foo/bar", "devices/topic1/+", "devices/${principal.name}/${principal.attributes.keyName}" ].

Type:String[]
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

IEventGridIdentity

Outputs

ITopicSpace