New-AzHDInsightHiveJobDefinition
Creates a Hive job object.
Syntax
Default (Default)
New-AzHDInsightHiveJobDefinition
[-Arguments <String[]>]
[-Files <String[]>]
[-StatusFolder <String>]
[-Defines <Hashtable>]
[-File <String>]
[-JobName <String>]
[-Query <String>]
[-RunAsFileJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The New-AzHDInsightHiveJobDefinition cmdlet defines a Hive job object for use with an Azure HDInsight cluster.
Examples
Example 1: Create a Hive job definition
# Cluster info
$clusterName = "your-hadoop-001"
$clusterCreds = Get-Credential
# Hive job details
$statusFolder = "<status folder>"
$query = "SHOW TABLES"
New-AzHDInsightHiveJobDefinition -StatusFolder $statusFolder `
-Query $query `
| Start-AzHDInsightJob `
-ClusterName $clusterName `
-ClusterCredential $clusterCreds
This command creates a Hive job definition.
Parameters
-Arguments
Specifies an array of arguments for the job.
The arguments are passed as command-line arguments to each task.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Defines
Specifies Hadoop configuration values to set for when the job runs.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-File
Specifies the path to a file that contains the query to run.
The file must be available on the storage account associated with the cluster.
You can use this parameter instead of the Query parameter.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Files
Specifies a collection of files that are associated with a Hive job.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JobName
Specifies the name of the job.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Query
Specifies the Hive query.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RunAsFileJob
Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query.
This cmdlet submits the job that references this file as a script to run.
You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StatusFolder
Specifies the location of the folder that contains standard outputs and error outputs for a job.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
None
Outputs
