Update-AzEventGridNamespace
Asynchronously update a new namespace with the specified parameters.
Syntax
UpdateExpanded (Default)
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>]
UpdateViaIdentityExpanded
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 update 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
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ClientAuthenticationAlternativeAuthenticationNameSource
Alternative authentication name sources related to client authentication settings for namespace resource.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableSystemAssignedIdentity
Determines whether to enable a system-assigned identity for the resource.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IdentityPrincipalId
The principal ID of resource identity.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IdentityTenantId
The tenant ID of resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: IInboundIPRule [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
Location of the resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MinimumTlsVersionAllowed
Minimum TLS version of the publisher allowed to publish to this namespace.
Only TLS version 1.2 is supported.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the namespace.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: NamespaceName
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PrivateEndpointConnection
.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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" />
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group within the user's subscription.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ResourceGroup
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RoutingEnrichmentDynamic
.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RoutingEnrichmentStatic
.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RoutingIdentityInfoType
.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RoutingIdentityInfoUserAssignedIdentity
.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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 and max allowed capacity is 20.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuName
The name of the SKU.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Subscription credentials that uniquely identify a Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Tags of the resource.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TopicSpaceConfigurationState
Indicate if Topic Spaces Configuration is enabled for the namespace.
Default is Disabled.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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}.'
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False Aliases: IdentityId
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
