Edit

Share via

Update-AzEventGridNamespaceTopic

  • Reference
Module:
Az.EventGrid

Asynchronously update a namespace topic with the specified parameters.

Syntax

Update-AzEventGridNamespaceTopic
      -NamespaceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -TopicName <String>
      [-EventRetentionInDay <Int32>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridNamespaceTopic
      -NamespaceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -TopicName <String>
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridNamespaceTopic
      -NamespaceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -TopicName <String>
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridNamespaceTopic
      -TopicName <String>
      -NamespaceInputObject <IEventGridIdentity>
      [-EventRetentionInDay <Int32>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridNamespaceTopic
      -InputObject <IEventGridIdentity>
      [-EventRetentionInDay <Int32>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Asynchronously update a namespace topic with the specified parameters.

Examples

Example 1: Asynchronously updates a namespace topic with the specified parameters.

Update-AzEventGridNamespaceTopic -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -TopicName azps-topic -EventRetentionInDay 1

Name       ResourceGroupName
----       -----------------
azps-topic azps_test_group_eventgrid

Asynchronously updates a namespace topic with the specified parameters.

Example 2: Asynchronously updates a namespace topic with the specified parameters.

$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Update-AzEventGridNamespaceTopic -NamespaceInputObject $namespace -TopicName azps-topic -EventRetentionInDay 1

Name       ResourceGroupName
----       -----------------
azps-topic azps_test_group_eventgrid

Asynchronously updates a namespace topic with the specified parameters.

Example 3: Asynchronously updates a namespace topic with the specified parameters.

$namespaceTopic = Get-AzEventGridNamespaceTopic -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -TopicName azps-topic
Update-AzEventGridNamespaceTopic -InputObject $namespaceTopic -EventRetentionInDay 1

Name       ResourceGroupName
----       -----------------
azps-topic azps_test_group_eventgrid

Asynchronously updates a namespace topic 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

-EventRetentionInDay

Event retention for the namespace topic expressed in days. The property default value is 1 day.Min event retention duration value is 1 day and max event retention duration value is 1 day.

Type:Int32
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

-JsonFilePath

Path of Json file supplied to the Update operation

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

-JsonString

Json string supplied to the Update operation

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

-TopicName

Name of the namespace topic.

Type:String
Position:Named
Default value:None
Required:True
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

INamespaceTopic