Edit

Share via


New-AzActionGroupEventHubReceiverObject

Create an in-memory object for EventHubReceiver.

Syntax

Default (Default)

New-AzActionGroupEventHubReceiverObject
    -EventHubName <String>
    -EventHubNameSpace <String>
    -Name <String>
    -SubscriptionId <String>
    [-TenantId <String>]
    [-UseCommonAlertSchema <Boolean>]
    [<CommonParameters>]

Description

Create an in-memory object for EventHubReceiver.

Examples

Example 1: create action group event hub receiver

New-AzActionGroupEventHubReceiverObject -EventHubName "testEventHub" -EventHubNameSpace "testEventHubNameSpace" -Name "sample eventhub" -SubscriptionId "187f412d-1758-44d9-b052-169e2564721d" -TenantId "68a4459a-ccb8-493c-b9da-dd30457d1b84"
EventHubName         : testEventHub
EventHubNameSpace    : testEventHubNameSpace
Name                 : sample eventhub
SubscriptionId       : 187f412d-1758-44d9-b052-169e2564721d
TenantId             : 68a4459a-ccb8-493c-b9da-dd30457d1b84
UseCommonAlertSchema :

This command creates action group event hub receiver object.

Example 2: create another action group event hub receiver

New-AzActionGroupEventHubReceiverObject -EventHubName "testEventHub" -EventHubNameSpace "actiongrouptest" -Name "sample eventhub" -SubscriptionId 9e223dbe-3399-4e19-88eb-0975f02ac87f
EventHubName         : testEventHub
EventHubNameSpace    : actiongrouptest
Name                 : sample eventhub
SubscriptionId       : 9e223dbe-3399-4e19-88eb-0975f02ac87f
TenantId             :
UseCommonAlertSchema :

This command creates another action group event hub receiver object.

Parameters

-EventHubName

The name of the specific Event Hub queue.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EventHubNameSpace

The Event Hub namespace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the Event hub receiver. Names must be unique across all receivers within an action group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The Id for the subscription containing this event hub.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TenantId

The tenant Id for the subscription containing this event hub.

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

-UseCommonAlertSchema

Indicates whether to use common alert schema.

Parameter properties

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

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

EventHubReceiver