Set-AzEventGridTopic

Reference

Module:: Az.EventGrid

Sets the properties of an Event Grid topic.

Syntax

Set-AzEventGridTopic
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-Tag] <Hashtable>
   [-InboundIpRule] <Hashtable>
   [-IdentityType <String>]
   [-IdentityId <String[]>]
   [-PublicNetworkAccess] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzEventGridTopic
   [-ResourceId] <String>
   [-Tag] <Hashtable>
   [-InboundIpRule] <Hashtable>
   [-IdentityType <String>]
   [-IdentityId <String[]>]
   [-PublicNetworkAccess] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzEventGridTopic
   [-InputObject] <PSTopic>
   [[-Tag] <Hashtable>]
   [[-InboundIpRule] <Hashtable>]
   [-IdentityType <String>]
   [-IdentityId <String[]>]
   [[-PublicNetworkAccess] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Sets the properties of an Event Grid topic. This can be used to replace the tags of an Event Grid topic.

Examples

Example 1

Set-AzEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1 -Tag @{ Department="Finance"; Environment="Test" }

Sets the properties of the Event Grid topic `Topic1` in resource group `MyResourceGroupName` to replace the tags with the specified tags "Department" and "Environment".

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 credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityId

The list of user assigned identities

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

-IdentityType

Different identity types. Could be either of following 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

Type:	String
Accepted values:	SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InboundIpRule

Hashtable which represents list of inbound IP rules. Each rule specifies the IP Address in CIDR notation e.g., 10.0.0.0/8 along with the corresponding Action to be performed based on the match or no match of the IpMask. Possible Action values include Allow only

Type:	Hashtable
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

EventGrid Topic object.

Type:	PSTopic
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

EventGrid Topic Name.

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

-PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring InboundIpRule parameters. Allowed values are disabled and enabled.

Type:	String
Accepted values:	enabled, disabled, enabled, disabled
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name.

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

-ResourceId

EventGrid Topic ResourceID.

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

-Tag

Hashtables which represents resource Tag.

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

String

PSTopic

Hashtable

Outputs