< Back
Watch-AzureDatabricksJob
Post
NAME Watch-AzureDatabricksJob
SYNOPSIS
Monitors a running Azure Databricks job for completion.
SYNTAX
Watch-AzureDatabricksJob [-Connection] <Object> [-JobID] <Int32> [-RunID] <Int32> [[-PollIntervalSeconds] <Int32>]
[<CommonParameters>]
DESCRIPTION
This function will remotely monitor a running Azure Databricks job, waiting until a job finishes. A "finished" job
can be successful or not, it's just
defined as a job that is no longer running. This function will return verbose messaging with the current status of
a running job as well. Finally, this function
has some built in error handling for some common Azure Databricks API errors.
PARAMETERS
-Connection <Object>
An object that represents an Azure Databricks API connection where you want to test your paths.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JobID <Int32>
The job ID you want to monitor.
Required? true
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RunID <Int32>
The run ID you want to monitor. The run ID in question should be an in-process run.
Required? true
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PollIntervalSeconds <Int32>
How often the API should be queried for the status of a job run. Defaults to every 60 seconds. As of this
writing, best practice from the Azure Databricks
team is NOT have this query more than once a minute, as it could potentially overload the API. This supposedly
will be addressed soon, according to support.
Required? false
Position? 4
Default value 60
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Author: Drew Furgiuele (@pittfurg), http://www.port1433.com
Website: https://www.igs.com
Copyright: (c) 2019 by IGS, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Watch-AzureDatabricksJob -Connection $Connection -JobID 1 -RunID 100
Wait for job ID 1, run ID 100 to finish while monitoring the status every 60 seconds. Returns an object that
represents the job outcome.
RELATED LINKS
SYNOPSIS
Monitors a running Azure Databricks job for completion.
SYNTAX
Watch-AzureDatabricksJob [-Connection] <Object> [-JobID] <Int32> [-RunID] <Int32> [[-PollIntervalSeconds] <Int32>]
[<CommonParameters>]
DESCRIPTION
This function will remotely monitor a running Azure Databricks job, waiting until a job finishes. A "finished" job
can be successful or not, it's just
defined as a job that is no longer running. This function will return verbose messaging with the current status of
a running job as well. Finally, this function
has some built in error handling for some common Azure Databricks API errors.
PARAMETERS
-Connection <Object>
An object that represents an Azure Databricks API connection where you want to test your paths.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JobID <Int32>
The job ID you want to monitor.
Required? true
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RunID <Int32>
The run ID you want to monitor. The run ID in question should be an in-process run.
Required? true
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PollIntervalSeconds <Int32>
How often the API should be queried for the status of a job run. Defaults to every 60 seconds. As of this
writing, best practice from the Azure Databricks
team is NOT have this query more than once a minute, as it could potentially overload the API. This supposedly
will be addressed soon, according to support.
Required? false
Position? 4
Default value 60
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Author: Drew Furgiuele (@pittfurg), http://www.port1433.com
Website: https://www.igs.com
Copyright: (c) 2019 by IGS, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Watch-AzureDatabricksJob -Connection $Connection -JobID 1 -RunID 100
Wait for job ID 1, run ID 100 to finish while monitoring the status every 60 seconds. Returns an object that
represents the job outcome.
RELATED LINKS