Edit

Share via

Update-AzEventGridPartnerTopic

  • Reference
Module:
Az.EventGrid

Asynchronously creates a new partner topic with the specified parameters.

Syntax

Update-AzEventGridPartnerTopic
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ActivationState <String>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-EventTypeInfoInlineEventType <Hashtable>]
      [-EventTypeInfoKind <String>]
      [-ExpirationTimeIfNotActivatedUtc <DateTime>]
      [-IdentityPrincipalId <String>]
      [-IdentityTenantId <String>]
      [-Location <String>]
      [-MessageForActivation <String>]
      [-PartnerRegistrationImmutableId <String>]
      [-PartnerTopicFriendlyDescription <String>]
      [-Source <String>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridPartnerTopic
      -InputObject <IEventGridIdentity>
      [-ActivationState <String>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-EventTypeInfoInlineEventType <Hashtable>]
      [-EventTypeInfoKind <String>]
      [-ExpirationTimeIfNotActivatedUtc <DateTime>]
      [-IdentityPrincipalId <String>]
      [-IdentityTenantId <String>]
      [-Location <String>]
      [-MessageForActivation <String>]
      [-PartnerRegistrationImmutableId <String>]
      [-PartnerTopicFriendlyDescription <String>]
      [-Source <String>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Asynchronously creates a new partner topic with the specified parameters.

Examples

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

Update-AzEventGridPartnerTopic -Name default -ResourceGroupName azps_test_group_eventgrid -UserAssignedIdentity "/subscriptions/{subId}/resourcegroups/azps_test_group_eventgrid/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami"

Location Name    ResourceGroupName
-------- ----    -----------------
eastus   default azps_test_group_eventgrid

Asynchronously updates a partner topic with the specified parameters.

Parameters

-ActivationState

Activation state of the partner topic.

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

-EnableSystemAssignedIdentity

Decides if enable a system assigned identity for the resource.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventTypeInfoInlineEventType

A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event.An example of a valid inline event name is "Contoso.OrderCreated".The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.

Type:Hashtable
Aliases:InlineEvent
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventTypeInfoKind

The kind of event type used.

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

-ExpirationTimeIfNotActivatedUtc

Expiration time of the partner topic. If this timer expires while the partner topic is still never activated,the partner topic and corresponding event channel are deleted.

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

-IdentityPrincipalId

The principal ID of resource identity.

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

-IdentityTenantId

The tenant ID of 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

-Location

Location of the resource.

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

-MessageForActivation

Context or helpful message that can be used during the approval process by the subscriber.

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

-Name

Name of the partner topic.

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

-PartnerRegistrationImmutableId

The immutableId of the corresponding partner registration.

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

-PartnerTopicFriendlyDescription

Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic.This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.

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

-PassThru

Returns true when the command succeeds

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

-Source

Source associated with this partner topic. This represents a unique partner resource.

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

-Tag

Tags of the resource.

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

-UserAssignedIdentity

The array of user assigned identities associated with the resource. The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'

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

IPartnerTopic