Wait-AzureHDInsightJob
Awaits the completion or failure of an HDInsight job and displays the progress of the job.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
Wait-AzureHDInsightJob
[-Credential <PSCredential>]
[-WaitTimeoutInSeconds <Double>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Wait-AzureHDInsightJob
[-Certificate <X509Certificate2>]
[-HostedService <String>]
[-Endpoint <Uri>]
[-IgnoreSslErrors <Boolean>]
-Job <AzureHDInsightJob>
-Subscription <String>
[-WaitTimeoutInSeconds <Double>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Wait-AzureHDInsightJob
-Cluster <String>
[-Credential <PSCredential>]
-JobId <String>
[-WaitTimeoutInSeconds <Double>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Wait-AzureHDInsightJob
[-Credential <PSCredential>]
-Job <AzureHDInsightJob>
[-WaitTimeoutInSeconds <Double>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
This version of Azure PowerShell HDInsight is deprecated. These cmdlets will be removed by January 1, 2017. Please use the newer version of Azure PowerShell HDInsight.
For information about how to use the new HDInsight to create a cluster, see Create Linux-based clusters in HDInsight using Azure PowerShell (https://azure.microsoft.com/en-us/documentation/articles/hdinsight-hadoop-create-linux-clusters-azure-powershell/). For information about how to submit jobs by using Azure PowerShell and other approaches, see Submit Hadoop jobs in HDInsight (https://azure.microsoft.com/en-us/documentation/articles/hdinsight-submit-hadoop-jobs-programmatically/). For reference information about Azure PowerShell HDInsight, see Azure HDInsight Cmdlets.
The Wait-AzureHDInsightJob cmdlet awaits the completion or failure of an Azure HDInsight job and displays the progress of the job.
Examples
Example 1: Run a job and wait for it to complete
PS C:\>$SubId = (Get-AzureSubscription -Current).SubscriptionId
PS C:>\ $ClusterName = "MyCluster"
PS C:>\ $WordCountJob = New-AzureHDInsightMapReduceJobDefinition -JarFile "/Example/Apps/Hadoop-examples.jar" -ClassName "Wordcount" -Defines @{ "mapred.map.tasks" = "3" } -Arguments "/Example/Data/Gutenberg/Davinci.txt", "/Example/Output/WordCount"
PS C:>\ $WordCountJob | Start-AzureHDInsightJob -Subscription $SubId -Cluster $ClusterName
| Wait-AzureHDInsightJob -Subscription $SubId -WaitTimeoutInSeconds 3600
| Get-AzureHDInsightJobOutput -Cluster $ClusterName -Subscription $SubId -StandardError
The first command gets the current Azure subscription ID, and then stores it in the $SubId variable.
The second command gets the specified cluster, and then stores it in the $ClusterName variable.
The third command uses the New-AzureHDInsightMapReduceJobDefinition cmdlet to create a MapReduce job definition, and then stores it in the $WordCountJob variable.
The fourth command uses several cmdlets in sequence:
- It uses the pipeline operator to pass $WordCountJob to the Start-AzureHDInsightJob cmdlet to start the job.
- The job is passed to the Wait-AzureHDInsightJob cmdlet to wait 3600 seconds for the job to complete.
- If the job completes, the command uses the Get-AzureHDInsightJobOutput cmdlet to get the job output.
Parameters
-Certificate
Specifies the management certificate for an Azure subscription.
Type: | X509Certificate2 |
Aliases: | Cert |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Cluster
Specifies a cluster. This cmdlet waits for a job on the cluster that this parameter specifies.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Credential
Specifies the credentials to use for direct HTTP access to a cluster. You can specify this parameter instead of the Subscription parameter to authenticate access to a cluster.
Type: | PSCredential |
Aliases: | Cred |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Endpoint
Specifies the endpoint to use to connect to Azure. If you do not specify this parameter, this cmdlet uses the default endpoint.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostedService
Specifies the namespace of an HDInsight service. If you do not specify this parameter, the default namespace is used.
Type: | String |
Aliases: | CloudServiceName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IgnoreSslErrors
Indicates whether Secure Sockets Layer (SSL) errors are ignored.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Job
Specifies an Azure HDInsight job.
Type: | AzureHDInsightJob |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-JobId
Specifies the ID of the job to wait for.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Type: | AzureSMProfile |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Subscription
Specifies a subscription. This cmdlet waits for a job for the subscription that this parameter specifies.
Type: | String |
Aliases: | Sub |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WaitTimeoutInSeconds
Specifies the time-out, in seconds, for the wait operation. If the time-out expires before the job completes, the cmdlet ceases to run.
Type: | Double |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |