Modifier

Partager via

Update-AzEventGridNamespace

  • Reference
Module:
Az.EventGrid

Asynchronously creates or updates a new namespace with the specified parameters.

Syntax

Update-AzEventGridNamespace
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ClientAuthenticationAlternativeAuthenticationNameSource <String[]>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-IdentityPrincipalId <String>]
      [-IdentityTenantId <String>]
      [-InboundIPRule <IInboundIPRule[]>]
      [-IsZoneRedundant]
      [-Location <String>]
      [-MinimumTlsVersionAllowed <String>]
      [-PrivateEndpointConnection <IPrivateEndpointConnection[]>]
      [-PublicNetworkAccess <String>]
      [-RoutingEnrichmentDynamic <IDynamicRoutingEnrichment[]>]
      [-RoutingEnrichmentStatic <IStaticRoutingEnrichment[]>]
      [-RoutingIdentityInfoType <String>]
      [-RoutingIdentityInfoUserAssignedIdentity <String>]
      [-SkuCapacity <Int32>]
      [-SkuName <String>]
      [-Tag <Hashtable>]
      [-TopicSpaceConfigurationMaximumClientSessionsPerAuthenticationName <Int32>]
      [-TopicSpaceConfigurationMaximumSessionExpiryInHour <Int32>]
      [-TopicSpaceConfigurationRouteTopicResourceId <String>]
      [-TopicSpaceConfigurationState <String>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridNamespace
      -InputObject <IEventGridIdentity>
      [-ClientAuthenticationAlternativeAuthenticationNameSource <String[]>]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-IdentityPrincipalId <String>]
      [-IdentityTenantId <String>]
      [-InboundIPRule <IInboundIPRule[]>]
      [-IsZoneRedundant]
      [-Location <String>]
      [-MinimumTlsVersionAllowed <String>]
      [-PrivateEndpointConnection <IPrivateEndpointConnection[]>]
      [-PublicNetworkAccess <String>]
      [-RoutingEnrichmentDynamic <IDynamicRoutingEnrichment[]>]
      [-RoutingEnrichmentStatic <IStaticRoutingEnrichment[]>]
      [-RoutingIdentityInfoType <String>]
      [-RoutingIdentityInfoUserAssignedIdentity <String>]
      [-SkuCapacity <Int32>]
      [-SkuName <String>]
      [-Tag <Hashtable>]
      [-TopicSpaceConfigurationMaximumClientSessionsPerAuthenticationName <Int32>]
      [-TopicSpaceConfigurationMaximumSessionExpiryInHour <Int32>]
      [-TopicSpaceConfigurationRouteTopicResourceId <String>]
      [-TopicSpaceConfigurationState <String>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Asynchronously creates or updates a new namespace with the specified parameters.

Examples

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

Update-AzEventGridNamespace -Name azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -TopicSpaceConfigurationState Enabled -Tag @{"abc"="123"}

Location Name                    ResourceGroupName
-------- ----                    -----------------
eastus   azps-eventgridnamespace azps_test_group_eventgrid

Asynchronously updates a namespace with the specified parameters.

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

$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Update-AzEventGridNamespace -InputObject $namespace -TopicSpaceConfigurationState Enabled -Tag @{"abc"="123"}

Location Name                    ResourceGroupName
-------- ----                    -----------------
eastus   azps-eventgridnamespace azps_test_group_eventgrid

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

-ClientAuthenticationAlternativeAuthenticationNameSource

Alternative authentication name sources related to client authentication settings for namespace resource.

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

-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

-InboundIPRule

This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

Type:IInboundIPRule[]
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

-IsZoneRedundant

Allows the user to specify if the service is zone-redundant. This is a required property and user needs to specify this value explicitly.Once specified, this property cannot be updated.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-MinimumTlsVersionAllowed

Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported.

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

-Name

Name of the namespace.

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

-PrivateEndpointConnection

.

Type:IPrivateEndpointConnection[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />

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

-RoutingEnrichmentDynamic

.

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

-RoutingEnrichmentStatic

.

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

-RoutingIdentityInfoType

.

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

-RoutingIdentityInfoUserAssignedIdentity

.

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

-SkuCapacity

Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 andmax allowed capacity is 20.

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

-SkuName

The name of the SKU.

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

-TopicSpaceConfigurationMaximumClientSessionsPerAuthenticationName

The maximum number of sessions per authentication name. The property default value is 1.Min allowed value is 1 and max allowed value is 100.

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

-TopicSpaceConfigurationMaximumSessionExpiryInHour

The maximum session expiry in hours. The property default value is 1 hour.Min allowed value is 1 hour and max allowed value is 8 hours.

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

-TopicSpaceConfigurationRouteTopicResourceId

Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace.This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'.This topic should reside in the same region where namespace is located.

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

-TopicSpaceConfigurationState

Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled.

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

INamespace