Microsoft.Azure.Commands.HDInsight.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmHDInsightClusterIdentity</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmHDInsightClusterIdentity</command:noun> <maml:description><maml:para>Adds a cluster identity to a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmHDInsightClusterIdentity cmdlet adds a cluster identity to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmHDInsightClusterIdentity</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>CertificateFileContents</maml:name> <maml:Description><maml:para>Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Add-AzureRmHDInsightClusterIdentity</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>CertificateFilePath</maml:name> <maml:Description><maml:para>Specifies the file path to the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>CertificateFileContents</maml:name> <maml:Description><maml:para>Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>CertificateFilePath</maml:name> <maml:Description><maml:para>Specifies the file path to the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add Cluster Identity info to the cluster configuration object</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\> $storageContainer = "container001" # Cluster configuration info PS C:\> $location = "East US 2" PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location # Cluster Identity values PS C:\> $tenantId = (Get-AzureRmContext).Tenant.TenantId PS C:\> $objectId = "<Azure AD Service Principal Object ID>" PS C:\> $certificateFilePath = "<Path to Azure AD Service Principal Certificate>" PS C:\> $certificatePassword = "<Password for Azure AD Service Principal Certificate>" # Create the cluster PS C:\> New-AzureRmHDInsightClusterConfig ` | Add-AzureRmHDInsightClusterIdentity ` -AadTenantId $tenantId ` -ObjectId $objectId ` -CertificateFilePath $certificateFilePath ` -CertificatePassword $certificatePassword ` | New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageAccountContainer</dev:code> <dev:remarks><maml:para>This command adds Cluster Identity info to the cluster named your-hadoop-001, allowing the cluster to access Azure Data Lake Store. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightClusterConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmHDInsightComponentVersion</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmHDInsightComponentVersion</command:noun> <maml:description><maml:para>Adds a version for a service running in a cluster to a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmHDInsightComponentVersion cmdlet adds a version for a service running in a cluster to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmHDInsightComponentVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ComponentName</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ComponentVersion</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ComponentName</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ComponentVersion</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- Example 1: Add a version for Spark to the cluster configuration object. --------------------------</maml:title> <dev:code>PS C:\> # Primary storage account info $storageAccountResourceGroupName = "Group" $storageAccountName = "yourstorageacct001" $storageAccountKey = Get-AzureStorageAccountKey ` -ResourceGroupName $storageAccountResourceGroupName ` -Name $storageAccountName | %{ $_.Key1 } $storageContainer = "container001" # Cluster configuration info $location = "East US 2" $clusterResourceGroupName = "Group" $clusterName = "your-spark-001" $clusterCreds = Get-Credential $sshClusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location # Create the cluster New-AzureRmHDInsightClusterConfig ` | Add-AzureRmHDInsightComponentVersion ` -ComponentName "Spark" ` -ComponentVersion "2.0" ` | New-AzureRmHDInsightCluster ` -ClusterType Spark ` -OSType Linux ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageContainer ` -SshCredential $sshCredentials ` -Version "3.5"</dev:code> <dev:remarks><maml:para>This command adds the version of Spark to the HDInsight cluster named 'your-spark-001'. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmHDInsightConfigValues</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmHDInsightConfigValues</command:noun> <maml:description><maml:para>Adds a Hadoop configuration value customization and/or a Hive shared library customization to a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmHDInsightConfigValues cmdlet adds a Hadoop configuration value customization, such as core-site.xml or hive-site.xml, and/or a Hive shared library customization to the HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmHDInsightConfigValues</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Core</maml:name> <maml:Description><maml:para>Specifies the Core Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HBaseEnv</maml:name> <maml:Description><maml:para>Specifies the HBase Env configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HBaseSite</maml:name> <maml:Description><maml:para>Specifies the HBase Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Hdfs</maml:name> <maml:Description><maml:para>Specifies the HDFS configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveEnv</maml:name> <maml:Description><maml:para>Specifies the Hive Env configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveSite</maml:name> <maml:Description><maml:para>Specifies the Hive Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MapRed</maml:name> <maml:Description><maml:para>Specifies the MapRed Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieEnv</maml:name> <maml:Description><maml:para>Specifies the Oozie Env configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieSite</maml:name> <maml:Description><maml:para>Specifies the Oozie Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RServer</maml:name> <maml:Description><maml:para>Specifies the RServer configurations. Valid only for RServer clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Storm</maml:name> <maml:Description><maml:para>Specifies the Storm Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Tez</maml:name> <maml:Description><maml:para>Specifies the Tez Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WebHCat</maml:name> <maml:Description><maml:para>Specifies the WebHCat Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Yarn</maml:name> <maml:Description><maml:para>Specifies the YARN Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Core</maml:name> <maml:Description><maml:para>Specifies the Core Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HBaseEnv</maml:name> <maml:Description><maml:para>Specifies the HBase Env configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HBaseSite</maml:name> <maml:Description><maml:para>Specifies the HBase Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Hdfs</maml:name> <maml:Description><maml:para>Specifies the HDFS configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveEnv</maml:name> <maml:Description><maml:para>Specifies the Hive Env configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveSite</maml:name> <maml:Description><maml:para>Specifies the Hive Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>MapRed</maml:name> <maml:Description><maml:para>Specifies the MapRed Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieEnv</maml:name> <maml:Description><maml:para>Specifies the Oozie Env configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieSite</maml:name> <maml:Description><maml:para>Specifies the Oozie Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RServer</maml:name> <maml:Description><maml:para>Specifies the RServer configurations. Valid only for RServer clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Storm</maml:name> <maml:Description><maml:para>Specifies the Storm Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Tez</maml:name> <maml:Description><maml:para>Specifies the Tez Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WebHCat</maml:name> <maml:Description><maml:para>Specifies the WebHCat Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Yarn</maml:name> <maml:Description><maml:para>Specifies the YARN Site configurations of this HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add a custom configuration value to the cluster configuration object</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\> $storageContainer = "container001" # Cluster configuration info PS C:\> $location = "East US 2" PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location # Config values PS C:\> $coreConfigs = @{"io.file.buffer.size"="300000"} PS C:\> $mapRedConfigs = @{"mapred.map.max.attempts"="2"} # Create the cluster PS C:\> New-AzureRmHDInsightClusterConfig ` | Add-AzureRmHDInsightConfigValues ` -Core $coreConfigs ` -MapRed $mapRedConfigs ` | New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageAccountContainer</dev:code> <dev:remarks><maml:para>This command adds a Hadoop configuration value to the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightClusterConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmHDInsightMetastore</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmHDInsightMetastore</command:noun> <maml:description><maml:para>Adds a SQL Database to serve as a Hive or Oozie metastore to a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmHDInsightMetastore cmdlet adds a Hive or Oozie metastore to the HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. A metastore is a SQL Database that can used to store metadata for Hive, Oozie, or both. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmHDInsightMetastore</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>MetastoreType</maml:name> <maml:Description><maml:para>Specifies the type of metastore. Possible values are HiveMetastore or OozieMetastore. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">HiveMetastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">OozieMetastore</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastoreType</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastoreType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>SqlAzureServerName</maml:name> <maml:Description><maml:para>Specifies the AzureSQL Server instance to use for this metastore. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>DatabaseName</maml:name> <maml:Description><maml:para>Specifies the database on the AzureSQL Server instance to use for this metastore. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Specifies the credentials to use for the AzureSQL Server database. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Specifies the credentials to use for the AzureSQL Server database. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>DatabaseName</maml:name> <maml:Description><maml:para>Specifies the database on the AzureSQL Server instance to use for this metastore. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>MetastoreType</maml:name> <maml:Description><maml:para>Specifies the type of metastore. Possible values are HiveMetastore or OozieMetastore. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastoreType</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastoreType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>SqlAzureServerName</maml:name> <maml:Description><maml:para>Specifies the AzureSQL Server instance to use for this metastore. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add a SQL database metastore to the cluster configuration object</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\> $storageContainer = "container001" # Cluster configuration info PS C:\> $location = "East US 2" PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location # Hive metastore info PS C:\> $hiveSqlServer = "your-sqlserver-001" PS C:\> $hiveDb = "your-sqldb-001" PS C:\> $hiveCreds = Get-Credential # Oozie metastore info PS C:\> $oozieSqlServer = "your-sqlserver-001" PS C:\> $oozieDb = "your-sqldb-002" PS C:\> $oozieCreds = Get-Credential # Create the cluster PS C:\> New-AzureRmHDInsightClusterConfig ` | Add-AzureRmHDInsightMetastore ` -SqlAzureServerName "$oozieSqlServer.database.contoso.net" ` -DatabaseName $oozieDb ` -Credential $oozieCreds ` -MetastoreType OozieMetastore ` | Add-AzureRmHDInsightMetastore ` -SqlAzureServerName "$hiveSqlServer.database.contoso.net" ` -DatabaseName $hiveDb ` -Credential $hiveCreds ` -MetastoreType HiveMetastore ` | New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageContainer</dev:code> <dev:remarks><maml:para>This command adds a SQL database metastore to the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightClusterConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmHDInsightScriptAction</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmHDInsightScriptAction</command:noun> <maml:description><maml:para>Adds a script action to a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmHDInsightScriptAction cmdlet adds script actions to the HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> <maml:para>Script actions provide functionality that is used to install additional software or to change the configuration of applications that run on a Hadoop cluster by using Windows PowerShell or Bash scripts (for Windows or Linux clusters, respectively). </maml:para> <maml:para>A script action runs on the cluster nodes when HDInsight clusters are deployed, and they run after nodes in the cluster complete HDInsight configuration. The script action runs under system administrator account privileges and provides full access rights to the cluster nodes. You can provide each cluster with a list of script actions to run in a specified sequence. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmHDInsightScriptAction</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>NodeType</maml:name> <maml:Description><maml:para>Specifies the node type on which to run the script action. The acceptable values for this parameter are: </maml:para> <maml:para>- HeadNode </maml:para> <maml:para>- WorkerNode </maml:para> <maml:para>- ZookeeperNode </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">HeadNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkerNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">ZookeeperNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">EdgeNode</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ClusterNodeType</command:parameterValue> <dev:type><maml:name>ClusterNodeType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Uri</maml:name> <maml:Description><maml:para>Specifies the public URI for the script action (a PowerShell or Bash script). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type><maml:name>Uri</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Parameters</maml:name> <maml:Description><maml:para>Specifies the parameters for the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>NodeType</maml:name> <maml:Description><maml:para>Specifies the node type on which to run the script action. The acceptable values for this parameter are: </maml:para> <maml:para>- HeadNode </maml:para> <maml:para>- WorkerNode </maml:para> <maml:para>- ZookeeperNode </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ClusterNodeType</command:parameterValue> <dev:type><maml:name>ClusterNodeType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>Parameters</maml:name> <maml:Description><maml:para>Specifies the parameters for the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Uri</maml:name> <maml:Description><maml:para>Specifies the public URI for the script action (a PowerShell or Bash script). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type><maml:name>Uri</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add a script action to the cluster configuration object</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\> $storageContainer = "container001" # Script action info PS C:\> $scriptActionName = "<script action name>" PS C:\> $scriptActionURI = "<script action URI>" PS C:\> $scriptActionParameters = "<script action parameters>" # Cluster configuration info PS C:\> $location = "East US 2" PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location # Create the cluster PS C:\> New-AzureRmHDInsightClusterConfig ` | Add-AzureRmHDInsightScriptAction ` -Name $scriptActionName ` -Uri $scriptActionURI ` -Parameters $scriptActionParameters ` -NodeType Worker ` | Add-AzureRmHDInsightScriptAction ` -Name $scriptActionName ` -Uri $scriptActionURI ` -Parameters $scriptActionParameters ` -NodeType Head ` | New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageContainer</dev:code> <dev:remarks><maml:para>This command adds a script action for the Head and Worker nodes of the your-hadoop-001 cluster, to be run at the end of cluster creation. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightClusterConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmHDInsightSecurityProfile</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmHDInsightSecurityProfile</command:noun> <maml:description><maml:para>Adds a security profileto a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Security profile is used to create a secure cluster by kerberizing it. Security profile contains configuration related joining the cluster to Active Directory Domain. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmHDInsightSecurityProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterUsersGroupDNs</maml:name> <maml:Description><maml:para>Distinguished names of the Active Directory groups that will be available in Ambari and Ranger </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Domain</maml:name> <maml:Description><maml:para>Active Directory domain for the cluster </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DomainUserCredential</maml:name> <maml:Description><maml:para>A domain user account credential with sufficient permissions for creating the cluster. Username should be in user@domain format </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LdapsUrls</maml:name> <maml:Description><maml:para>Urls of one or multiple LDAPS servers for the Active Directory </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OrganizationalUnitDN</maml:name> <maml:Description><maml:para>Distinguished name of the organizational unit in the Active directory where user and computer accounts will be created </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterUsersGroupDNs</maml:name> <maml:Description><maml:para>Distinguished names of the Active Directory groups that will be available in Ambari and Ranger </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Domain</maml:name> <maml:Description><maml:para>Active Directory domain for the cluster </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DomainUserCredential</maml:name> <maml:Description><maml:para>A domain user account credential with sufficient permissions for creating the cluster. Username should be in user@domain format </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LdapsUrls</maml:name> <maml:Description><maml:para>Urls of one or multiple LDAPS servers for the Active Directory </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OrganizationalUnitDN</maml:name> <maml:Description><maml:para>Distinguished name of the organizational unit in the Active directory where user and computer accounts will be created </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightSecurityProfile</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks><maml:para>{{ Add example description here }} </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmHDInsightStorage</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmHDInsightStorage</command:noun> <maml:description><maml:para>Adds an Azure Storage key to a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmHDInsightStorage cmdlet adds an Azure Storage account entry to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmHDInsightStorage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the storage account name for the storage account to be added to the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>StorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the storage account key for the storage account to be added to the new cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>StorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the storage account key for the storage account to be added to the new cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the storage account name for the storage account to be added to the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add an Azure storage key to the cluster configuration object</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\> $storageContainer = "container001" # Cluster configuration info PS C:\> $location = "East US 2" PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location # Second storage account info PS C:\> $secondStorageAccountResourceGroupName = "Group" PS C:\> $secondStorageAccountName = "yourstorageacct002" PS C:\> $secondStorageAccountKey = Get-AzureRmStorageAccountKey ` PS C:\> -ResourceGroupName $secondStorageAccountResourceGroupName ` -Name $secondStorageAccountName | %{ $_.Key1 } # Create the cluster PS C:\> New-AzureRmHDInsightClusterConfig ` | Add-AzureRmHDInsightStorage ` -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` -StorageAccountKey $key2 ` | New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageContainer</dev:code> <dev:remarks><maml:para>This command adds an blob storage account entry to the HDInsight configuration named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightClusterConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmHDInsightCluster</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmHDInsightCluster</command:noun> <maml:description><maml:para>Gets and lists all of the Azure HDInsight clusters associated with the current subscription or a specified resource group, or retrieves a specific cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmHDInsightCluster cmdlet lists the Azure HDInsight service clusters for the current subscription. Use the ClusterName parameter to get details for a specific cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmHDInsightCluster</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: List all Azure HDInsight clusters</maml:title> <dev:code>PS C:\>Get-AzureRmHDInsightCluster</dev:code> <dev:remarks><maml:para>This command lists all the Azure HDInsight clusters. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Remove-AzureRmHDInsightCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Use-AzureRmHDInsightCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmHDInsightJob</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmHDInsightJob</command:noun> <maml:description><maml:para>Gets the list of jobs from a cluster and lists them in reverse chronological order, or retrieves a specific job. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmHDInsightJob cmdlet gets recent jobs for a specified Azure HDInsight cluster in reverse chronological order, with the most recent job at the top of the list. Get a specific job by providing the JobId parameter. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmHDInsightJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NumOfJobs</maml:name> <maml:Description><maml:para>Specifies the number of jobs to retrieve. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NumOfJobs</maml:name> <maml:Description><maml:para>Specifies the number of jobs to retrieve. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get recent jobs for a specified Azure HDInsight cluster</maml:title> <dev:code>PS C:\># Cluster info PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # Hive job details PS C:\> $statusFolder = "tempStatusFolder/" PS C:\> $query = "SHOW TABLES" PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` -Query $query ` | Start-AzureRmHDInsightJob -ClusterName $clusterName ` -ClusterCredential $clusterCreds ` | Get-AzureRmHDInsightJob -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command gets all recent jobs for the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightHiveJobDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Stop-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Wait-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmHDInsightJobOutput</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmHDInsightJobOutput</command:noun> <maml:description><maml:para>Gets the log output for a job from the storage account associated with a specified cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmHDInsightJobOutput cmdlet gets the log output for a job from the Storage account associated with an Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmHDInsightJobOutput</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job whose output will be fetched. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>DefaultContainer</maml:name> <maml:Description><maml:para>Specifies the default container name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the default Storage account name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the default Storage account key. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DisplayOutputType</maml:name> <maml:Description><maml:para>Specifies the job output type being requested. The acceptable values for this parameter are: </maml:para> <maml:para>- StandardOutput </maml:para> <maml:para>- StandardError </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">StandardOutput</command:parameterValue> <command:parameterValue required="false" variableLength="false">StandardError</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">JobDisplayOutputType</command:parameterValue> <dev:type><maml:name>JobDisplayOutputType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>DefaultContainer</maml:name> <maml:Description><maml:para>Specifies the default container name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the default Storage account key. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the default Storage account name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DisplayOutputType</maml:name> <maml:Description><maml:para>Specifies the job output type being requested. The acceptable values for this parameter are: </maml:para> <maml:para>- StandardOutput </maml:para> <maml:para>- StandardError </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">JobDisplayOutputType</command:parameterValue> <dev:type><maml:name>JobDisplayOutputType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job whose output will be fetched. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get the log output for a job</maml:title> <dev:code>PS C:\># Cluster info PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # Hive job details PS C:\> $statusFolder = "<status folder>" PS C:\> $query = "<query here>" PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` -Query $query ` | Start-AzureRmHDInsightJob ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds ` | Get-AzureRmHDInsightJobOutput ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command gets the log output from the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightHiveJobDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmHDInsightPersistedScriptAction</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmHDInsightPersistedScriptAction</command:noun> <maml:description><maml:para>Gets the persisted script actions for a cluster and lists them in chronological order, or gets details for a specified persisted script action. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmHDInsightPersistedScriptAction cmdlet gets the persisted script actions for an Azure HDInsight cluster and lists them in chronological order, or gets details for a specified persisted script action. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmHDInsightPersistedScriptAction</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the persisted script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the persisted script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get the persisted script actions on a cluster</maml:title> <dev:code>PS C:\>Get-AzureRmHDInsightPersistedScriptAction -ClusterName "your-hadoop-001"</dev:code> <dev:remarks><maml:para>This command gets persisted script actions on the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Remove-AzureRmHDInsightPersistedScriptAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmHDInsightPersistedScriptAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmHDInsightProperties</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmHDInsightProperties</command:noun> <maml:description><maml:para>Gets properties about the HDInsight service, such as available locations and capacity. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmHDInsightProperties cmdlet gets properties specific to Azure HDInsight, such as the list of available locations, HDInsight cluster versions, and available compute capacity. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmHDInsightProperties</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the location for which to fetch HDInsight properties. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the location for which to fetch HDInsight properties. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get the properties of an Azure HDInsight cluster</maml:title> <dev:code>PS C:\>Get-AzureRmHDInsightProperties -Location "East US 2"</dev:code> <dev:remarks><maml:para>This command gets properties from an HDInsight service from location East US 2. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmHDInsightScriptActionHistory</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmHDInsightScriptActionHistory</command:noun> <maml:description><maml:para>Gets the script action history for a cluster and lists it in reverse chronological order, or gets details of a previously executed script action. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmHDInsightScriptActionHistory cmdlet gets the script action history for an Azure HDInsight cluster and lists it in reverse chronological order, or gets details of a previously executed script action. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmHDInsightScriptActionHistory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ScriptExecutionId</maml:name> <maml:Description><maml:para>Specifies the execution ID of the executed script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ScriptExecutionId</maml:name> <maml:Description><maml:para>Specifies the execution ID of the executed script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get the history of script actions executions for a cluster</maml:title> <dev:code>PS C:\>Get-AzureRmHDInsightScriptActionHistory -ClusterName "your-hadoop-001"</dev:code> <dev:remarks><maml:para>This command gets the history of script actions for the cluster your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Grant-AzureRmHDInsightHttpServicesAccess</command:name> <command:verb>Grant</command:verb> <command:noun>AzureRmHDInsightHttpServicesAccess</command:noun> <maml:description><maml:para>Grants HTTP access to the cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Grant-AzureRmHDInsightHttpServicesAccess cmdlet grants HTTP access to an Azure HDInsight cluster using ODBC, Ambari, Oozie and web services. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Grant-AzureRmHDInsightHttpServicesAccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Grant HTTP access to an Azure HDInsight cluster</maml:title> <dev:code>PS C:\># Cluster info PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential PS C:\> Grant-AzureRmHDInsightHttpServicesAccess ` -ClusterName $clusterName ` -HttpCredential $newClusterCreds</dev:code> <dev:remarks><maml:para>This command grants HTTP access to the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Revoke-AzureRmHDInsightHttpServicesAccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Grant-AzureRmHDInsightRdpServicesAccess</command:name> <command:verb>Grant</command:verb> <command:noun>AzureRmHDInsightRdpServicesAccess</command:noun> <maml:description><maml:para>Grants RDP access to the Windows cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Grant-AzureRmHDInsightRdpServicesAccess cmdlet enables Remote Desktop Protocol (RDP) to access to a Windows-based Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Grant-AzureRmHDInsightRdpServicesAccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RdpCredential</maml:name> <maml:Description><maml:para>Specifies the RDP credentials for the cluster. This is only for Windows clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>RdpAccessExpiry</maml:name> <maml:Description><maml:para>Specifies the expiration, as a DateTime object, for RDP access to a cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>RdpAccessExpiry</maml:name> <maml:Description><maml:para>Specifies the expiration, as a DateTime object, for RDP access to a cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>RdpCredential</maml:name> <maml:Description><maml:para>Specifies the RDP credentials for the cluster. This is only for Windows clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Grant RDP access to an Azure HDInsight cluster</maml:title> <dev:code>PS C:\># Cluster info PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential PS C:\> Grant-AzureRmHDInsightRdpServicesAccess ` -ClusterName $clusterName ` -RdpCredential $newRdpCreds ` -RdpAccessExpiry $newRdpExpiry</dev:code> <dev:remarks><maml:para>This command grants RDP access to the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Revoke-AzureRmHDInsightRdpServicesAccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Invoke-AzureRmHDInsightHiveJob</command:name> <command:verb>Invoke</command:verb> <command:noun>AzureRmHDInsightHiveJob</command:noun> <maml:description><maml:para>Submits a Hive query to an HDInsight cluster and retrieves query results in one operation. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Invoke-AzureRmHDInsightHiveJob cmdlet submits a Hive query to an Azure HDInsight cluster and retrieves query results in one operation. Use the Use-AzureRmHDInsightCluster cmdlet before calling Invoke-AzureRmHDInsightHiveJob to specify which cluster will be used for the query. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Invoke-AzureRmHDInsightHiveJob</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultContainer</maml:name> <maml:Description><maml:para>Specifies the name of the default container in the default Azure Storage account that an HDInsight cluster uses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default storage account that the HDInsight cluster uses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default storage account that the HDInsight cluster uses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set when a job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>Specifies the path to a file in Azure Storage that contains the query to run. You can use this parameter instead of the Query parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are required for a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobName</maml:name> <maml:Description><maml:para>Specifies the name of a Hive job. If you do not specify this parameter, this cmdlet uses the default value: "Hive: <first 100 characters of Query>". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Specifies the Hive query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RunAsFileJob</maml:name> <maml:Description><maml:para>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. </maml:para> <maml:para>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. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultContainer</maml:name> <maml:Description><maml:para>Specifies the name of the default container in the default Azure Storage account that an HDInsight cluster uses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default storage account that the HDInsight cluster uses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default storage account that the HDInsight cluster uses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set when a job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>Specifies the path to a file in Azure Storage that contains the query to run. You can use this parameter instead of the Query parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are required for a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobName</maml:name> <maml:Description><maml:para>Specifies the name of a Hive job. If you do not specify this parameter, this cmdlet uses the default value: "Hive: <first 100 characters of Query>". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Specifies the Hive query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RunAsFileJob</maml:name> <maml:Description><maml:para>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. </maml:para> <maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Submit a Hive query to an Azure HDInsight cluster</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\> $storageContainer = "container001" # Cluster info PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # Hive job details PS C:\> $statusFolder = "tempStatusFolder/" PS C:\> $query = "SHOW TABLES" PS C:\> Use-AzureRmHDInsightCluster ` -ClusterCredential $clusterCreds ` -ClusterName $clusterName PS C:\> Invoke-AzureRmHDInsightHiveJob -StatusFolder $statusFolder ` -Query $query ` -DefaultContainer $storageAccountContainer ` -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` -DefaultStorageAccountKey $storageAccountKey</dev:code> <dev:remarks><maml:para>This command submits the query SHOW TABLES to the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Use-AzureRmHDInsightCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmHDInsightCluster</command:name> <command:verb>New</command:verb> <command:noun>AzureRmHDInsightCluster</command:noun> <maml:description><maml:para>Creates an Azure HDInsight cluster in the specified resource group for the current subscription. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureHDInsightCluster creates an Azure HDInsight cluster by using the specified parameters or by using a configuration object that is created by using the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmHDInsightCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the location for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>ClusterSizeInNodes</maml:name> <maml:Description><maml:para>Specifies the number of Worker nodes for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AdditionalStorageAccounts</maml:name> <maml:Description><maml:para>Specifies the additional Azure Storage accounts for the cluster. You can alternatively use the Add-AzureRmHDInsightStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFileContents</maml:name> <maml:Description><maml:para>Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterTier</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster tier. By default, this is Standard. The Premium tier can only be used with Linux clusters, and it enables the use of some new features. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Standard</command:parameterValue> <command:parameterValue required="false" variableLength="false">Premium</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Tier</command:parameterValue> <dev:type><maml:name>Tier</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterType</maml:name> <maml:Description><maml:para>Specifies the type of cluster to create. Options are: Hadoop, HBase, Storm, Spark </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ComponentVersion</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the cluster object to be used to create the cluster. This object can be created by using the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Configurations</maml:name> <maml:Description><maml:para>Specifies the configurations of this HDInsight cluster. You can alternatively use the Add-AzureRmHDInsightConfigValues cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountType</maml:name> <maml:Description><maml:para>Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore. Defaults to AzureStorage if not specified. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureDataLakeStore</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">StorageType</command:parameterValue> <dev:type><maml:name>StorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>AzureStorage</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageContainer</maml:name> <maml:Description><maml:para>Specifies the name of the default container in the default Azure storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageRootPath</maml:name> <maml:Description><maml:para>Specifies the path-prefix in the Data Lake Store Account that the HDInsight cluster will use as the default filesystem. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EdgeNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HeadNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Head node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveMetastore</maml:name> <maml:Description><maml:para>Specifies the SQL Database to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieMetastore</maml:name> <maml:Description><maml:para>Specifies the SQL Database to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OSType</maml:name> <maml:Description><maml:para>Specifies the operating system for the cluster. Options are: Windows, Linux </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> <command:parameterValue required="false" variableLength="false">Linux</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OSType</command:parameterValue> <dev:type><maml:name>OSType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RdpAccessExpiry</maml:name> <maml:Description><maml:para>Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RdpCredential</maml:name> <maml:Description><maml:para>Specifies the Remote Desktop (RDP) credentials for the cluster. This is only for Windows clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ScriptActions</maml:name> <maml:Description><maml:para>Specifies the script actions to run on the cluster at the end of cluster creation. You can alternatively use Add-AzureRmHDInsightScriptAction. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">HeadNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkerNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">ZookeeperNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">EdgeNode</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SecurityProfile</maml:name> <maml:Description><maml:para>Specifies the security related properties used to create a secure cluster. You can alternatively use the Add-AzureRmHDInsightSecurityProfile cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightSecurityProfile</command:parameterValue> <dev:type><maml:name>AzureHDInsightSecurityProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SshCredential</maml:name> <maml:Description><maml:para>Specifies the SSH credential to be used for SSH connections. This is only for Linux clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SshPublicKey</maml:name> <maml:Description><maml:para>Specifies the public key to be used for SSH connections. This is only for Linux clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SubnetName</maml:name> <maml:Description><maml:para>Specifies the name of a subnet within the chosen virtual network for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Version</maml:name> <maml:Description><maml:para>Specifies the HDI version of the HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>VirtualNetworkId</maml:name> <maml:Description><maml:para>Specifies the ID of the virtual network into which to provision the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WorkerNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Worker node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ZookeeperNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Zookeeper node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for HBase or Storm clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmHDInsightCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the location for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>ClusterSizeInNodes</maml:name> <maml:Description><maml:para>Specifies the number of Worker nodes for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AdditionalStorageAccounts</maml:name> <maml:Description><maml:para>Specifies the additional Azure Storage accounts for the cluster. You can alternatively use the Add-AzureRmHDInsightStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFilePath</maml:name> <maml:Description><maml:para>Specifies the file path to the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterTier</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster tier. By default, this is Standard. The Premium tier can only be used with Linux clusters, and it enables the use of some new features. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Standard</command:parameterValue> <command:parameterValue required="false" variableLength="false">Premium</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Tier</command:parameterValue> <dev:type><maml:name>Tier</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterType</maml:name> <maml:Description><maml:para>Specifies the type of cluster to create. Options are: Hadoop, HBase, Storm, Spark </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ComponentVersion</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the cluster object to be used to create the cluster. This object can be created by using the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Configurations</maml:name> <maml:Description><maml:para>Specifies the configurations of this HDInsight cluster. You can alternatively use the Add-AzureRmHDInsightConfigValues cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountType</maml:name> <maml:Description><maml:para>Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore. Defaults to AzureStorage if not specified. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureDataLakeStore</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">StorageType</command:parameterValue> <dev:type><maml:name>StorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>AzureStorage</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageContainer</maml:name> <maml:Description><maml:para>Specifies the name of the default container in the default Azure storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageRootPath</maml:name> <maml:Description><maml:para>Specifies the path-prefix in the Data Lake Store Account that the HDInsight cluster will use as the default filesystem. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EdgeNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HeadNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Head node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveMetastore</maml:name> <maml:Description><maml:para>Specifies the SQL Database to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieMetastore</maml:name> <maml:Description><maml:para>Specifies the SQL Database to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OSType</maml:name> <maml:Description><maml:para>Specifies the operating system for the cluster. Options are: Windows, Linux </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Windows</command:parameterValue> <command:parameterValue required="false" variableLength="false">Linux</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OSType</command:parameterValue> <dev:type><maml:name>OSType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RdpAccessExpiry</maml:name> <maml:Description><maml:para>Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RdpCredential</maml:name> <maml:Description><maml:para>Specifies the Remote Desktop (RDP) credentials for the cluster. This is only for Windows clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ScriptActions</maml:name> <maml:Description><maml:para>Specifies the script actions to run on the cluster at the end of cluster creation. You can alternatively use Add-AzureRmHDInsightScriptAction. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">HeadNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkerNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">ZookeeperNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">EdgeNode</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SecurityProfile</maml:name> <maml:Description><maml:para>Specifies the security related properties used to create a secure cluster. You can alternatively use the Add-AzureRmHDInsightSecurityProfile cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightSecurityProfile</command:parameterValue> <dev:type><maml:name>AzureHDInsightSecurityProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SshCredential</maml:name> <maml:Description><maml:para>Specifies the SSH credential to be used for SSH connections. This is only for Linux clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SshPublicKey</maml:name> <maml:Description><maml:para>Specifies the public key to be used for SSH connections. This is only for Linux clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SubnetName</maml:name> <maml:Description><maml:para>Specifies the name of a subnet within the chosen virtual network for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Version</maml:name> <maml:Description><maml:para>Specifies the HDI version of the HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>VirtualNetworkId</maml:name> <maml:Description><maml:para>Specifies the ID of the virtual network into which to provision the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WorkerNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Worker node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ZookeeperNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Zookeeper node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for HBase or Storm clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AdditionalStorageAccounts</maml:name> <maml:Description><maml:para>Specifies the additional Azure Storage accounts for the cluster. You can alternatively use the Add-AzureRmHDInsightStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFileContents</maml:name> <maml:Description><maml:para>Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFilePath</maml:name> <maml:Description><maml:para>Specifies the file path to the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>ClusterSizeInNodes</maml:name> <maml:Description><maml:para>Specifies the number of Worker nodes for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterTier</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster tier. By default, this is Standard. The Premium tier can only be used with Linux clusters, and it enables the use of some new features. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Tier</command:parameterValue> <dev:type><maml:name>Tier</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterType</maml:name> <maml:Description><maml:para>Specifies the type of cluster to create. Options are: Hadoop, HBase, Storm, Spark </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ComponentVersion</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.String]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.String]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the cluster object to be used to create the cluster. This object can be created by using the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Configurations</maml:name> <maml:Description><maml:para>Specifies the configurations of this HDInsight cluster. You can alternatively use the Add-AzureRmHDInsightConfigValues cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountType</maml:name> <maml:Description><maml:para>Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore. Defaults to AzureStorage if not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">StorageType</command:parameterValue> <dev:type><maml:name>StorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>AzureStorage</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageContainer</maml:name> <maml:Description><maml:para>Specifies the name of the default container in the default Azure storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageRootPath</maml:name> <maml:Description><maml:para>Specifies the path-prefix in the Data Lake Store Account that the HDInsight cluster will use as the default filesystem. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EdgeNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HeadNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Head node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveMetastore</maml:name> <maml:Description><maml:para>Specifies the SQL Database to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the location for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieMetastore</maml:name> <maml:Description><maml:para>Specifies the SQL Database to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OSType</maml:name> <maml:Description><maml:para>Specifies the operating system for the cluster. Options are: Windows, Linux </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OSType</command:parameterValue> <dev:type><maml:name>OSType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RdpAccessExpiry</maml:name> <maml:Description><maml:para>Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RdpCredential</maml:name> <maml:Description><maml:para>Specifies the Remote Desktop (RDP) credentials for the cluster. This is only for Windows clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ScriptActions</maml:name> <maml:Description><maml:para>Specifies the script actions to run on the cluster at the end of cluster creation. You can alternatively use Add-AzureRmHDInsightScriptAction. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]</command:parameterValue> <dev:type><maml:name>System.Collections.Generic.Dictionary`2[Microsoft.Azure.Management.HDInsight.Models.ClusterNodeType,System.Collections.Generic.List`1[Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightScriptAction]]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SecurityProfile</maml:name> <maml:Description><maml:para>Specifies the security related properties used to create a secure cluster. You can alternatively use the Add-AzureRmHDInsightSecurityProfile cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightSecurityProfile</command:parameterValue> <dev:type><maml:name>AzureHDInsightSecurityProfile</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SshCredential</maml:name> <maml:Description><maml:para>Specifies the SSH credential to be used for SSH connections. This is only for Linux clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SshPublicKey</maml:name> <maml:Description><maml:para>Specifies the public key to be used for SSH connections. This is only for Linux clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>SubnetName</maml:name> <maml:Description><maml:para>Specifies the name of a subnet within the chosen virtual network for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Version</maml:name> <maml:Description><maml:para>Specifies the HDI version of the HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>VirtualNetworkId</maml:name> <maml:Description><maml:para>Specifies the ID of the virtual network into which to provision the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WorkerNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Worker node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ZookeeperNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Zookeeper node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for HBase or Storm clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- Example 1: Create an Azure HDInsight cluster --------------------------</maml:title> <dev:code>PS C:\&gt; # Primary storage account info $storageAccountResourceGroupName = "Group" $storageAccountName = "yourstorageacct001" $storageAccountKey = Get-AzureStorageAccountKey ` -ResourceGroupName $storageAccountResourceGroupName ` -Name $storageAccountName | %{ $_.Key1 } $storageContainer = "container002" # Cluster configuration info $location = "East US 2" $clusterResourceGroupName = "Group" $clusterName = "your-hadoop-002" $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRMResourceGroup -Name $clusterResourceGroupName -Location $location # Create the cluster New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageContainer</dev:code> <dev:remarks><maml:para>This command creates a cluster in the current subscription. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>New-AzureRmHDInsightClusterConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmHDInsightClusterConfig</command:name> <command:verb>New</command:verb> <command:noun>AzureRmHDInsightClusterConfig</command:noun> <maml:description><maml:para>Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmHDInsightClusterConfig cmdlet creates a non-persisted object that describes an Azure HDInsight cluster configuration. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmHDInsightClusterConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFileContents</maml:name> <maml:Description><maml:para>Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFilePath</maml:name> <maml:Description><maml:para>Specifies the file path to the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterTier</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster tier. The acceptable values for this parameter are: </maml:para> <maml:para>- Standard </maml:para> <maml:para>- Premium </maml:para> <maml:para> </maml:para> <maml:para>The default value is Standard. The Premium tier can only be used with Linux clusters, and it enables the use of some new features. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Standard</command:parameterValue> <command:parameterValue required="false" variableLength="false">Premium</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Tier</command:parameterValue> <dev:type><maml:name>Tier</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterType</maml:name> <maml:Description><maml:para>Specifies the type of cluster to create. The acceptable values for this parameter are: </maml:para> <maml:para>- Hadoop </maml:para> <maml:para>- HBase </maml:para> <maml:para>- Storm </maml:para> <maml:para>- Spark </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountType</maml:name> <maml:Description><maml:para>Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureDataLakeStore</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">StorageType</command:parameterValue> <dev:type><maml:name>StorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>AzureStorage</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EdgeNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HeadNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Head node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveMetastore</maml:name> <maml:Description><maml:para>Specifies the metastore to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieMetastore</maml:name> <maml:Description><maml:para>Specifies the metastore to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WorkerNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Worker node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ZookeeperNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Zookeeper node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for HBase or Storm clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AadTenantId</maml:name> <maml:Description><maml:para>Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFileContents</maml:name> <maml:Description><maml:para>Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateFilePath</maml:name> <maml:Description><maml:para>Specifies the file path to the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificatePassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate that will be used to authenticate as the Service Principal. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterTier</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster tier. The acceptable values for this parameter are: </maml:para> <maml:para>- Standard </maml:para> <maml:para>- Premium </maml:para> <maml:para> </maml:para> <maml:para>The default value is Standard. The Premium tier can only be used with Linux clusters, and it enables the use of some new features. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Tier</command:parameterValue> <dev:type><maml:name>Tier</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClusterType</maml:name> <maml:Description><maml:para>Specifies the type of cluster to create. The acceptable values for this parameter are: </maml:para> <maml:para>- Hadoop </maml:para> <maml:para>- HBase </maml:para> <maml:para>- Storm </maml:para> <maml:para>- Spark </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DefaultStorageAccountType</maml:name> <maml:Description><maml:para>Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">StorageType</command:parameterValue> <dev:type><maml:name>StorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>AzureStorage</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>EdgeNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for RServer clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HeadNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Head node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HiveMetastore</maml:name> <maml:Description><maml:para>Specifies the metastore to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ObjectId</maml:name> <maml:Description><maml:para>Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type><maml:name>Guid</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OozieMetastore</maml:name> <maml:Description><maml:para>Specifies the metastore to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightMetastore</command:parameterValue> <dev:type><maml:name>AzureHDInsightMetastore</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WorkerNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Worker node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ZookeeperNodeSize</maml:name> <maml:Description><maml:para>Specifies the size of the virtual machine for the Zookeeper node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page. This parameter is valid only for HBase or Storm clusters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a cluster configuration object</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\> $storageContainer = "container002" # Cluster configuration info PS C:\> $location = "East US 2" PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-002" PS C:\> $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location # Create the cluster PS C:\> New-AzureRmHDInsightClusterConfig ` | Add-AzureRmHDInsightStorage ` -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` -StorageAccountKey $key2 ` | New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location ` -DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" ` -DefaultStorageAccountKey $storageAccountKey ` -DefaultStorageContainer $storageContainer</dev:code> <dev:remarks><maml:para>This command creates a cluster configuration object. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Add-AzureRmHDInsightStorage</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmHDInsightHiveJobDefinition</command:name> <command:verb>New</command:verb> <command:noun>AzureRmHDInsightHiveJobDefinition</command:noun> <maml:description><maml:para>Creates a Hive job object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmHDInsightHiveJobDefinition cmdlet defines a Hive job object for use with an Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmHDInsightHiveJobDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set for when the job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobName</maml:name> <maml:Description><maml:para>Specifies the name of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Specifies the Hive query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RunAsFileJob</maml:name> <maml:Description><maml:para>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. </maml:para> <maml:para>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. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set for when the job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobName</maml:name> <maml:Description><maml:para>Specifies the name of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Specifies the Hive query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>RunAsFileJob</maml:name> <maml:Description><maml:para>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. </maml:para> <maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a Hive job definition</maml:title> <dev:code>PS C:\># Cluster info PS C:\>$clusterName = "your-hadoop-001" PS C:\>$clusterCreds = Get-Credential # Hive job details PS C:\>$statusFolder = "<status folder>" PS C:\>$query = "SHOW TABLES" PS C:\>New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` -Query $query ` | Start-AzureRmHDInsightJob ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command creates a Hive job definition. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmHDInsightMapReduceJobDefinition</command:name> <command:verb>New</command:verb> <command:noun>AzureRmHDInsightMapReduceJobDefinition</command:noun> <maml:description><maml:para>Creates a MapReduce job object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmHDInsightMapReduceJobDefinition cmdlet defines a new MapReduce job for use with an Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmHDInsightMapReduceJobDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClassName</maml:name> <maml:Description><maml:para>Specifies the job class in the JAR file. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set for when the job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JarFile</maml:name> <maml:Description><maml:para>Specifies the JAR file to use for the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobName</maml:name> <maml:Description><maml:para>Specifies the name of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LibJars</maml:name> <maml:Description><maml:para>Specifies the lib JARS for the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ClassName</maml:name> <maml:Description><maml:para>Specifies the job class in the JAR file. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set for when the job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JarFile</maml:name> <maml:Description><maml:para>Specifies the JAR file to use for the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>JobName</maml:name> <maml:Description><maml:para>Specifies the name of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LibJars</maml:name> <maml:Description><maml:para>Specifies the lib JARS for the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a MapReduce job definition</maml:title> <dev:code>PS C:\># Cluster info PS C:\>$clusterName = "your-hadoop-001" PS C:\>$clusterCreds = Get-Credential PS C:\>New-AzureRmHDInsightMapReduceJobDefinition -StatusFolder $statusFolder ` -ClassName $className ` -JarFile $jarFilePath ` | Start-AzureRmHDInsightJob ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command creates a MapReduce job definition. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmHDInsightPigJobDefinition</command:name> <command:verb>New</command:verb> <command:noun>AzureRmHDInsightPigJobDefinition</command:noun> <maml:description><maml:para>Creates a Pig job object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmHDInsightPigJobDefinition cmdlet defines a Pig job object for use with an Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmHDInsightPigJobDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Specifies the Pig query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Specifies the Pig query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a Pig job definition</maml:title> <dev:code>PS C:\># Cluster info PS C:\>$clusterName = "your-hadoop-001" PS C:\>$clusterCreds = Get-Credential # Pig job details PS C:\>$statusFolder = "tempStatusFolder/" PS C:\>$query = "SHOW TABLES" PS C:\>New-AzureRmHDInsightPigJobDefinition -StatusFolder $statusFolder ` -Query $query ` | Start-AzureRmHDInsightJob ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command creates a Pig job definition. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmHDInsightSqoopJobDefinition</command:name> <command:verb>New</command:verb> <command:noun>AzureRmHDInsightSqoopJobDefinition</command:noun> <maml:description><maml:para>Creates a Sqoop job object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmHDInsightSqoopJobDefinition cmdlet defines a Sqoop job object for use with an Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmHDInsightSqoopJobDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Command</maml:name> <maml:Description><maml:para>Specifies the Sqoop command. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LibDir</maml:name> <maml:Description><maml:para>Specifies the library directory for the Sqoop job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Command</maml:name> <maml:Description><maml:para>Specifies the Sqoop command. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>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. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LibDir</maml:name> <maml:Description><maml:para>Specifies the library directory for the Sqoop job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a Sqoop job definition</maml:title> <dev:code>PS C:\># Cluster info PS C:\>$clusterName = "your-hadoop-001" PS C:\>$clusterCreds = Get-Credential PS C:\>New-AzureRmHDInsightSqoopJobDefinition -StatusFolder $statusFolder ` -Command $sqoopCommand ` | Start-AzureRmHDInsightJob -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command creates a Sqoop job definition. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmHDInsightStreamingMapReduceJobDefinition</command:name> <command:verb>New</command:verb> <command:noun>AzureRmHDInsightStreamingMapReduceJobDefinition</command:noun> <maml:description><maml:para>Creates a Streaming MapReduce job object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmHDInsightStreamingMapReduceJobDefinition cmdlet defines a Streaming MapReduce job object for use with an Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmHDInsightStreamingMapReduceJobDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CommandEnvironment</maml:name> <maml:Description><maml:para>Specifies an array of command-line environment variables to set when a job runs on worker nodes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set for when the job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>InputPath</maml:name> <maml:Description><maml:para>Specifies the path to the input files. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Mapper</maml:name> <maml:Description><maml:para>Specifies a Mapper file name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OutputPath</maml:name> <maml:Description><maml:para>Specifies the path for the job output. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Reducer</maml:name> <maml:Description><maml:para>Specifies a Reducer file name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Arguments</maml:name> <maml:Description><maml:para>Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CommandEnvironment</maml:name> <maml:Description><maml:para>Specifies an array of command-line environment variables to set when a job runs on worker nodes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Defines</maml:name> <maml:Description><maml:para>Specifies Hadoop configuration values to set for when the job runs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>File</maml:name> <maml:Description><maml:para>Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Files</maml:name> <maml:Description><maml:para>Specifies a collection of files that are associated with a Hive job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>InputPath</maml:name> <maml:Description><maml:para>Specifies the path to the input files. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Mapper</maml:name> <maml:Description><maml:para>Specifies a Mapper file name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OutputPath</maml:name> <maml:Description><maml:para>Specifies the path for the job output. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Reducer</maml:name> <maml:Description><maml:para>Specifies a Reducer file name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StatusFolder</maml:name> <maml:Description><maml:para>Specifies the location of the folder that contains standard outputs and error outputs for a job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a Streaming MapReduce job definition</maml:title> <dev:code>PS C:\># Cluster info PS C:\>$clusterName = "your-hadoop-001" PS C:\>$clusterCreds = Get-Credential # Streaming MapReduce job details PS C:\>$statusFolder = "tempStatusFolder/" PS C:\>$query = "SHOW TABLES" PS C:\>New-AzureRmHDInsightStreamingMapReduceJobDefinition -StatusFolder $statusFolder ` -Query $query ` | Start-AzureRmHDInsightJob ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command creates a Streaming MapReduce job definition. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmHDInsightCluster</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmHDInsightCluster</command:noun> <maml:description><maml:para>Removes the specified HDInsight cluster from the current subscription. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmHDInsightCluster cmdlet removes the specified HDInsight service cluster from a subscription. This operation also deletes any data stored in the Hadoop Distributed File System (HDFS) on the cluster. Data stored in the associated Azure Storage account is not deleted. Data stored in external metastores is not deleted. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmHDInsightCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Delete an Azure HDInsight cluster</maml:title> <dev:code>PS C:\>Remove-AzureRmHDInsightCluster -ClusterName "your-hadoop-001"</dev:code> <dev:remarks><maml:para>This command removes the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmHDInsightCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Use-AzureRmHDInsightCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmHDInsightPersistedScriptAction</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmHDInsightPersistedScriptAction</command:noun> <maml:description><maml:para>Removes an persisted script action from an HDInsight cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmHDInsightPersistedScriptAction cmdlet removes a persisted script action from the specified Azure HDInsight cluster's list of persisted script actions. The removed script will no longer be executed when the cluster is scaled up. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmHDInsightPersistedScriptAction</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the persisted script action to be removed. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the persisted script action to be removed. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a script action from the list of persisted script actions on a cluster</maml:title> <dev:code>PS C:\>Remove-AzureRmHDInsightPersistedScriptAction ` -ClusterName "your-hadoop-001" ` -Name "Scriptaction"</dev:code> <dev:remarks><maml:para>This command removes the script action named Scriptaction from the list of persisted script actions on the specified cluster. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmHDInsightPersistedScriptAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmHDInsightPersistedScriptAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Revoke-AzureRmHDInsightHttpServicesAccess</command:name> <command:verb>Revoke</command:verb> <command:noun>AzureRmHDInsightHttpServicesAccess</command:noun> <maml:description><maml:para>Disables HTTP access to the cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Revoke-AzureRmHDInsightHttpServicesAccess cmdlet disables HTTP access to an Azure HDInsight cluster for ODBC, Ambari, Oozie and webHCatalog web services. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Revoke-AzureRmHDInsightHttpServicesAccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Disable HTTP access to a cluster</maml:title> <dev:code>PS C:\>Revoke-AzureRmHDInsightHttpServicesAccess ` -ClusterName "your-hadoop_001"</dev:code> <dev:remarks><maml:para>This command revokes HTTP access to the cluster named your-hadoop_001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Grant-AzureRmHDInsightHttpServicesAccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Revoke-AzureRmHDInsightRdpServicesAccess</command:name> <command:verb>Revoke</command:verb> <command:noun>AzureRmHDInsightRdpServicesAccess</command:noun> <maml:description><maml:para>Disables RDP access to a Windows cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Revoke-AzureRmHDInsightRdpServicesAccess cmdlet disables Remote Desktop Protocol (RDP) access to a Windows-based Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Revoke-AzureRmHDInsightRdpServicesAccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Disable RDP access to a specified cluster</maml:title> <dev:code>PS C:\>Revoke-AzureRmHDInsightRdpServicesAccess -ClusterName "your-hadoop-001"</dev:code> <dev:remarks><maml:para>This command revokes RDP access to the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Grant-AzureRmHDInsightRdpServicesAccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmHDInsightClusterSize</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmHDInsightClusterSize</command:noun> <maml:description><maml:para>Sets the number of Worker nodes in a specified cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmHDInsightClusterSize cmdlet sets the number of Worker nodes in a specified Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmHDInsightClusterSize</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>TargetInstanceCount</maml:name> <maml:Description><maml:para>Specifies the desired number of Worker nodes in the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>TargetInstanceCount</maml:name> <maml:Description><maml:para>Specifies the desired number of Worker nodes in the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set the size of a specified cluster</maml:title> <dev:code>PS C:\>Set-AzureRmHDInsightClusterSize -ClusterName "your-hadoop-001" -TargetInstanceCount 6</dev:code> <dev:remarks><maml:para>This command sets the size of the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmHDInsightDefaultStorage</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmHDInsightDefaultStorage</command:noun> <maml:description><maml:para>Sets the default Storage account setting in a cluster configuration object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmHDInsightDefaultStorage cmdlet sets the default Storage account setting in the Azure HDInsight cluster configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmHDInsightDefaultStorage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>StorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StorageAccountType</maml:name> <maml:Description><maml:para>Gets or sets the type of the default storage account. Defaults to AzureStorage </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AzureStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">AzureDataLakeStore</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">StorageType</command:parameterValue> <dev:type><maml:name>StorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Config</maml:name> <maml:Description><maml:para>Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightConfig</command:parameterValue> <dev:type><maml:name>AzureHDInsightConfig</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>StorageAccountKey</maml:name> <maml:Description><maml:para>Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>StorageAccountName</maml:name> <maml:Description><maml:para>Specifies the name of the default storage account that the HDInsight cluster will use. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>StorageAccountType</maml:name> <maml:Description><maml:para>Gets or sets the type of the default storage account. Defaults to AzureStorage </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">StorageType</command:parameterValue> <dev:type><maml:name>StorageType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set the default storage account for the cluster configuration object</maml:title> <dev:code>PS C:\># Primary storage account info PS C:\> $storageAccountResourceGroupName = "Group" PS C:\> $storageAccountName = "yourstorageacct001" PS C:\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value PS C:\>$storageContainer = "container002" # Cluster configuration info PS C:\> $location = "East US 2" PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-002" PS C:\> $clusterCreds = Get-Credential # If the cluster's resource group doesn't exist yet, run: # New-AzureRMResourceGroup -Name $clusterResourceGroupName -Location $location # Create the cluster PS C:\> New-AzureRmHDInsightClusterConfig ` | Set-AzureRmHDInsightDefaultStorage ` -StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" ` -StorageAccountKey $key2 ` -StorageContainer $storageContainer ` | New-AzureRmHDInsightCluster ` -ClusterType Hadoop ` -OSType Windows ` -ClusterSizeInNodes 4 ` -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -HttpCredential $clusterCreds ` -Location $location</dev:code> <dev:remarks><maml:para>This command sets the default Storage account for a cluster configuration object. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks></command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmHDInsightPersistedScriptAction</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmHDInsightPersistedScriptAction</command:noun> <maml:description><maml:para>Sets a previously executed script action to be a persisted script action. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmHDInsightPersistedScriptAction cmdlet sets a previously executed script action to be a persisted script action. The specified script action must have previously succeeded. The script action will run each time the Azure HDInsight cluster is scaled up. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmHDInsightPersistedScriptAction</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ScriptExecutionId</maml:name> <maml:Description><maml:para>Specifies the execution ID of the script action to promote to persisted. This script action must have succeeded in order to be promoted. You can find the script action execution ID using Get-AzureRmHDInsightScriptActionHistory. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>ScriptExecutionId</maml:name> <maml:Description><maml:para>Specifies the execution ID of the script action to promote to persisted. This script action must have succeeded in order to be promoted. You can find the script action execution ID using Get-AzureRmHDInsightScriptActionHistory. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type><maml:name>Int64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set a previously successful script action to be persisted, or run on cluster scale up</maml:title> <dev:code>PS C:\>Set-AzureRmHDInsightPersistedScriptAction ` -ClusterName "your-hadoop-001" ` -ScriptExecutionId "<id>"</dev:code> <dev:remarks><maml:para>This command sets a previously successful script action to be a persisted script action. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmHDInsightPersistedScriptAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmHDInsightPersistedScriptAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Start-AzureRmHDInsightJob</command:name> <command:verb>Start</command:verb> <command:noun>AzureRmHDInsightJob</command:noun> <maml:description><maml:para>Starts a defined Azure HDInsight job on a specified cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Start-AzureRMHDInsightJob cmdlet starts a defined Azure HDInsight job on a specified cluster. This can be a MapReduce job, a Streaming MapReduce job, a Hive job, or a Pig job. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Start-AzureRmHDInsightJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>JobDefinition</maml:name> <maml:Description><maml:para>Specifies the job to start on the Azure HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightJobDefinition</command:parameterValue> <dev:type><maml:name>AzureHDInsightJobDefinition</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>JobDefinition</maml:name> <maml:Description><maml:para>Specifies the job to start on the Azure HDInsight cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AzureHDInsightJobDefinition</command:parameterValue> <dev:type><maml:name>AzureHDInsightJobDefinition</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Start a job on the specified cluster</maml:title> <dev:code>PS C:\># Cluster info PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # Hive job details PS C:\> $statusFolder = "tempStatusFolder/" PS C:\> $query = "SHOW TABLES" PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` -Query $query ` | Start-AzureRmHDInsightJob ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command starts a job on the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmHDInsightHiveJobDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Stop-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Wait-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Stop-AzureRmHDInsightJob</command:name> <command:verb>Stop</command:verb> <command:noun>AzureRmHDInsightJob</command:noun> <maml:description><maml:para>Stops a specified running job on a cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Stop-AzureRmHDInsightJob cmdlet stops a specified running job on an Azure HDInsight cluster. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Stop-AzureRmHDInsightJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Stop a job on the specified cluster</maml:title> <dev:code>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</dev:code> <dev:remarks><maml:para>This command stops a job on the cluster named your-hadoop-001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Wait-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Submit-AzureRmHDInsightScriptAction</command:name> <command:verb>Submit</command:verb> <command:noun>AzureRmHDInsightScriptAction</command:noun> <maml:description><maml:para>Submits a new script action to an Azure HDInsight cluster. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Submit-AzureRmHDInsightScriptAction cmdlet submits a new script action to an Azure HDInsight cluster. Use PersistOnSuccess to have the script action run each time the cluster is scaled up, as long as the script action initially succeeds. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Submit-AzureRmHDInsightScriptAction</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Uri</maml:name> <maml:Description><maml:para>Specifies the public URI for the script action (a PowerShell or Bash script). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type><maml:name>Uri</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>NodeTypes</maml:name> <maml:Description><maml:para>Specifies the node types on which to run the script action. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">HeadNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkerNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">ZookeeperNode</command:parameterValue> <command:parameterValue required="false" variableLength="false">EdgeNode</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RuntimeScriptActionClusterNodeType[]</command:parameterValue> <dev:type><maml:name>RuntimeScriptActionClusterNodeType[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"><maml:name>Parameters</maml:name> <maml:Description><maml:para>Specifies the parameters for the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>ApplicationName</maml:name> <maml:Description><maml:para>Specifies the application name for the script action. When ApplicationName is specified, PersistOnSuccess should be set to False, nodes must contain only edgenode, and script action count should equal 1. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>PersistOnSuccess</maml:name> <maml:Description><maml:para>Indicates that the script action should run each time the cluster is scaled up. This switch parameter is ignored if the script action initially fails. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"><maml:name>ApplicationName</maml:name> <maml:Description><maml:para>Specifies the application name for the script action. When ApplicationName is specified, PersistOnSuccess should be set to False, nodes must contain only edgenode, and script action count should equal 1. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>NodeTypes</maml:name> <maml:Description><maml:para>Specifies the node types on which to run the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">RuntimeScriptActionClusterNodeType[]</command:parameterValue> <dev:type><maml:name>RuntimeScriptActionClusterNodeType[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"><maml:name>Parameters</maml:name> <maml:Description><maml:para>Specifies the parameters for the script action. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"><maml:name>PersistOnSuccess</maml:name> <maml:Description><maml:para>Indicates that the script action should run each time the cluster is scaled up. This switch parameter is ignored if the script action initially fails. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Uri</maml:name> <maml:Description><maml:para>Specifies the public URI for the script action (a PowerShell or Bash script). </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type><maml:name>Uri</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Submit a new script action to a running HDInsight cluster</maml:title> <dev:code>PS C:\>Submit-AzureRmHDInsightScriptAction ` -ClusterName "your-hadoop-001" ` -Name "scriptaction" ` -Uri "<script action URI>" ` -NodeTypes Worker -PersistOnSuccess</dev:code> <dev:remarks><maml:para>This command submits a script action to a running HDInsight cluster. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Add-AzureRmHDInsightScriptAction</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Use-AzureRmHDInsightCluster</command:name> <command:verb>Use</command:verb> <command:noun>AzureRmHDInsightCluster</command:noun> <maml:description><maml:para>Selects a cluster to be used with the Invoke-RmAzureHDInsightHiveJob cmdlet. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Use-AzureRmHDInsightCluster cmdlet selects the Azure HDInsight cluster for the Invoke-AzureRmHDInsightHiveJob cmdlet to use to submit Hive jobs. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Use-AzureRmHDInsightCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Select a cluster for Hive query submission</maml:title> <dev:code>PS C:\># Cluster info PS C:\>$clusterName = "your-hadoop-001" PS C:\>$clusterCreds = Get-Credential PS C:\>Use-AzureRmHDInsightCluster ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command selects a cluster for a Hive query submission. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmHDInsightCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmHDInsightCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Wait-AzureRmHDInsightJob</command:name> <command:verb>Wait</command:verb> <command:noun>AzureRmHDInsightJob</command:noun> <maml:description><maml:para>Waits for the completion or failure of a specified job. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Wait-AzureRmHDInsightJob cmdlet awaits the completion or failure of an Azure HDInsight job. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Wait-AzureRmHDInsightJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>TimeoutInSeconds</maml:name> <maml:Description><maml:para>The total time to wait for job completion, in seconds. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WaitIntervalInSeconds</maml:name> <maml:Description><maml:para>The time to wait between job status checks, in seconds. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>ClusterName</maml:name> <maml:Description><maml:para>Specifies the name of the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="ClusterCredential"><maml:name>HttpCredential</maml:name> <maml:Description><maml:para>Specifies the cluster login (HTTP) credentials for the cluster. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>JobId</maml:name> <maml:Description><maml:para>Specifies the job ID of the job. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>TimeoutInSeconds</maml:name> <maml:Description><maml:para>The total time to wait for job completion, in seconds. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>WaitIntervalInSeconds</maml:name> <maml:Description><maml:para>The time to wait between job status checks, in seconds. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Wait for the completion or failure of a job</maml:title> <dev:code>PS C:\># Cluster info PS C:\> $clusterResourceGroupName = "Group" PS C:\> $clusterName = "your-hadoop-001" PS C:\> $clusterCreds = Get-Credential # Hive job details PS C:\> $statusFolder = "tempStatusFolder/" PS C:\> $query = "SHOW TABLES" PS C:\> New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` -Query $query ` | Start-AzureRmHDInsightJob -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds ` | Wait-AzureRmHDInsightJob -ResourceGroupName $clusterResourceGroupName ` -ClusterName $clusterName ` -ClusterCredential $clusterCreds</dev:code> <dev:remarks><maml:para>This command waits for the completion or failure of a job. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Start-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Stop-AzureRmHDInsightJob</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |