Edit

Share via

Update-AzEventGridPermissionBinding

  • Reference
Module:
Az.EventGrid

Update a permission binding with the specified parameters.

Syntax

Update-AzEventGridPermissionBinding
      -Name <String>
      -NamespaceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ClientGroupName <String>]
      [-Description <String>]
      [-Permission <String>]
      [-TopicSpaceName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridPermissionBinding
      -Name <String>
      -NamespaceInputObject <IEventGridIdentity>
      [-ClientGroupName <String>]
      [-Description <String>]
      [-Permission <String>]
      [-TopicSpaceName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridPermissionBinding
      -InputObject <IEventGridIdentity>
      [-ClientGroupName <String>]
      [-Description <String>]
      [-Permission <String>]
      [-TopicSpaceName <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update a permission binding with the specified parameters.

Examples

Example 1: Create a permission binding with the specified parameters.

Update-AzEventGridPermissionBinding -ResourceGroupName azps_test_group_eventgrid -NamespaceName azps-eventgridnamespace -Name azps-pb -ClientGroupName "azps-clientgroup" -Permission Publisher -TopicSpaceName "azps-topicspace"

Name    ResourceGroupName
----    -----------------
azps-pb azps_test_group_eventgrid

Create a permission binding with the specified parameters.

Example 2: Create a permission binding with the specified parameters.

$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Update-AzEventGridPermissionBinding -NamespaceInputObject $namespace -Name azps-pb -ClientGroupName "azps-clientgroup" -Permission Publisher -TopicSpaceName "azps-topicspace"

Name    ResourceGroupName
----    -----------------
azps-pb azps_test_group_eventgrid

Create a permission binding with the specified parameters.

Example 3: Create a permission binding with the specified parameters.

$permissionbinding = Get-AzEventGridPermissionBinding -ResourceGroupName azps_test_group_eventgrid -NamespaceName azps-eventgridnamespace -Name azps-pb
Update-AzEventGridPermissionBinding -InputObject $permissionbinding -ClientGroupName "azps-clientgroup" -Permission Publisher -TopicSpaceName "azps-topicspace"

Name    ResourceGroupName
----    -----------------
azps-pb azps_test_group_eventgrid

Create a permission binding 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

-ClientGroupName

The name of the client group resource that the permission is bound to.The client group needs to be a resource under the same namespace the permission binding is a part of.

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

-Description

Description for the Permission Binding 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 permission binding name.

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

-Permission

The allowed permission.

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

-TopicSpaceName

The name of the Topic Space resource that the permission is bound to.The Topic space needs to be a resource under the same namespace the permission binding is a part of.

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

IPermissionBinding