Stop-AzHDInsightJob

  • Reference
Module:
Az.HDInsight

Stops a specified running job on a cluster.

Syntax

Stop-AzHDInsightJob
    [-ClusterName] <String>
    [-JobId] <String>
    [-HttpCredential] <PSCredential>
    [-ResourceGroupName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Stop-AzHDInsightJob cmdlet stops a specified running job on an Azure HDInsight cluster.

Examples

Example 1: Stop a job on the specified cluster

# Cluster info
$clusterName = "your-hadoop-001"
$clusterCreds = Get-Credential
Stop-AzHDInsightJob `
            -ClusterName $clusterName `
            -ClusterCredential $clusterCreds `
            -JobId $jobId

This command stops a job on the cluster named your-hadoop-001.

Parameters

-ClusterName

Specifies the name of the cluster.

Type:String
Position:0
Default value:None
Required:True
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

-HttpCredential

Specifies the cluster login (HTTP) credentials for the cluster.

Type:PSCredential
Aliases:ClusterCredential
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-JobId

Specifies the job ID of the job.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

AzureHDInsightJob