< Back
Get-AzureDatabricksJobRun
Post
NAME Get-AzureDatabricksJobRun
SYNOPSIS
Returns an object representing the status or outcome(s) of a single job on an Azure Databricks instance.
SYNTAX
Get-AzureDatabricksJobRun [-Connection] <Object> [[-RunID] <Int32>] [[-RunType] <String>] [<CommonParameters>]
DESCRIPTION
Returns an object representing the status or outcome of all or a single job run(s) on an Azure Databricks
instance. You can provide a RunID to filter for a specific job,
and the function also supports filters for running or completed jobs.
PARAMETERS
-Connection <Object>
An object that represents an Azure Databricks API connection where you want to get a list of job runs from.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RunID <Int32>
RunID of a given run ID to return, otherwise the object returns all runs for every defined job.
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RunType <String>
Filter for Active or Completed jobs.
Required? false
Position? 3
Default value
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:\\>Get-AzureDatabricksJobRun -Connection $Connection
Returns an array of objects detailing all Job Runs on a the Azure Databricks connection defined in $Connection
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-AzureDatabricksJobRun -Connection $Connection -RunID 1
Returns an array of objects detailing Job Run number 1 on a the Azure Databricks connection defined in $Connection
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-AzureDatabricksJobRun -Connection $Connection -Active
Returns an array of objects detailing all currently running Job Runs on a the Azure Databricks connection defined
in $Connection
RELATED LINKS
SYNOPSIS
Returns an object representing the status or outcome(s) of a single job on an Azure Databricks instance.
SYNTAX
Get-AzureDatabricksJobRun [-Connection] <Object> [[-RunID] <Int32>] [[-RunType] <String>] [<CommonParameters>]
DESCRIPTION
Returns an object representing the status or outcome of all or a single job run(s) on an Azure Databricks
instance. You can provide a RunID to filter for a specific job,
and the function also supports filters for running or completed jobs.
PARAMETERS
-Connection <Object>
An object that represents an Azure Databricks API connection where you want to get a list of job runs from.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RunID <Int32>
RunID of a given run ID to return, otherwise the object returns all runs for every defined job.
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RunType <String>
Filter for Active or Completed jobs.
Required? false
Position? 3
Default value
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:\\>Get-AzureDatabricksJobRun -Connection $Connection
Returns an array of objects detailing all Job Runs on a the Azure Databricks connection defined in $Connection
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-AzureDatabricksJobRun -Connection $Connection -RunID 1
Returns an array of objects detailing Job Run number 1 on a the Azure Databricks connection defined in $Connection
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-AzureDatabricksJobRun -Connection $Connection -Active
Returns an array of objects detailing all currently running Job Runs on a the Azure Databricks connection defined
in $Connection
RELATED LINKS