Add-AzSynapseTriggerSubscription
Subscribe the event trigger to external service events.
Syntax
Add-AzSynapseTriggerSubscription
-WorkspaceName <String>
-Name <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-AzSynapseTriggerSubscription
-WorkspaceObject <PSSynapseWorkspace>
-Name <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Add-AzSynapseTriggerSubscription
-InputObject <PSTriggerResource>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Add-AzSynapseTriggerSubscription cmdlet subscribes the event trigger to the specified external service events from the trigger defintion.
Examples
Example 1
Add-AzSynapseTriggerSubscription -WorkspaceName ContosoWorkspace -Name ContosoTriggerThis command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion.
Example 2
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Add-AzSynapseTriggerSubscription -Name ContosoTriggerThis command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline.
Example 3
$trigger = Get-AzSynapseTrigger -WorkspaceName ContosoWorkspace -Name ContosoTrigger
$trigger | Add-AzSynapseTriggerSubscriptionThis command will subscribe trigger called ContosoTrigger to the specified events from the trigger defintion through pipeline.
Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| 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 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 |
-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 |
-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 |