New-AzEventGridChannel
Creates a new Event Grid channel.
Syntax
New-AzEventGridChannel
[-ResourceGroupName] <String>
[-PartnerNamespaceName] <String>
[-Name] <String>
[-ChannelType] <String>
[-PartnerTopicSource <String>]
[-MessageForActivation <String>]
[-PartnerTopicName <String>]
[-EventTypeKind <String>]
[-InlineEvent <Hashtable>]
[-ExpirationTimeIfNotActivatedUtc <DateTime>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Creates a new Event Grid channel based in the provided channel type.
Examples
Example 1
New-AzEventGridChannel -ResourceGroupName MyResourceGroupName -PartnerNamespaceName PartnerNamespace1 -Name Channel1 -ChannelType PartnerTopic -PartnerTopicSource PartnerTopicSource1 -PartnerTopicName PartnerTopic1
Creates an Event Grid channel `Channel` under the partner namespace `PartnerNamespace` under the resource group `MyResourceGroupName`. The channel will be of type PartnerTopic and the partner topic `PartnerTopic1` will be created with the specified source.
Parameters
-ChannelType
The type of the event channel which represents the direction flow of events. Possible values include: 'PartnerTopic'
Type: | String |
Accepted values: | PartnerTopic |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 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 |
-EventTypeKind
The kind of event type used. Possible values include: 'Inline'
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InlineEvent
Hashtable representing information on inline events. The inline event keys are of type string which represents the name of the event.The inline event values are Hashtables containing the optional keys description, displayName, documentationUrl, and dataSchemaUrl which define the information about the inline event.
Type: | Hashtable |
Accepted values: | Inline |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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: | True |
Accept wildcard characters: | False |
-Name
The name of the Event Grid channel.
Type: | String |
Aliases: | ChannelName |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PartnerNamespaceName
Event Grid partner namespace name.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PartnerTopicName
Event Grid partner topic name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PartnerTopicSource
Source information provided by the publisher to determine the scope or context from which the events are originating.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group.
Type: | String |
Aliases: | ResourceGroup |
Position: | 0 |
Default value: | None |
Required: | True |
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
Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Outputs
Azure PowerShell
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for