Update-AzEventGridSystemTopic
Updates the properties of an Event Grid System topic.
Syntax
Update-AzEventGridSystemTopic
[-IdentityId <String[]>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzEventGridSystemTopic
-ResourceGroupName <String>
-Name <String>
[-IdentityType <String>]
[-IdentityId <String[]>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates the properties of an Event Grid System topic. Can be used to update the identity and tags of a system topic
Examples
Example 1
Update-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Name Topic1 -Tag @{ Department="Finance"; Environment="Test" }
Sets the properties of the Event Grid System topic `Topic1` in resource group `MyResourceGroupName` to replace the tags with the specified tags "Department" and "Environment".
Example 2
Update-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Name Topic1 -IdentityType "SystemAssigned"
Sets the properties of the Event Grid System topic `Topic1` in resource group `MyResourceGroupName` to change identity type to `SystemAssigned`.
Example 3
$id1 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName'
$id2 = '/subscriptions/{subscriptionId}/resourceGroups/{resourcegroup}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MSIName'
Update-AzEventGridSystemTopic -ResourceGroup MyResourceGroupName -Name Topic1 -IdentityType "UserAssigned" -IdentityId $id1,$id2
Sets the properties of the Event Grid System topic `Topic1` in resource group `MyResourceGroupName` to change identity type to `UserAssigned` with given identity ids.
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
List of user assigned Identity Ids
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IdentityType
Hashtable which represents resource Tags.
Type: | String |
Accepted values: | SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
EventGrid topic name.
Type: | String |
Aliases: | SystemTopicName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group.
Type: | String |
Aliases: | ResourceGroup |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Tag
Hashtable which represents resource Tags.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
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[]