Get-AzSynapseTriggerSubscriptionStatus
Get the status of the subscription for the event trigger to the specified external service events.
Syntax
GetByName (Default)
Get-AzSynapseTriggerSubscriptionStatus
-WorkspaceName <String>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByObject
Get-AzSynapseTriggerSubscriptionStatus
-WorkspaceObject <PSSynapseWorkspace>
-Name <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByInputObject
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 subscription 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 subscription 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 subscription for trigger called ContosoTrigger to the external service events through pipeline.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, 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 |
-InputObject
The trigger object.
Parameter properties
| Type: | PSTriggerResource |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByInputObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The trigger name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | TriggerName |
Parameter sets
GetByName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
GetByObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WorkspaceName
Name of Synapse workspace.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Parameter properties
| Type: | PSSynapseWorkspace |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| 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.
