Get-AzSynapseTriggerSubscriptionStatus

  • Reference
Module:
Az.Synapse

Get the status of the subscription for the event trigger to the specified external service events.

Syntax

Get-AzSynapseTriggerSubscriptionStatus
   -WorkspaceName <String>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSynapseTriggerSubscriptionStatus
   -WorkspaceObject <PSSynapseWorkspace>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSynapseTriggerSubscriptionStatus
   -InputObject <PSTriggerResource>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseTriggerSubscriptionStatus cmdlet gets the status of the subscription for the event trigger to the specified external service events. The trigger can't be started until the returned status is "Enabled".

Examples

Example 1

Get-AzSynapseTriggerSubscriptionStatus -WorkspaceName ContosoWorkspace -Name ContosoTrigger

This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events.

Example 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseTriggerSubscriptionStatus -Name ContosoTrigger

This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events through pipeline.

Example 3

$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger
$trigger | Get-AzSynapseTriggerSubscriptionStatus

This command will get the status of the subscribtion for trigger called ContosoTrigger to the external service events through pipeline.

Parameters

-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

-InputObject

The trigger object.

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

-Name

The trigger name.

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

-WorkspaceName

Name of Synapse workspace.

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

-WorkspaceObject

workspace input object, usually passed through the pipeline.

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

Inputs

PSSynapseWorkspace

PSTriggerResource

Outputs

PSTriggerSubscriptionOperationStatus