Edit

Share via

Stop-AzureRmHDInsightJob

  • Reference
Module:
AzureRM.HDInsight

Stops a specified running job on a cluster.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

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

Examples

Example 1: Stop a job on the specified cluster

PS C:\># Cluster info
PS C:\> $clusterName = "your-hadoop-001"
PS C:\> $clusterCreds = Get-Credential
PS C:\> Stop-AzureRmHDInsightJob `
            -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: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

Parameters: JobId (ByValue)

Outputs

AzureHDInsightJob