diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.psd1 b/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.psd1 index ecbddeb6227d..c9941af2a63b 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.psd1 +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.psd1 @@ -9,7 +9,7 @@ @{ # Version number of this module. -ModuleVersion = '0.9.10' +ModuleVersion = '1.0.5' # ID used to uniquely identify this module GUID = 'F237EAAA-BD3A-4965-AD4A-BF38598BFEF7' diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.xml b/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.xml index bffce5ba0f1f..0c41997b4933 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.xml +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/Microsoft.Azure.Commands.HDInsight.dll-help.xml @@ -1,7641 +1,8562 @@ - - - - - Add-AzureRmHDInsightClusterIdentity - - Adds a cluster identity to the Microsoft Azure HDInsight cluster configuration. - - - - - Add - AzureHDInsightClusterIdentity - - - - Adds a cluster identity to the Microsoft Azure HDInsight cluster configuration. - - - - Add-AzureRmHDInsightClusterIdentity - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - - ObjectId - - The Service Principal Object Id for accessing Azure Data Lake. - - Guid - - - CertificateFilePath - - The Service Principal certificate for accessing Azure Data Lake. - - String - - - CertificatePassword - - The Service Principal certificate password for accessing Azure Data Lake. - - String - - - AadTenantId - - The Service Principal AAD Tenant Id for accessing Azure Data Lake. - - Guid - - - Profile - - - - AzureProfile - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - AzureHDInsightConfig - - - - - - - ObjectId - - The Service Principal Object Id for accessing Azure Data Lake. - - Guid - - Guid - - - - - - - CertificateFilePath - - The Service Principal certificate for accessing Azure Data Lake. - - String - - String - - - - - - - CertificatePassword - - The Service Principal certificate password for accessing Azure Data Lake. - - String - - String - - - - - - - AadTenantId - - The Service Principal AAD Tenant Id for accessing Azure Data Lake. - - Guid - - Guid - - - - - - - Profile - - - - AzureProfile - - AzureProfile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Add-AzureRmHDInsightConfigValues - - Adds a Hadoop configuration value customization and/or a Hive shared library customization to the Microsoft Azure HDInsight cluster configuration. - - - - - Add - AzureRmHDInsightConfigValues - - - - Adds a Hadoop configuration value customization, such as core-site.xml or hive-site.xml, and/or a Hive shared library customization to the Microsoft Azure HDInsight cluster configuration. - - - - Add-AzureRmHDInsightConfigValues - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - - Core - - The Core Site configurations of this HDInsight cluster. - - Hashtable - - - HiveSite - - The Hive Site configurations of this HDInsight cluster. - - Hashtable - - - HiveEnv - - The Hive Env configurations of this HDInsight cluster. - - Hashtable - - - OozieSite - - The Oozie Site configurations of this HDInsight cluster. - - Hashtable - - - OozieEnv - - The Oozie Env configurations of this HDInsight cluster. - - Hashtable - - - WebHCat - - The WebHCat Site configurations of this HDInsight cluster. - - Hashtable - - - HBaseSite - - The HBase Site configurations of this HDInsight cluster. - - Hashtable - - - HBaseEnv - - The HBase Env configurations of this HDInsight cluster. - - Hashtable - - - Storm - - The Storm Site configurations of this HDInsight cluster. - - Hashtable - - - Yarn - - The Yarn Site configurations of this HDInsight cluster. - - Hashtable - - - MapRed - - The MapRed Site configurations of this HDInsight cluster. - - Hashtable - - - Tez - - The Tez Site configurations of this HDInsight cluster. - - Hashtable - - - Hdfs - - The Hdfs Site configurations of this HDInsight cluster. - - Hashtable - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - AzureHDInsightConfig - - - - - - Core - - The Core Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - HiveSite - - The Hive Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - HiveEnv - - The Hive Env configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - OozieSite - - The Oozie Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - OozieEnv - - The Oozie Env configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - WebHCat - - The WebHCat Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - HBaseSite - - The HBase Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - HBaseEnv - - The HBase Env configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - Storm - - The Storm Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - Yarn - - The Yarn Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - MapRed - - The MapRed Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - Tez - - The Tez Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - Hdfs - - The Hdfs Site configurations of this HDInsight cluster. - - Hashtable - - Hashtable - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Add-AzureRmHDInsightMetastore - - Adds a SQL Database account to the Microsoft Azure HDInsight cluster configuration. - - - - - Add - AzureRmHDInsightMetastore - - - - Adds a SQL Database to the HDInsight configuration created by the New-AzureRmHDInsightClusterConfig cmdlet. - - - - Add-AzureRmHDInsightMetastore - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - - MetastoreType - - The type of metastore. - - AzureHDInsightMetastoreType - - - SqlAzureServerName - - The Azure SQL Server instance to use for this metastore. - - String - - - DatabaseName - - The database on the Azure SQL Server instance to use for this metastore. - - String - - - Credential - - The user credentials to use for the Azure SQL Server database. - - PSCredential - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - AzureHDInsightConfig - - - - - - MetastoreType - - The type of metastore. - - AzureHDInsightMetastoreType - - AzureHDInsightMetastoreType - - - - - - SqlAzureServerName - - The Azure SQL Server instance to use for this metastore. - - String - - String - - - - - - DatabaseName - - The database on the Azure SQL Server instance to use for this metastore. - - String - - String - - - - - - Credential - - The user credentials to use for the Azure SQL Server database. - - PSCredential - - PSCredential - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Add-AzureRmHDInsightScriptAction - - Adds a SQL Database account to the Microsoft Azure HDInsight cluster configuration. - - - - - Add - AzureRmHDInsightScriptAction - - - - Adds a SQL Database account to the HDInsight configuration created by the New-AzureRmHDInsightClusterConfig cmdlet. - - - - Add-AzureRmHDInsightScriptAction - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - - NodeType - - The node on which to apply the action. - - ClusterNodeType - - - Uri - - The URI for the action. - - Uri - - - Name - - The name of the action. - - String - - - Parameters - - The parameters for the action. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - AzureHDInsightConfig - - - - - - NodeType - - The node on which to apply the action. - - ClusterNodeType - - ClusterNodeType - - - - - - Uri - - The URI for the action. - - Uri - - Uri - - - - - - Name - - The name of the action. - - String - - String - - - - - - Parameters - - The parameters for the action. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Add-AzureRmHDInsightStorage - - Adds a Microsoft Azure Blob Storage account entry to a target HDInsight configuration. - - - - - Add - AzureRmHDInsightStorage - - - - Adds a Microsoft Azure Blob Storage account entry to the HDInsight configuration created by the New-AzureRmHDInsightClusterConfig cmdlet. - - - - Add-AzureRmHDInsightStorage - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - - StorageAccountName - - The storage account name for the storage account to be added to the new cluster. - - String - - - StorageAccountKey - - The storage account key for the storage account to be added to the new cluster. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - AzureHDInsightConfig - - - - - - StorageAccountName - - The storage account name for the storage account to be added to the new cluster. - - String - - String - - - - - - StorageAccountKey - - The storage account key for the storage account to be added to the new cluster. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Get-AzureRmHDInsightCluster - - Retrieves and lists all of the Microsoft Azure HDInsight clusters associated with the current subscription or retrieves a specific named cluster. - - - - - Get - AzureRmHDInsightCluster - - - - Lists all Microsoft Azure HDInsight Service clusters for the current subscription. If the Name parameter is specified, only information for the cluster with that name is returned. - - - - Get-AzureRmHDInsightCluster - - ResourceGroupName - - The name of the resource group. - - String - - - ClusterName - - The name of the cluster. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Get-AzureRmHDInsightJob - - Retrieves the Azure HDInsight jobs from a cluster and lists them in reverse chronological order. - - - - - Get - AzureRmHDInsightJob - - - - Lists recent jobs for a specified cluster in reverse chronological order, the most recent at the top of the list. - - - - Get-AzureRmHDInsightJob - - ClusterName - - The name of the cluster. - - String - - - HttpCredential - - - - PSCredential - - - JobId - - The JobID of the jobDetails to stop. - - String - - - NumOfJobs - - The number of jobs to retrieve. - - Int32 - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - HttpCredential - - - - PSCredential - - PSCredential - - - - - - JobId - - The JobID of the jobDetails to stop. - - String - - String - - - - - - NumOfJobs - - The number of jobs to retrieve. - - Int32 - - Int32 - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - ClusterCredential - - The credentials with which to connect to the cluster. - - pscredential - - pscredential - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Get-AzureRmHDInsightJobOutput - - Retrieves the log output for a job from the storage account associated with a specified cluster. - - - - - Get - AzureRmHDInsightJobOutput - - - - Retrieves various types of job logs including Standard Output, Standard Error. - - - - Get-AzureRmHDInsightJobOutput - - ClusterName - - The name of the cluster. - - String - - - JobId - - The JobID of the jobDetails to stop. - - String - - - DefaultContainer - - The default container name. - - String - - - DefaultStorageAccountName - - The default storage account name. - - String - - - DefaultStorageAccountKey - - The default storage account key. - - String - - - HttpCredential - - - - PSCredential - - - ResourceGroupName - - The name of the resource group. - - String - - - DisplayOutputType - - - - JobDisplayOutputType - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - JobId - - The JobID of the jobDetails to stop. - - String - - String - - - - - - DefaultContainer - - The default container name. - - String - - String - - - - - - DefaultStorageAccountName - - The default storage account name. - - String - - String - - - - - - DefaultStorageAccountKey - - The default storage account key. - - String - - String - - - - - - HttpCredential - - - - PSCredential - - PSCredential - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - DisplayOutputType - - - - JobDisplayOutputType - - JobDisplayOutputType - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - ClusterCredential - - The credentials with which to connect to the cluster. - - pscredential - - pscredential - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Get-AzureRmHDInsightPersistedScriptAction - - Retrieves the Azure HDInsight persisted script actions and list them in chronological order. - - - - - Get - AzureRmHDInsightPersistedScriptAction - - - - List persisted script actions for a specified cluster in chronological order, the most recent one at the bottom of the list. If the optional script name parameter is empty or not specified, retrieve all persisted script actions. If the optional script name parameter is specified, return the script if it exists. - - - - Get-AzureRmHDInsightPersistedScriptAction - - ClusterName - - The name of the cluster. - - String - - - Name - - The name of the persisted script action. - - String - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - Name - - The name of the persisted script action. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Get-AzureRmHDInsightProperties - - Retrieves properties specific to a Microsoft Azure HDInsight service. - - - - - Get - AzureRmHDInsightProperties - - - - Retrieves properties specific to a Microsoft Azure HDInsight service, such as a list of available Azure regions, HDInsight cluster versions, and available compute capacity. - - - - Get-AzureRmHDInsightProperties - - Location - - The datacenter location for the cluster. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Location - - The datacenter location for the cluster. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Get-AzureRmHDInsightScriptActionHistory - - Retrieves the Azure HDInsight script action history and list them in reverse chronological order. - - - - - Get - AzureRmHDInsightScriptActionHistory - - - - List script action history for a specified cluster in chronological order, the most recent one at the top of the list. If the optional ScriptExecutionId parameter is empty or not specified, retrieve latest script executions from history. If the optional ScriptExecutionId parameter is specified, return the script's execution details with debug information. - - - - Get-AzureRmHDInsightScriptActionHistory - - ClusterName - - The name of the cluster. - - String - - - ScriptExecutionId - - The script execution id of the executed script. - - Nullable`1[Int64] - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - ScriptExecutionId - - The script execution id of the executed script. - - Nullable`1[Int64] - - Nullable`1[Int64] - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Grant-AzureRmHDInsightHttpServicesAccess - - Grants HTTP access to the cluster. - - - - - Grant - AzureRmHDInsightHttpServicesAccess - - - - Enables HTTP to access to the cluster using ODBC, Ambari, Oozie and web services. - - - - Grant-AzureRmHDInsightHttpServicesAccess - - ClusterName - - The name of the cluster. - - String - - - HttpCredential - - The login for the cluster's user. - - PSCredential - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - HttpCredential - - The login for the cluster's user. - - PSCredential - - PSCredential - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Grant-AzureRmHDInsightRdpServicesAccess - - Grants RDP access to the cluster. - - - - - Grant - AzureRmHDInsightRdpServicesAccess - - - - Enables RDP to access to the cluster. - - - - Grant-AzureRmHDInsightRdpServicesAccess - - ClusterName - - The name of the cluster. - - String - - - RdpCredential - - The credential for RDP access to the cluster. - - PSCredential - - - RdpAccessExpiry - - The expiry DateTime for RDP access on the cluster. - - DateTime - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - RdpCredential - - The credential for RDP access to the cluster. - - PSCredential - - PSCredential - - - - - - RdpAccessExpiry - - The expiry DateTime for RDP access on the cluster. - - DateTime - - DateTime - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Invoke-AzureRmHDInsightHiveJob - - - - - - - Invoke - AzureRmHDInsightHiveJob - - - - - - - - Invoke-AzureRmHDInsightHiveJob - - Arguments - - - - String[] - - - Files - - - - String[] - - - StatusFolder - - - - String - - - Defines - - - - Hashtable - - - File - - - - String - - - JobName - - - - String - - - Query - - - - String - - - RunAsFileJob - - - - SwitchParameter - - - DefaultContainer - - - - String - - - DefaultStorageAccountName - - - - String - - - DefaultStorageAccountKey - - - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Arguments - - - - String[] - - String[] - - - - - - Files - - - - String[] - - String[] - - - - - - StatusFolder - - - - String - - String - - - - - - Defines - - - - Hashtable - - Hashtable - - - - - - File - - - - String - - String - - - - - - JobName - - - - String - - String - - - - - - Query - - - - String - - String - - - - - - RunAsFileJob - - - - SwitchParameter - - SwitchParameter - - - - - - DefaultContainer - - - - String - - String - - - - - - DefaultStorageAccountName - - - - String - - String - - - - - - DefaultStorageAccountKey - - - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - New-AzureRmHDInsightCluster - - Creates a new Microsoft Azure HDInsight cluster for the current subscription. - - - - - New - AzureRmHDInsightCluster - - - - Creates a new Microsoft Azure HDInsight cluster using the specified parameters or configuration created using the New-AzureRmHDInsightClusterConfig cmdlet. - - - - New-AzureRmHDInsightCluster - - Location - - The datacenter location for the cluster. - - String - - - ResourceGroupName - - The name of the resource group. - - String - - - ClusterName - - The name of the cluster. - - String - - - ClusterSizeInNodes - - The number of workernodes for the cluster. - - Int32 - - - HttpCredential - - The login for the cluster's user. - - PSCredential - - - DefaultStorageAccountName - - The StorageName for the default Azure Storage Account. - - String - - - DefaultStorageAccountKey - - The StorageKey for the default Azure Storage Account. - - String - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - - OozieMetastore - - The database to store the metadata for Oozie. - - AzureHDInsightMetastore - - - HiveMetastore - - The database to store the metadata for Hive. - - AzureHDInsightMetastore - - - AdditionalStorageAccounts - - The additional Azure Storage Account that you want to enable access to. - - Dictionary`2[String] - - - Configurations - - The configurations of this HDInsight cluster. - - Dictionary`2[Dictionary`2] - - - ScriptActions - - The config actions for the cluster. - - Dictionary`2[List`1] - - - DefaultStorageContainer - - The Storage Container for the default Azure Storage Account. - - String - - - Version - - The version of the HDInsight cluster. - - String - - - HeadNodeSize - - The size of the Head Node. - - String - - - WorkerNodeSize - - The size of the Data Node. - - String - - - ZookeeperNodeSize - - The size of the Zookeeper Node. - - String - - - ClusterType - - The flavor for a cluster. - - String - - - ClusterTier - - 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. - - Tier - - - VirtualNetworkId - - The virtual network guid for this HDInsight cluster. - - String - - - SubnetName - - The subnet name for this HDInsight cluster. - - String - - - OSType - - The type of operating system installed on cluster nodes. - - OSType - - - SshCredential - - The SSH credential. - - PSCredential - - - SshPublicKey - - The public key to be used for SSH. - - String - - - RdpCredential - - The credential for RDP access to the cluster. - - PSCredential - - - RdpAccessExpiry - - The expiry DateTime for RDP access on the cluster. - - DateTime - - - ObjectId - - The Service Principal Object Id for accessing Azure Data Lake. - - Guid - - - CertificateFilePath - - The Service Principal certificate for accessing Azure Data Lake. - - String - - - CertificatePassword - - The Service Principal certificate password for accessing Azure Data Lake. - - String - - - AadTenantId - - The Service Principal AAD Tenant Id for accessing Azure Data Lake. - - Guid - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Location - - The datacenter location for the cluster. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - ClusterSizeInNodes - - The number of workernodes for the cluster. - - Int32 - - Int32 - - - - - - HttpCredential - - The login for the cluster's user. - - PSCredential - - PSCredential - - - - - - DefaultStorageAccountName - - The StorageName for the default Azure Storage Account. - - String - - String - - - - - - DefaultStorageAccountKey - - The StorageKey for the default Azure Storage Account. - - String - - String - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - AzureHDInsightConfig - - - - - - OozieMetastore - - The database to store the metadata for Oozie. - - AzureHDInsightMetastore - - AzureHDInsightMetastore - - - - - - HiveMetastore - - The database to store the metadata for Hive. - - AzureHDInsightMetastore - - AzureHDInsightMetastore - - - - - - AdditionalStorageAccounts - - The additional Azure Storage Account that you want to enable access to. - - Dictionary`2[String] - - Dictionary`2[String] - - - - - - Configurations - - The configurations of this HDInsight cluster. - - Dictionary`2[Dictionary`2] - - Dictionary`2[Dictionary`2] - - - - - - ScriptActions - - The config actions for the cluster. - - Dictionary`2[List`1] - - Dictionary`2[List`1] - - - - - - DefaultStorageContainer - - The Storage Container for the default Azure Storage Account. - - String - - String - - - - - - Version - - The version of the HDInsight cluster. - - String - - String - - - - - - HeadNodeSize - - The size of the Head Node. - - String - - String - - - - - - WorkerNodeSize - - The size of the Data Node. - - String - - String - - - - - - ZookeeperNodeSize - - The size of the Zookeeper Node. - - String - - String - - - - - - ClusterType - - The flavor for a cluster. - - String - - String - - - - - - ClusterTier - - 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. - - Tier - - - VirtualNetworkId - - The virtual network guid for this HDInsight cluster. - - String - - String - - - - - - SubnetName - - The subnet name for this HDInsight cluster. - - String - - String - - - - - - OSType - - The type of operating system installed on cluster nodes. - - OSType - - OSType - - - - - - SshCredential - - The SSH credential. - - PSCredential - - PSCredential - - - - - - SshPublicKey - - The public key to be used for SSH. - - String - - String - - - - - - RdpCredential - - The credential for RDP access to the cluster. - - PSCredential - - PSCredential - - - - - - RdpAccessExpiry - - The expiry DateTime for RDP access on the cluster. - - DateTime - - DateTime - - - - - - ObjectId - - - - Guid - - Guid - - - - - - CertificateFilePath - - - - String - - String - - - - - - CertificatePassword - - - - String - - String - - - - - - AadTenantId - - - - Guid - - Guid - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - New-AzureRmHDInsightClusterConfig - - Creates a non-persisted configuration that describes a Microsoft Azure HDInsight cluster configuration. - - - - - New - AzureRmHDInsightClusterConfig - - - - Creates a non-persisted configuration that describes a Microsoft Azure HDInsight cluster configuration. - - - - New-AzureRmHDInsightClusterConfig - - DefaultStorageAccountName - - The StorageName for the default Azure Storage Account. - - String - - - DefaultStorageAccountKey - - The StorageKey for the default Azure Storage Account. - - String - - - OozieMetastore - - The database to store the metadata for Oozie. - - AzureHDInsightMetastore - - - HiveMetastore - - The database to store the metadata for Hive. - - AzureHDInsightMetastore - - - HeadNodeSize - - The size of the Head Node. - - String - - - WorkerNodeSize - - The size of the Data Node. - - String - - - ZookeeperNodeSize - - The size of the Zookeeper Node. - - String - - - ClusterType - - The flavor for a cluster. - - String - - - ClusterTier - - 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. - - Tier - - - ObjectId - - - - Guid - - - CertificateFilePath - - - - String - - - CertificatePassword - - - - String - - - AadTenantId - - - - Guid - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - DefaultStorageAccountName - - The StorageName for the default Azure Storage Account. - - String - - String - - - - - - DefaultStorageAccountKey - - The StorageKey for the default Azure Storage Account. - - String - - String - - - - - - OozieMetastore - - The database to store the metadata for Oozie. - - AzureHDInsightMetastore - - AzureHDInsightMetastore - - - - - - HiveMetastore - - The database to store the metadata for Hive. - - AzureHDInsightMetastore - - AzureHDInsightMetastore - - - - - - HeadNodeSize - - The size of the Head Node. - - String - - String - - - - - - WorkerNodeSize - - The size of the Data Node. - - String - - String - - - - - - ZookeeperNodeSize - - The size of the Zookeeper Node. - - String - - String - - - - - - ClusterType - - The flavor for a cluster. - - String - - String - - - - - - ClusterTier - - 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. - - Tier - - - ObjectId - - - - Guid - - Guid - - - - - - CertificateFilePath - - - - String - - String - - - - - - CertificatePassword - - - - String - - String - - - - - - AadTenantId - - - - Guid - - Guid - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - New-AzureRmHDInsightHiveJobDefinition - - Defines a new Hive job. - - - - - New - AzureRmHDInsightHiveJobDefinition - - - - Defines a new Hive job. - - - - New-AzureRmHDInsightHiveJobDefinition - - Arguments - - The hive arguments for the jobDetails. - - String[] - - - Files - - The files for the jobDetails. - - String[] - - - StatusFolder - - The output location to use for the job. - - String - - - Defines - - The parameters for the jobDetails. - - Hashtable - - - File - - The query file to run in the jobDetails. - - String - - - JobName - - The name of the jobDetails. - - String - - - Query - - The query to run in the jobDetails. - - String - - - RunAsFileJob - - Run the query as a file. - - SwitchParameter - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Arguments - - The hive arguments for the jobDetails. - - String[] - - String[] - - - - - - Files - - The files for the jobDetails. - - String[] - - String[] - - - - - - StatusFolder - - The output location to use for the job. - - String - - String - - - - - - Defines - - The parameters for the jobDetails. - - Hashtable - - Hashtable - - - - - - File - - The query file to run in the jobDetails. - - String - - String - - - - - - JobName - - The name of the jobDetails. - - String - - String - - - - - - Query - - The query to run in the jobDetails. - - String - - String - - - - - - RunAsFileJob - - Run the query as a file. - - SwitchParameter - - SwitchParameter - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - New-AzureRmHDInsightMapReduceJobDefinition - - Defines a new Map Reduce job. - - - - - New - AzureRmHDInsightMapReduceJobDefinition - - - - Defines a new Map Reduce job. - - - - New-AzureRmHDInsightMapReduceJobDefinition - - Arguments - - The hive arguments for the jobDetails. - - String[] - - - Files - - The files for the jobDetails. - - String[] - - - StatusFolder - - The output location to use for the job. - - String - - - ClassName - - The class name to use for the jobDetails. - - String - - - Defines - - The parameters for the jobDetails. - - Hashtable - - - JarFile - - The jar file to use for the jobDetails. - - String - - - JobName - - The name of the jobDetails. - - String - - - LibJars - - The lib jars for the jobDetails. - - String[] - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Arguments - - The hive arguments for the jobDetails. - - String[] - - String[] - - - - - - Files - - The files for the jobDetails. - - String[] - - String[] - - - - - - StatusFolder - - The output location to use for the job. - - String - - String - - - - - - ClassName - - The class name to use for the jobDetails. - - String - - String - - - - - - Defines - - The parameters for the jobDetails. - - Hashtable - - Hashtable - - - - - - JarFile - - The jar file to use for the jobDetails. - - String - - String - - - - - - JobName - - The name of the jobDetails. - - String - - String - - - - - - LibJars - - The lib jars for the jobDetails. - - String[] - - String[] - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - New-AzureRmHDInsightPigJobDefinition - - Defines a new Pig job. - - - - - New - AzureRmHDInsightPigJobDefinition - - - - Defines a new Pig job. - - - - New-AzureRmHDInsightPigJobDefinition - - Arguments - - The hive arguments for the jobDetails. - - String[] - - - Files - - The files for the jobDetails. - - String[] - - - StatusFolder - - The output location to use for the job. - - String - - - File - - The query file to run in the jobDetails. - - String - - - Query - - The query to run in the jobDetails. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Arguments - - The hive arguments for the jobDetails. - - String[] - - String[] - - - - - - Files - - The files for the jobDetails. - - String[] - - String[] - - - - - - StatusFolder - - The output location to use for the job. - - String - - String - - - - - - File - - The query file to run in the jobDetails. - - String - - String - - - - - - Query - - The query to run in the jobDetails. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - New-AzureRmHDInsightSqoopJobDefinition - - Defines a new Sqoop job. - - - - - New - AzureRmHDInsightSqoopJobDefinition - - - - - - - - New-AzureRmHDInsightSqoopJobDefinition - - Files - - - - String[] - - - StatusFolder - - - - String - - - File - - - - String - - - Command - - - - String - - - LibDir - - - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Files - - - - String[] - - String[] - - - - - - StatusFolder - - - - String - - String - - - - - - File - - - - String - - String - - - - - - Command - - - - String - - String - - - - - - LibDir - - - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - New-AzureRmHDInsightStreamingMapReduceJobDefinition - - Defines a new Streaming Map Reduce job. - - - - - New - AzureRmHDInsightStreamingMapReduceJobDefinition - - - - Defines a new Streaming Map Reduce job. - - - - New-AzureRmHDInsightStreamingMapReduceJobDefinition - - Arguments - - The hive arguments for the jobDetails. - - String[] - - - File - - The file for the jobDetails. - - String - - - StatusFolder - - The output location to use for the job. - - String - - - CommandEnvironment - - The command line environment for the mappers or the reducers. - - Hashtable - - - Defines - - The parameters for the jobDetails. - - Hashtable - - - InputPath - - The input path to use for the jobDetails. - - String - - - Mapper - - The Mapper to use for the jobDetails. - - String - - - OutputPath - - The output path to use for the jobDetails. - - String - - - Reducer - - The Reducer to use for the jobDetails. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Arguments - - The hive arguments for the jobDetails. - - String[] - - String[] - - - - - - File - - The file for the jobDetails. - - String - - String - - - - - - StatusFolder - - The output location to use for the job. - - String - - String - - - - - - CommandEnvironment - - The command line environment for the mappers or the reducers. - - Hashtable - - String[] - - - - - - Defines - - The parameters for the jobDetails. - - Hashtable - - Hashtable - - - - - - InputPath - - The input path to use for the jobDetails. - - String - - String - - - - - - Mapper - - The Mapper to use for the jobDetails. - - String - - String - - - - - - OutputPath - - The output path to use for the jobDetails. - - String - - String - - - - - - Reducer - - The Reducer to use for the jobDetails. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Remove-AzureRmHDInsightCluster - - Deletes the specified HDInsight cluster from your Microsoft Azure subscription. - - - - - Remove - AzureRmHDInsightCluster - - - - Deletes the specified HDInsight Service cluster. This will also delete any data stored in HDFS on the cluster. - - - - Remove-AzureRmHDInsightCluster - - ClusterName - - The name of the cluster. - - String - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Remove-AzureRmHDInsightPersistedScriptAction - - Remove an Azure HDInsight persisted script action. - - - - - Remove - AzureRmHDInsightPersistedScriptAction - - - - Remove an Azure HDInsight persisted script action from a specified cluster's persisted scripts. The removed script will no longer be executed when the cluster is scaled up. - - - - Remove-AzureRmHDInsightPersistedScriptAction - - ClusterName - - The name of the cluster. - - String - - - Name - - The name of the script to be removed. - - String - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - Name - - The name of the script to be removed. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Revoke-AzureRmHDInsightHttpServicesAccess - - Disables HTTP access to the cluster. - - - - - Revoke - AzureRmHDInsightHttpServicesAccess - - - - Disables HTTP access to the cluster for ODBC, Ambari, Oozie and webHCatalog web services. - - - - Revoke-AzureRmHDInsightHttpServicesAccess - - ClusterName - - The name of the cluster. - - String - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Revoke-AzureRmHDInsightRdpServicesAccess - - Disables RDP access to the cluster. - - - - - Revoke - AzureRmHDInsightRdpServicesAccess - - - - Disables RDP access to the cluster. - - - - Revoke-AzureRmHDInsightRdpServicesAccess - - ClusterName - - The name of the cluster. - - String - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Set-AzureRmHDInsightClusterSize - - Sets the size of the specified cluster to the requested size. - - - - - Set - AzureRmHDInsightClusterSize - - - - Sets the size of the specified cluster to the requested size. - - - - Set-AzureRmHDInsightClusterSize - - ClusterName - - The name of the cluster. - - String - - - TargetInstanceCount - - The name of the cluster. - - Int32 - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - TargetInstanceCount - - The name of the cluster. - - Int32 - - Int32 - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Set-AzureRmHDInsightDefaultStorage - - Sets default storage account setting in the HDInsight cluster configuration object. - - - - - Set - AzureRmHDInsightDefaultStorage - - - - Sets default storage account setting in the HDInsight cluster configuration object. - - - - Set-AzureRmHDInsightDefaultStorage - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - - StorageAccountName - - The storage account name for the storage account to be added to the new cluster. - - String - - - StorageAccountKey - - The storage account key for the storage account to be added to the new cluster. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - AzureHDInsightConfig - - AzureHDInsightConfig - - - - - - StorageAccountName - - The storage account name for the storage account to be added to the new cluster. - - String - - String - - - - - - StorageAccountKey - - The storage account key for the storage account to be added to the new cluster. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Set-AzureRmHDInsightPersistedScriptAction - - Promote an Azure HDInsight script action to be a persisted script. - - - - - Set - AzureRmHDInsightPersistedScriptAction - - - - Promote an Azure HDInsight script action from execution history to become a persisted script. - - - - Set-AzureRmHDInsightPersistedScriptAction - - ClusterName - - The name of the cluster. - - String - - - ScriptExecutionId - - The execution id of the promoted script. - - Int64 - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - ScriptExecutionId - - The execution id of the promoted script. - - Int64 - - Int64 - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Start-AzureRmHDInsightJob - - Starts an Azure HDInsight job on a specified cluster. - - - - - Start - AzureRmHDInsightJob - - - - Starts a defined Azure HDInsight job on a specified cluster. This can be a MapReduce job, a streaming job, a Hive job, or a Pig job. - - - - Start-AzureRmHDInsightJob - - ClusterName - - The name of the cluster. - - String - - - JobDefinition - - The jobDetails definition to start on the Azure HDInsight cluster. - - AzureHDInsightJobDefinition - - - HttpCredential - - - - PSCredential - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - JobDefinition - - The jobDetails definition to start on the Azure HDInsight cluster. - - AzureHDInsightJobDefinition - - AzureHDInsightJobDefinition - - - - - - HttpCredential - - - - PSCredential - - PSCredential - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - ClusterCredential - - The credentials with which to connect to the cluster. - - pscredential - - pscredential - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Stop-AzureRmHDInsightJob - - Stops running an Azure HDInsight job on a specified cluster. - - - - - Stop - AzureRmHDInsightJob - - - - Stops running Azure HDInsight job on a specified cluster. - - - - Stop-AzureRmHDInsightJob - - ClusterName - - The name of the cluster. - - String - - - JobId - - The JobID of the jobDetails to stop. - - String - - - HttpCredential - - - - PSCredential - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - JobId - - The JobID of the jobDetails to stop. - - String - - String - - - - - - HttpCredential - - - - PSCredential - - PSCredential - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - ClusterCredential - - The credentials with which to connect to the cluster. - - pscredential - - pscredential - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Submit-AzureRmHDInsightScriptAction - - Submit an Azure HDInsight script action. - - - - - Submit - AzureRmHDInsightScriptAction - - - - Submit an Azure HDInsight script action to a specified cluster. When PersistOnSuccess is specified, the script will be persisted if it successfully executes on the cluster. Persisted scripts are executed when the cluster is scaled up. - - - - Submit-AzureRmHDInsightScriptAction - - ClusterName - - The name of the cluster. - - String - - - Name - - The name of the script action. - - String - - - Uri - - The URI of the script action. - - Uri - - - NodeTypes - - The nodes on which to apply the script action. - - ClusterNodeType[] - - - Parameters - - The parameters of the script action. - - String - - - PersistOnSuccess - - When PersistOnSuccess is specified, the script action will be persisted if it successfully executes on the cluster. - - SwitchParameter - - - ResourceGroupName - - The name of the resource group - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - Name - - The name of the script action. - - String - - String - - - - - - Uri - - The URI of the script action. - - Uri - - Uri - - - - - - NodeTypes - - The nodes on which to apply the script action. - - ClusterNodeType[] - - ClusterNodeType[] - - - - - - Parameters - - The parameters of the script action. - - String - - String - - - - - - PersistOnSuccess - - When PersistOnSuccess is specified, the script action will be persisted if it successfully executes on the cluster. - - SwitchParameter - - SwitchParameter - - - - - - ResourceGroupName - - The name of the resource group - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Use-AzureRmHDInsightCluster - - Selects Azure HDInsight cluster that will be used by the Invoke-Hive cmdlet for job submission. - - - - - Use - AzureRmHDInsightCluster - - - - Selects Azure HDInsight cluster that will be used by Invoke-Hive cmdlet for job submission. - - - - Use-AzureRmHDInsightCluster - - ClusterName - - The name of the cluster. - - String - - - HttpCredential - - - - PSCredential - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - HttpCredential - - - - PSCredential - - PSCredential - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - ClusterCredential - - The credentials with which to connect to the cluster. - - pscredential - - pscredential - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Wait-AzureRmHDInsightJob - - Awaits the completion or failure of the HDInsight job and shows its progress. - - - - - Wait - AzureRmHDInsightJob - - - - Awaits the completion or failure of the HDInsight job and shows its progress. - - - - Wait-AzureRmHDInsightJob - - ClusterName - - The name of the cluster. - - String - - - JobId - - The JobID of the jobDetails to stop. - - String - - - HttpCredential - - - - PSCredential - - - ResourceGroupName - - The name of the resource group. - - String - - - InformationAction - - - - ActionPreference - - - InformationVariable - - - - String - - - - - - ClusterName - - The name of the cluster. - - String - - String - - - - - - JobId - - The JobID of the jobDetails to stop. - - String - - String - - - - - - HttpCredential - - - - PSCredential - - PSCredential - - - - - - ResourceGroupName - - The name of the resource group. - - String - - String - - - - - - InformationAction - - - - ActionPreference - - ActionPreference - - - - - - InformationVariable - - - - String - - String - - - - - - ClusterCredential - - The credentials with which to connect to the cluster. - - pscredential - - pscredential - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Add-AzureRmHDInsightClusterIdentity - - Adds a cluster identity to the Microsoft Azure HDInsight cluster configuration. - - - - - - - - - - Adds a cluster identity to the Microsoft Azure HDInsight cluster configuration. - - - - - - Config - - The HDInsight cluster configuration to use when creating the new cluster. - - azurehdinsightconfig - - azurehdinsightconfig - - - - - - ObjectId - - The Service Principal Object Id for accessing Azure Data Lake. - - guid - - guid - - - - - - CertificateFilePath - - The Service Principal certificate for accessing Azure Data Lake. - - string - - string - - - - - - CertificatePassword - - The Service Principal certificate password for accessing Azure Data Lake. - - string - - string - - - - - - AadTenantId - - The Service Principal AAD Tenant Id for accessing Azure Data Lake. - - guid - - guid - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - - - - Invoke-Hive - - Submits Hive queries to the HDInsight cluster, shows progress of the query execution, and retrieves query results in one operation. - - - - - - - - - - Submits Hive queries to the HDInsight cluster, shows progress of the query execution, and retrieves query results in one operation. The Use-AzureRmHDInsightCluster cmdlet needs to be used before calling Invoke-Hive to specify which HDInsight cluster the query will be submitted to. - - - - - - Arguments - - The hive arguments for the jobDetails. - - string[] - - string[] - - - - - - Files - - The files for the jobDetails. - - string[] - - string[] - - - - - - StatusFolder - - The output location to use for the job. - - string - - string - - - - - - Defines - - The parameters for the jobDetails. - - hashtable - - hashtable - - - - - - File - - The query file to run in the jobDetails. - - string - - string - - - - - - JobName - - The name of the jobDetails. - - string - - string - - - - - - Query - - The query to run in the jobDetails. - - string - - string - - - - - - RunAsFileJob - - Run the query as a file. - - switchparameter - - switchparameter - - - - - - DefaultContainer - - The default container name. - - string - - string - - - - - - DefaultStorageAccountName - - The default storage account name. - - string - - string - - - - - - DefaultStorageAccountKey - - The default storage account key. - - string - - string - - - - - - Profile - - - - azureprofile - - azureprofile - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight - - - - - - - - + + + + + Add-AzureRmHDInsightClusterIdentity + + Adds a cluster identity to a cluster configuration object. + + + + + Add + AzureRmHDInsightClusterIdentity + + + + The Add-AzureRmHDInsightClusterIdentity cmdlet adds a cluster identity to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. + + + + Add-AzureRmHDInsightClusterIdentity + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + + ObjectId + + 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. + + Guid + + + CertificateFilePath + + 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. + + String + + + CertificatePassword + + 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. + + String + + + AadTenantId + + Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + + Guid + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + AzureHDInsightConfig + + + + + + ObjectId + + 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. + + Guid + + Guid + + + + + + CertificateFilePath + + 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. + + String + + String + + + + + + CertificatePassword + + 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. + + String + + String + + + + + + AadTenantId + + Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + + Guid + + Guid + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Add Cluster Identity info to the cluster configuration object -------------------------- + + PS C:\> + + 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-hadoop-001" + $clusterCreds = Get-Credential + + # If the cluster's resource group doesn't exist yet, run: + # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location + + # Cluster Identity values + $tenantId = (Get-AzureRmContext).Tenant.TenantId + $objectId = "<Azure AD Service Principal Object ID>" + $certificateFilePath = "<Path to Azure AD Service Principal Certificate>" + $certificatePassword = "<Password for Azure AD Service Principal Certificate>" + + # Create the cluster + 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 + + This command adds Cluster Identity info to the cluster named 'your-hadoop-001', allowing the cluster to access Azure Data Lake Store. + + + + + + + + + + + + + + + + + + + + Add-AzureRmHDInsightConfigValues + + Adds a Hadoop configuration value customization and/or a Hive shared library customization to a cluster configuration object. + + + + + Add + AzureRmHDInsightConfigValues + + + + 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. + + + + Add-AzureRmHDInsightConfigValues + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + + Core + + Specifies the Core Site configurations of this HDInsight cluster. + + Hashtable + + + HiveSite + + Specifies the Hive Site configurations of this HDInsight cluster. + + Hashtable + + + HiveEnv + + Specifies the Hive Env configurations of this HDInsight cluster. + + Hashtable + + + OozieSite + + Specifies the Oozie Site configurations of this HDInsight cluster. + + Hashtable + + + OozieEnv + + Specifies the Oozie Env configurations of this HDInsight cluster. + + Hashtable + + + WebHCat + + Specifies the WebHCat Site configurations of this HDInsight cluster. + + Hashtable + + + HBaseSite + + Specifies the HBase Site configurations of this HDInsight cluster. + + Hashtable + + + HBaseEnv + + Specifies the HBase Env configurations of this HDInsight cluster. + + Hashtable + + + Storm + + Specifies the Storm Site configurations of this HDInsight cluster. + + Hashtable + + + Yarn + + Specifies the YARN Site configurations of this HDInsight cluster. + + Hashtable + + + MapRed + + Specifies the MapRed Site configurations of this HDInsight cluster. + + Hashtable + + + Tez + + Specifies the Tez Site configurations of this HDInsight cluster. + + Hashtable + + + Hdfs + + Specifies the HDFS configurations of this HDInsight cluster. + + Hashtable + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + AzureHDInsightConfig + + + + + + Core + + Specifies the Core Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + HiveSite + + Specifies the Hive Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + HiveEnv + + Specifies the Hive Env configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + OozieSite + + Specifies the Oozie Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + OozieEnv + + Specifies the Oozie Env configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + WebHCat + + Specifies the WebHCat Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + HBaseSite + + Specifies the HBase Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + HBaseEnv + + Specifies the HBase Env configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + Storm + + Specifies the Storm Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + Yarn + + Specifies the YARN Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + MapRed + + Specifies the MapRed Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + Tez + + Specifies the Tez Site configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + Hdfs + + Specifies the HDFS configurations of this HDInsight cluster. + + Hashtable + + Hashtable + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Add a custom configuration value to the cluster configuration object -------------------------- + + PS C:\> + + 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-hadoop-001" + $clusterCreds = Get-Credential + + # If the cluster's resource group doesn't exist yet, run: + # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location + + # Config values + $coreConfigs = @{"io.file.buffer.size"="300000"} + $mapRedConfigs = @{"mapred.map.max.attempts"="2"} + + # Create the cluster + 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 + + This command adds a Hadoop configuration value to the cluster named 'your-hadoop-001'. + + + + + + + + + + + + + + + + New-AzureRmHDInsightClusterConfig + + + + + + + + Add-AzureRmHDInsightMetastore + + Adds a SQL Database to serve as a Hive or Oozie metastore to a cluster configuration object. + + + + + Add + AzureRmHDInsightMetastore + + + + 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. + + + + Add-AzureRmHDInsightMetastore + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + + MetastoreType + + Specifies the type of metastore. Possible values are HiveMetastore or OozieMetastore. + + AzureHDInsightMetastoreType + + + SqlAzureServerName + + Specifies the Azure SQL Server instance to use for this metastore. + + String + + + DatabaseName + + Specifies the database on the Azure SQL Server instance to use for this metastore. + + String + + + Credential + + Specifies the credentials to use for the Azure SQL Server database. + + PSCredential + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + AzureHDInsightConfig + + + + + + MetastoreType + + Specifies the type of metastore. Possible values are HiveMetastore or OozieMetastore. + + AzureHDInsightMetastoreType + + AzureHDInsightMetastoreType + + + + + + SqlAzureServerName + + Specifies the Azure SQL Server instance to use for this metastore. + + String + + String + + + + + + DatabaseName + + Specifies the database on the Azure SQL Server instance to use for this metastore. + + String + + String + + + + + + Credential + + Specifies the credentials to use for the Azure SQL Server database. + + PSCredential + + PSCredential + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Add a SQL database metastore to the cluster configuration object. -------------------------- + + PS C:\> + + 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-hadoop-001" + $clusterCreds = Get-Credential + + # If the cluster's resource group doesn't exist yet, run: + # New-AzureRMResourceGroup -Name $clusterResourceGroupName -Location $location + + # Hive metastore info + $hiveSqlServer = "your-sqlserver-001" + $hiveDb = "your-sqldb-001" + $hiveCreds = Get-Credential + + # Oozie metastore info + $oozieSqlServer = "your-sqlserver-001" + $oozieDb = "your-sqldb-002" + $oozieCreds = Get-Credential + + # Create the cluster + 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 + + This command adds a SQL database metastore to the cluster named 'your-hadoop-001'. + + + + + + + + + + + + + + + + + + + + Add-AzureRmHDInsightScriptAction + + Adds a script action to a cluster configuration object. + + + + + Add + AzureRmHDInsightScriptAction + + + + The Add-AzureRmHDInsightScriptAction cmdlet adds script actions to the HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. + 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). + 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. + + + + Add-AzureRmHDInsightScriptAction + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + + NodeType + + Specifies the node type on which to run the script action. + + ClusterNodeType + + + Uri + + Specifies the public URI for the script action (a PowerShell or Bash script). + + Uri + + + Name + + Specifies the name of the script action. + + String + + + Parameters + + Specifies the parameters for the script action. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + AzureHDInsightConfig + + + + + + NodeType + + Specifies the node type on which to run the script action. + + ClusterNodeType + + ClusterNodeType + + + + + + Uri + + Specifies the public URI for the script action (a PowerShell or Bash script). + + Uri + + Uri + + + + + + Name + + Specifies the name of the script action. + + String + + String + + + + + + Parameters + + Specifies the parameters for the script action. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Add a script action to the cluster configuration object. -------------------------- + + PS C:\> + + PS C:\> # Primary storage account info + $storageAccountResourceGroupName = "Group" + $storageAccountName = "yourstorageacct001" + $storageAccountKey = Get-AzureStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | %{ $_.Key1 } + $storageContainer = "container001" + + # Script action info + $scriptActionName = "&lt;script action name&gt;" + $scriptActionURI = "&lt;script action URI&gt;" + $scriptActionParameters = "&lt;script action parameters&gt;" + + # Cluster configuration info + $location = "East US 2" + $clusterResourceGroupName = "Group" + $clusterName = "your-hadoop-001" + $clusterCreds = 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-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 + + 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. + + + + + + + + + + + + + + + + + + + + Add-AzureRmHDInsightStorage + + Adds an Azure Storage key to a cluster configuration object. + + + + + Add + AzureRmHDInsightStorage + + + + The Add-AzureRmHDInsightStorage cmdlet adds an Azure Storage account entry to the Azure HDInsight configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. + + + + Add-AzureRmHDInsightStorage + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + + StorageAccountName + + Specifies the storage account name for the storage account to be added to the cluster. + + String + + + StorageAccountKey + + Specifies the storage account key for the storage account to be added to the new cluster. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + AzureHDInsightConfig + + + + + + StorageAccountName + + Specifies the storage account name for the storage account to be added to the cluster. + + String + + String + + + + + + StorageAccountKey + + Specifies the storage account key for the storage account to be added to the new cluster. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Add an Azure storage key to the cluster configuration object. -------------------------- + + PS C:\> + + 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-hadoop-001" + $clusterCreds = Get-Credential + + # If the cluster's resource group doesn't exist yet, run: + # New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location + + # Second storage account info + $secondStorageAccountResourceGroupName = "Group" + $secondStorageAccountName = "yourstorageacct002" + $secondStorageAccountKey = Get-AzureStorageAccountKey ` + -ResourceGroupName $secondStorageAccountResourceGroupName ` + -Name $secondStorageAccountName | %{ $_.Key1 } + + # Create the cluster + 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 + + This command adds an blob storage account entry to the HDInsight configuration named 'your-hadoop-001'. + + + + + + + + + + + + + + + + + + + + Get-AzureRmHDInsightCluster + + Gets and lists all of the Azure HDInsight clusters associated with the current subscription or a specified resource group, or retrieves a specific cluster. + + + + + Get + AzureRmHDInsightCluster + + + + 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. + + + + Get-AzureRmHDInsightCluster + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + ClusterName + + Specifies the name of the cluster. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: List all Azure HDInsight clusters -------------------------- + + PS C:\> + + PS C:\> Get-AzureHDInsightCluster + + This command lists all the Azure HDInsight clusters. + + + + + + + + + + + + + + + + + + + + Get-AzureRmHDInsightJob + + Gets the list of jobs from a cluster and lists them in reverse chronological order, or retrieves a specific job. + + + + + Get + AzureRmHDInsightJob + + + + 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. + + + + Get-AzureRmHDInsightJob + + ClusterName + + Specifies the name of the cluster. + + String + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + JobId + + Specifies the job ID of the jobDetails to stop. + + String + + + NumOfJobs + + Specifies the number of jobs to retrieve. + + Int32 + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + JobId + + Specifies the job ID of the jobDetails to stop. + + String + + String + + + + + + NumOfJobs + + Specifies the number of jobs to retrieve. + + Int32 + + Int32 + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + ClusterCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + pscredential + + pscredential + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Get recent jobs for a specified Azure HDInsight cluster -------------------------- + + PS C:\> + + PS C:\&gt;# Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Hive job details + $statusFolder = "tempStatusFolder/" + $query = "SHOW TABLES" + + New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzureRmHDInsightJob -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + | Get-AzureRmHDInsightJob -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + This command gets all recent jobs for the cluster named 'your-hadoop-001'. + + + + + + + + + + + + + + + + Start-AzureRmHDInsightJob + + + + Stop-AzureRmHDInsightJob + + + + Wait-AzureRmHDInsightJob + + + + + + + + Get-AzureRmHDInsightJobOutput + + Gets the log output for a job from the storage account associated with a specified cluster. + + + + + Get + AzureRmHDInsightJobOutput + + + + The Get-AzureRmHDInsightJobOutput cmdlet gets the log output for a job from the storage account associated with an Azure HDInsight cluster. + + + + Get-AzureRmHDInsightJobOutput + + ClusterName + + Specifies the name of the cluster. + + String + + + JobId + + Specifies the job ID of the job whose output will be fetched. + + String + + + DefaultContainer + + Specifies the default container name. + + String + + + DefaultStorageAccountName + + Specifies the default storage account name. + + String + + + DefaultStorageAccountKey + + Specifies the default storage account key. + + String + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + DisplayOutputType + + Specifies the job output type being requested. Options are: StandardOutput, StandardError, TaskSummary + + JobDisplayOutputType + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + JobId + + Specifies the job ID of the job whose output will be fetched. + + String + + String + + + + + + DefaultContainer + + Specifies the default container name. + + String + + String + + + + + + DefaultStorageAccountName + + Specifies the default storage account name. + + String + + String + + + + + + DefaultStorageAccountKey + + Specifies the default storage account key. + + String + + String + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + DisplayOutputType + + Specifies the job output type being requested. Options are: StandardOutput, StandardError, TaskSummary + + JobDisplayOutputType + + JobDisplayOutputType + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + ClusterCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + pscredential + + pscredential + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Get the log output for a job -------------------------- + + PS C:\> + + PS C:\> # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Hive job details + $statusFolder = "<status folder>" + $query = "<query here>" + + New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzureRmHDInsightJob + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + | Get-AzureRmHDInsightJobOutput + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + This command gets the log output from the cluster named 'your-hadoop-001'. + + + + + + + + + + + + + + + + + + + + Get-AzureRmHDInsightPersistedScriptAction + + Gets the persisted script actions for a cluster and lists them in chronological order, or gets details for a specified persisted script action. + + + + + Get + AzureRmHDInsightPersistedScriptAction + + + + The Get-AzureRmHDInsightPersistedScriptAction parameter 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. + + + + Get-AzureRmHDInsightPersistedScriptAction + + ClusterName + + Specifies the name of the cluster. + + String + + + Name + + Specifies the name of the persisted script action. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + Name + + Specifies the name of the persisted script action. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Get the persisted script actions on a cluster -------------------------- + + PS C:\> + + PS C:\> Get-AzureRmHDInsightPersistedScriptAction -ClusterName "your-hadoop-001" + + + + + + + + + + + + + + + + + + + + + + Get-AzureRmHDInsightProperties + + Gets properties about the HDInsight service, such as available locations and capacity. + + + + + Get + AzureRmHDInsightProperties + + + + The Get-AzureRmHDInsightProperties cmdlet gets properties specific to Azure HDInsight, such as the list of available locations, HDInsight cluster versions, and available compute capacity. + + + + Get-AzureRmHDInsightProperties + + Location + + Specifies the location for which to fetch HDInsight properties. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Location + + Specifies the location for which to fetch HDInsight properties. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Get the properties of an Azure HDInsight cluster -------------------------- + + PS C:\> + + PS C:\&gt;Get-AzureRmHDInsightProperties -Location "East US 2" + + This command gets properties from an HDInsight service from location East US 2. + + + + + + + + + + + + + + + + + + + + Get-AzureRmHDInsightScriptActionHistory + + Gets the script action history for a cluster and lists it in reverse chronological order, or gets details of a previously executed script action. + + + + + Get + AzureRmHDInsightScriptActionHistory + + + + 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. + + + + Get-AzureRmHDInsightScriptActionHistory + + ClusterName + + Specifies the name of the cluster. + + String + + + ScriptExecutionId + + Specifies the execution id of the executed script action. + + Nullable`1[Int64] + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + ScriptExecutionId + + Specifies the execution id of the executed script action. + + Nullable`1[Int64] + + Nullable`1[Int64] + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Get the history of script actions executions for a cluster -------------------------- + + PS C:\> + + PS C:\> Get-AzureRmHDInsightScriptActionHistory -ClusterName "your-hadoop-001" + + + + + + + + + + + + + + + + + + + + + + Grant-AzureRmHDInsightHttpServicesAccess + + Grants HTTP access to the cluster. + + + + + Grant + AzureRmHDInsightHttpServicesAccess + + + + The Grant-AzureRmHDInsightHttpServicesAccess cmdlet grants HTTP access to an Azure HDInsight cluster using ODBC, Ambari, Oozie and web services. + + + + Grant-AzureRmHDInsightHttpServicesAccess + + ClusterName + + Specifies the name of the cluster. + + String + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Grant HTTP access to an Azure HDInsight cluster -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + Grant-AzureRmHDInsightHttpServicesAccess + -ClusterName $clusterName ` + -HttpCredential $newClusterCreds + + This command grants HTTP access to the cluster named 'your-hadoop-001'. + + + + + + + + + + + + + + + + Revoke-AzureRmHDInsightHttpServicesAccess + + + + + + + + Grant-AzureRmHDInsightRdpServicesAccess + + Grants Remote Desktop Protocol (RDP) access to the Windows cluster. + + + + + Grant + AzureRmHDInsightRdpServicesAccess + + + + The Grant-AzureRmHDInsightRdpServicesAccess cmdlet enables Remote Desktop Protocol (RDP) to access to a Windows-based Azure HDInsight cluster. + + + + Grant-AzureRmHDInsightRdpServicesAccess + + ClusterName + + Specifies the name of the cluster. + + String + + + RdpCredential + + Specifies the Remote Desktop (RDP) credentials for the cluster. This is only for Windows clusters. + + PSCredential + + + RdpAccessExpiry + + Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. + + DateTime + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + RdpCredential + + Specifies the Remote Desktop (RDP) credentials for the cluster. This is only for Windows clusters. + + PSCredential + + PSCredential + + + + + + RdpAccessExpiry + + Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. + + DateTime + + DateTime + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Grant RDP access to an Azure HDInsight cluster -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + Grant-AzureRmHDInsightRdpServicesAccess + -ClusterName $clusterName ` + -RdpCredential $newRdpCreds ` + -RdpAccessExpiry $newRdpExpiry + + This command grants RDP access to the cluster named 'your-hadoop-001'. + + + + + + + + + + + + + + + + Revoke-AzureRmHDInsightRdpServicesAccess + + + + + + + + Invoke-AzureRmHDInsightHiveJob + + Submits a Hive query to an HDInsight cluster and retrieves query results in one operation. + + + + + Invoke + AzureRmHDInsightHiveJob + + + + 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. + + + + Invoke-AzureRmHDInsightHiveJob + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + + Files + + Specifies a collection of files that are required for a Hive job. + + String[] + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + + Defines + + Specifies Hadoop configuration values to set when a job runs. + + Hashtable + + + File + + 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. + + String + + + JobName + + 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>". + + String + + + Query + + Specifies the Hive query. + + String + + + RunAsFileJob + + Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. This cmdlet submits the job that references this file as a script to run. + You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. + + SwitchParameter + + + DefaultContainer + + Specifies the name of the default container in the default Azure storage account that an HDInsight cluster uses. + + String + + + DefaultStorageAccountName + + Specifies the name of the default storage account that the HDInsight cluster uses. + + String + + + DefaultStorageAccountKey + + Specifies the account key for the default storage account that the HDInsight cluster uses. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + String[] + + + + + + Files + + Specifies a collection of files that are required for a Hive job. + + String[] + + String[] + + + + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + String + + + + + + Defines + + Specifies Hadoop configuration values to set when a job runs. + + Hashtable + + Hashtable + + + + + + File + + 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. + + String + + String + + + + + + JobName + + 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>". + + String + + String + + + + + + Query + + Specifies the Hive query. + + String + + String + + + + + + RunAsFileJob + + Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. This cmdlet submits the job that references this file as a script to run. + You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. + + SwitchParameter + + SwitchParameter + + + + + + DefaultContainer + + Specifies the name of the default container in the default Azure storage account that an HDInsight cluster uses. + + String + + String + + + + + + DefaultStorageAccountName + + Specifies the name of the default storage account that the HDInsight cluster uses. + + String + + String + + + + + + DefaultStorageAccountKey + + Specifies the account key for the default storage account that the HDInsight cluster uses. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Submit a Hive query to an Azure HDInsight cluster -------------------------- + + PS C:\> + + PS C:\&gt; # Primary storage account info + $storageAccountResourceGroupName = "Group" + $storageAccountName = "yourstorageacct001" + $storageAccountKey = Get-AzureStorageAccountKey ` + -ResourceGroupName $storageAccountResourceGroupName ` + -Name $storageAccountName | %{ $_.Key1 } + $storageContainer = "container001" + + # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Hive job details + $statusFolder = "tempStatusFolder/" + $query = "SHOW TABLES" + + Use-AzureRmHDInsightCluster + -ClusterCredential $clusterCreds ` + -ClusterName $clusterName + + Invoke-AzureRmHDInsightHiveJob -StatusFolder $statusFolder ` + -Query $query ` + -DefaultContainer $storageAccountContainer ` + -DefaultStorageAccountName "$storageAccountName.blob.core.windows.net" ` + -DefaultStorageAccountKey $storageAccountKey + + This command submits the query SHOW TABLES to the cluster named 'your-hadoop-001'. + + + + + + + + + + + + + + + + Use-AzureRmHDInsightCluster + + + + + + + + New-AzureRmHDInsightCluster + + Creates an Azure HDInsight cluster in the specified resource group for the current subscription. + + + + + New + AzureRmHDInsightCluster + + + + 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. + + + + New-AzureRmHDInsightCluster + + Location + + Specifies the location for the cluster. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + ClusterName + + Specifies the name of the cluster. + + String + + + ClusterSizeInNodes + + Specifies the number of Worker nodes for the cluster. + + Int32 + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + DefaultStorageAccountName + + Specifies the name of the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. + + String + + + DefaultStorageAccountKey + + Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. + + String + + + Config + + Specifies the cluster object to be used to create the cluster. This object can be created by using the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + + OozieMetastore + + Specifies the SQL Database to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + + HiveMetastore + + Specifies the SQL Database to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + + AdditionalStorageAccounts + + Specifies the additional Azure Storage accounts for the cluster. You can alternatively use the Add-AzureRmHDInsightStorage cmdlet. + + Dictionary`2[String] + + + Configurations + + Specifies the configurations of this HDInsight cluster. You can alternatively use the Add-AzureRmHDInsightConfigValues cmdlet. + + Dictionary`2[Dictionary`2] + + + ScriptActions + + Specifies the script actions to run on the cluster at the end of cluster creation. You can alternatively use Add-AzureRmHDInsightScriptAction. + + Dictionary`2[List`1] + + + DefaultStorageContainer + + 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. + + String + + + Version + + Specifies the HDI version of the HDInsight cluster. + + String + + + HeadNodeSize + + Specifies the size of the virtual machine for the Head node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + + WorkerNodeSize + + Specifies the size of the virtual machine for the Worker node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + + ZookeeperNodeSize + + 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. + + String + + + ClusterType + + Specifies the type of cluster to create. Options are: Hadoop, HBase, Storm, Spark + + String + + + VirtualNetworkId + + Specifies the ID of the virtual network into which to provision the cluster. + + String + + + SubnetName + + Specifies the name of a subnet within the chosen virtual network for the cluster. + + String + + + OSType + + Specifies the operating system for the cluster. Options are: Windows, Linux + + OSType + + + ClusterTier + + 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. + + Tier + + + SshCredential + + Specifies the SSH credential to be used for SSH connections. This is only for Linux clusters. + + PSCredential + + + SshPublicKey + + Specifies the public key to be used for SSH connections. This is only for Linux clusters. + + String + + + RdpCredential + + Specifies the Remote Desktop (RDP) credentials for the cluster. This is only for Windows clusters. + + PSCredential + + + RdpAccessExpiry + + Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. + + DateTime + + + ObjectId + + 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. + + Guid + + + CertificateFilePath + + 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. + + String + + + CertificatePassword + + 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. + + String + + + AadTenantId + + Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + + Guid + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Location + + Specifies the location for the cluster. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + ClusterSizeInNodes + + Specifies the number of Worker nodes for the cluster. + + Int32 + + Int32 + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + DefaultStorageAccountName + + Specifies the name of the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. + + String + + String + + + + + + DefaultStorageAccountKey + + Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. + + String + + String + + + + + + Config + + Specifies the cluster object to be used to create the cluster. This object can be created by using the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + AzureHDInsightConfig + + + + + + OozieMetastore + + Specifies the SQL Database to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + AzureHDInsightMetastore + + + + + + HiveMetastore + + Specifies the SQL Database to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + AzureHDInsightMetastore + + + + + + AdditionalStorageAccounts + + Specifies the additional Azure Storage accounts for the cluster. You can alternatively use the Add-AzureRmHDInsightStorage cmdlet. + + Dictionary`2[String] + + Dictionary`2[String] + + + + + + Configurations + + Specifies the configurations of this HDInsight cluster. You can alternatively use the Add-AzureRmHDInsightConfigValues cmdlet. + + Dictionary`2[Dictionary`2] + + Dictionary`2[Dictionary`2] + + + + + + ScriptActions + + Specifies the script actions to run on the cluster at the end of cluster creation. You can alternatively use Add-AzureRmHDInsightScriptAction. + + Dictionary`2[List`1] + + Dictionary`2[List`1] + + + + + + DefaultStorageContainer + + 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. + + String + + String + + + + + + Version + + Specifies the HDI version of the HDInsight cluster. + + String + + String + + + + + + HeadNodeSize + + Specifies the size of the virtual machine for the Head node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + String + + + + + + WorkerNodeSize + + Specifies the size of the virtual machine for the Worker node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + String + + + + + + ZookeeperNodeSize + + 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. + + String + + String + + + + + + ClusterType + + Specifies the type of cluster to create. Options are: Hadoop, HBase, Storm, Spark + + String + + String + + + + + + VirtualNetworkId + + Specifies the ID of the virtual network into which to provision the cluster. + + String + + String + + + + + + SubnetName + + Specifies the name of a subnet within the chosen virtual network for the cluster. + + String + + String + + + + + + OSType + + Specifies the operating system for the cluster. Options are: Windows, Linux + + OSType + + OSType + + + + + + ClusterTier + + 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. + + Tier + + Tier + + + + + + SshCredential + + Specifies the SSH credential to be used for SSH connections. This is only for Linux clusters. + + PSCredential + + PSCredential + + + + + + SshPublicKey + + Specifies the public key to be used for SSH connections. This is only for Linux clusters. + + String + + String + + + + + + RdpCredential + + Specifies the Remote Desktop (RDP) credentials for the cluster. This is only for Windows clusters. + + PSCredential + + PSCredential + + + + + + RdpAccessExpiry + + Specifies the expiration, as a DateTime object, for Remote Desktop Protocol (RDP) access to a cluster. + + DateTime + + DateTime + + + + + + ObjectId + + 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. + + Guid + + Guid + + + + + + CertificateFilePath + + 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. + + String + + String + + + + + + CertificatePassword + + 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. + + String + + String + + + + + + AadTenantId + + Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + + Guid + + Guid + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Create an Azure HDInsight cluster -------------------------- + + PS C:\> + + 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 + + This command creates a cluster in the current subscription. + + + + + + + + + + + + + + + + New-AzureRmHDInsightClusterConfig + + + + + + + + New-AzureRmHDInsightClusterConfig + + Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration. + + + + + New + AzureRmHDInsightClusterConfig + + + + The New-AzureRmHDInsightClusterConfig cmdlet creates a non-persisted object that describes an Azure HDInsight cluster configuration. + + + + New-AzureRmHDInsightClusterConfig + + DefaultStorageAccountName + + Specifies the name of the default storage account that the HDInsight cluster will use. + + String + + + DefaultStorageAccountKey + + Specifies the account key for the default Azure storage account that the HDInsight cluster will use. + + String + + + OozieMetastore + + Specifies the metastore to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + + HiveMetastore + + Specifies the metastore to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + + HeadNodeSize + + Specifies the size of the virtual machine for the Head node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + + WorkerNodeSize + + Specifies the size of the virtual machine for the Worker node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + + ZookeeperNodeSize + + 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. + + String + + + ClusterType + + Specifies the type of cluster to create. Options are: Hadoop, HBase, Storm, Spark + + String + + + ClusterTier + + 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. + + Tier + + + ObjectId + + 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. + + Guid + + + CertificateFilePath + + 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. + + String + + + CertificatePassword + + 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. + + String + + + AadTenantId + + Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + + Guid + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + DefaultStorageAccountName + + Specifies the name of the default storage account that the HDInsight cluster will use. + + String + + String + + + + + + DefaultStorageAccountKey + + Specifies the account key for the default Azure storage account that the HDInsight cluster will use. + + String + + String + + + + + + OozieMetastore + + Specifies the metastore to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + AzureHDInsightMetastore + + + + + + HiveMetastore + + Specifies the metastore to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet. + + AzureHDInsightMetastore + + AzureHDInsightMetastore + + + + + + HeadNodeSize + + Specifies the size of the virtual machine for the Head node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + String + + + + + + WorkerNodeSize + + Specifies the size of the virtual machine for the Worker node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page. + + String + + String + + + + + + ZookeeperNodeSize + + 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. + + String + + String + + + + + + ClusterType + + Specifies the type of cluster to create. Options are: Hadoop, HBase, Storm, Spark + + String + + String + + + + + + ClusterTier + + 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. + + Tier + + Tier + + + + + + ObjectId + + 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. + + Guid + + Guid + + + + + + CertificateFilePath + + 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. + + String + + String + + + + + + CertificatePassword + + 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. + + String + + String + + + + + + AadTenantId + + Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store. + + Guid + + Guid + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Create a cluster configuration object -------------------------- + + PS C:\> + + 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-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 + + + + + + + + + + + + + + + + + + New-AzureRmHDInsightCluster + + + + + + + + New-AzureRmHDInsightHiveJobDefinition + + Creates a Hive job object. + + + + + New + AzureRmHDInsightHiveJobDefinition + + + + The New-AzureRmHDInsightHiveJobDefinition cmdlet defines a Hive job object for use with an Azure HDInsight cluster. + + + + New-AzureRmHDInsightHiveJobDefinition + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + + Defines + + Specifies Hadoop configuration values to set for when the job runs. + + Hashtable + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + + JobName + + Specifies the name of the job. + + String + + + Query + + Specifies the Hive query. + + String + + + RunAsFileJob + + Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. This cmdlet submits the job that references this file as a script to run. + You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. + + SwitchParameter + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + String[] + + + + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + String[] + + + + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + String + + + + + + Defines + + Specifies Hadoop configuration values to set for when the job runs. + + Hashtable + + Hashtable + + + + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + String + + + + + + JobName + + Specifies the name of the job. + + String + + String + + + + + + Query + + Specifies the Hive query. + + String + + String + + + + + + RunAsFileJob + + Indicates that this cmdlet creates a file in the default Azure storage account in which to store a query. This cmdlet submits the job that references this file as a script to run. + You can use this functionality to handle special characters such as percent sign (%) that would fail on a job submission through Templeton, because Templeton interprets a query with a percent sign as a URL parameter. + + SwitchParameter + + SwitchParameter + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Create a Hive job definition -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Hive job details + $statusFolder = "&lt;status folder&gt;" + $query = "SHOW TABLES" + + New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzureRmHDInsightJob + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + This command creates a Hive job definition. + + + + + + + + + + + + + + + + Start-AzureRmHDInsightJob + + + + + + + + New-AzureRmHDInsightMapReduceJobDefinition + + Creates a MapReduce job object. + + + + + New + AzureRmHDInsightMapReduceJobDefinition + + + + The New-AzureRmHDInsightMapReduceJobDefinition cmdlet defines a new MapReduce job for use with an Azure HDInsight cluster. + + + + New-AzureRmHDInsightMapReduceJobDefinition + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + + ClassName + + Specifies the job class in the JAR file. + + String + + + Defines + + Specifies Hadoop configuration values to set for when the job runs. + + Hashtable + + + JarFile + + Specifies the JAR file to use for the jobDetails. + + String + + + JobName + + Specifies the name of the job. + + String + + + LibJars + + Specifies the lib JARS for the job. + + String[] + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + String[] + + + + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + String[] + + + + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + String + + + + + + ClassName + + Specifies the job class in the JAR file. + + String + + String + + + + + + Defines + + Specifies Hadoop configuration values to set for when the job runs. + + Hashtable + + Hashtable + + + + + + JarFile + + Specifies the JAR file to use for the jobDetails. + + String + + String + + + + + + JobName + + Specifies the name of the job. + + String + + String + + + + + + LibJars + + Specifies the lib JARS for the job. + + String[] + + String[] + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Create a MapReduce job definition -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + New-AzureRmHDInsightMapReduceJobDefinition -StatusFolder $statusFolder ` + -ClassName $className ` + -JarFile $jarFilePath ` + | Start-AzureRmHDInsightJob + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + This command creates a MapReduce job definition. + + + + + + + + + + + + + + + + Start-AzureRmHDInsightJob + + + + + + + + New-AzureRmHDInsightPigJobDefinition + + Creates a Pig job object. + + + + + New + AzureRmHDInsightPigJobDefinition + + + + The New-AzureRmHDInsightPigJobDefinition cmdlet defines a Pig job object for use with an Azure HDInsight cluster. + + + + New-AzureRmHDInsightPigJobDefinition + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + + Query + + Specifies the Pig query. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + String[] + + + + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + String[] + + + + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + String + + + + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + String + + + + + + Query + + Specifies the Pig query. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Create a Pig job definition -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Pig job details + $statusFolder = "tempStatusFolder/" + $query = "SHOW TABLES" + + New-AzureRmHDInsightPigJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzureRmHDInsightJob + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + This command creates a Pig job definition. + + + + + + + + + + + + + + + + Start-AzureRmHDInsightJob + + + + + + + + New-AzureRmHDInsightSqoopJobDefinition + + Creates a Sqoop job object. + + + + + New + AzureRmHDInsightSqoopJobDefinition + + + + The New-AzureRmHDInsightSqoopJobDefinition cmdlet defines a Sqoop job object for use with an Azure HDInsight cluster. + + + + New-AzureRmHDInsightSqoopJobDefinition + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + + Command + + Specifies the Sqoop command. + + String + + + LibDir + + Specifies the library directory for the Sqoop job. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + String[] + + + + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + String + + + + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + String + + + + + + Command + + Specifies the Sqoop command. + + String + + String + + + + + + LibDir + + Specifies the library directory for the Sqoop job. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Create a Sqoop job definition -------------------------- + + PS C:\> + + PS C:\&gt;# Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + New-AzureRmHDInsightSqoopJobDefinition -StatusFolder $statusFolder ` + -Command $sqoopCommand ` + | Start-AzureRmHDInsightJob -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + This command creates a Sqoop job definition. + + + + + + + + + + + + + + + + Start-AzureRmHDInsightJob + + + + + + + + New-AzureRmHDInsightStreamingMapReduceJobDefinition + + Creates a Streaming MapReduce job object. + + + + + New + AzureRmHDInsightStreamingMapReduceJobDefinition + + + + The New-AzureRmHDInsightStreamingMapReduceJobDefinition cmdlet defines a Streaming MapReduce job object for use with an Azure HDInsight cluster. + + + + New-AzureRmHDInsightStreamingMapReduceJobDefinition + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + + CommandEnvironment + + Specifies an array of command-line environment variables to set when a job runs on worker nodes. + + Hashtable + + + Defines + + Specifies Hadoop configuration values to set for when the job runs. + + Hashtable + + + InputPath + + Specifies the path to the input files. + + String + + + Mapper + + Specifies a Mapper file name. + + String + + + OutputPath + + Specifies the path for the job output. + + String + + + Reducer + + Specifies a Reducer file name. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Arguments + + Specifies an array of arguments for the job. The arguments are passed as command-line arguments to each task. + + String[] + + String[] + + + + + + File + + Specifies the path to a file that contains a query to run. You can use this parameter instead of the Query parameter. + + String + + String + + + + + + Files + + Specifies a collection of files that are associated with a Hive job. + + String[] + + String[] + + + + + + StatusFolder + + Specifies the location of the folder that contains standard outputs and error outputs for a job. + + String + + String + + + + + + CommandEnvironment + + Specifies an array of command-line environment variables to set when a job runs on worker nodes. + + Hashtable + + Hashtable + + + + + + Defines + + Specifies Hadoop configuration values to set for when the job runs. + + Hashtable + + Hashtable + + + + + + InputPath + + Specifies the path to the input files. + + String + + String + + + + + + Mapper + + Specifies a Mapper file name. + + String + + String + + + + + + OutputPath + + Specifies the path for the job output. + + String + + String + + + + + + Reducer + + Specifies a Reducer file name. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Create a Streaming MapReduce job definition -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Streaming MapReduce job details + $statusFolder = "tempStatusFolder/" + $query = "SHOW TABLES" + + New-AzureRmHDInsightStreamingMapReduceJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzureRmHDInsightJob + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + This command creates a Streaming MapReduce job definition. + + + + + + + + + + + + + + + + Start-AzureRmHDInsightJob + + + + + + + + Remove-AzureRmHDInsightCluster + + Removes the specified HDInsight cluster from the current subscription. + + + + + Remove + AzureRmHDInsightCluster + + + + 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. + + + + Remove-AzureRmHDInsightCluster + + ClusterName + + Specifies the name of the cluster. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Delete an Azure HDInsight cluster. -------------------------- + + PS C:\> + + PS C:\&gt;Remove-AzureRmHDInsightCluster -ClusterName "your-hadoop-001" + + + + + + + + + + + + + + + + + + + + + + Remove-AzureRmHDInsightPersistedScriptAction + + Removes an persisted script action from an HDInsight cluster. + + + + + Remove + AzureRmHDInsightPersistedScriptAction + + + + 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. + + + + Remove-AzureRmHDInsightPersistedScriptAction + + ClusterName + + Specifies the name of the cluster. + + String + + + Name + + Specifies the name of the persisted script action to be removed. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + Name + + Specifies the name of the persisted script action to be removed. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Removes a script action from the list of persisted script actions on a cluster. -------------------------- + + PS C:\> + + PS C:\> Remove-AzureRmHDInsightPersistedScriptAction ` + -ClusterName "your-hadoop-001" ` + -Name "scriptaction" + + + + + + + + + + + + + + + + + + + + + + Revoke-AzureRmHDInsightHttpServicesAccess + + Disables HTTP access to the cluster. + + + + + Revoke + AzureRmHDInsightHttpServicesAccess + + + + The Revoke-AzureRmHDInsightHttpServicesAccess cmdlet disables HTTP access to an Azure HDInsight cluster for ODBC, Ambari, Oozie and webHCatalog web services. + + + + Revoke-AzureRmHDInsightHttpServicesAccess + + ClusterName + + Specifies the name of the cluster. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Disable HTTP access to a cluster -------------------------- + + PS C:\> + + PS C:\&gt;Revoke-AzureRmHDInsightHttpServicesAccess ` + -ClusterName "your-hadoop_001" + + + + + + + + + + + + + + + + + + + + + + Revoke-AzureRmHDInsightRdpServicesAccess + + Disables Remote Desktop Protocol (RDP) access to a Windows cluster. + + + + + Revoke + AzureRmHDInsightRdpServicesAccess + + + + The Revoke-AzureRmHDInsightRdpServicesAccess cmdlet disables Remote Desktop Protocol (RDP) access to a Windows-based Azure HDInsight cluster. + + + + Revoke-AzureRmHDInsightRdpServicesAccess + + ClusterName + + Specifies the name of the cluster. + + String + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Disable RDP access to a specified cluster -------------------------- + + PS C:\> + + PS C:\&gt;Revoke-AzureRmHDInsightRdpServicesAccess -ClusterName "your-hadoop-001" + + + + + + + + + + + + + + + + + + + + + + Set-AzureRmHDInsightClusterSize + + Sets the number of Worker nodes in a specified cluster. + + + + + Set + AzureRmHDInsightClusterSize + + + + The Set-AzureRmHDInsightClusterSize cmdlet sets the number of Worker nodes in a specified Azure HDInsight cluster. + + + + Set-AzureRmHDInsightClusterSize + + ClusterName + + Specifies the name of the cluster. + + String + + + TargetInstanceCount + + Specifies the desired number of Worker nodes in the cluster. + + Int32 + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + TargetInstanceCount + + Specifies the desired number of Worker nodes in the cluster. + + Int32 + + Int32 + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Set the size of a specified cluster -------------------------- + + PS C:\> + + PS C:\&gt;Set-AzureRmHDInsightClusterSize -ClusterName "your-hadoop-001" -TargetInstanceCount 6 + + + + + + + + + + + + + + + + + + + + + + Set-AzureRmHDInsightDefaultStorage + + Sets the default storage account setting in a cluster configuration object. + + + + + Set + AzureRmHDInsightDefaultStorage + + + + The Set-AzureRmHDInsightDefaultStorage cmdlet sets the default storage account setting in the Azure HDInsight cluster configuration object created by the New-AzureRmHDInsightClusterConfig cmdlet. + + + + Set-AzureRmHDInsightDefaultStorage + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + + StorageAccountName + + Specifies the name of the default storage account that the HDInsight cluster will use. + + String + + + StorageAccountKey + + Specifies the account key for the default Azure storage account that the HDInsight cluster will use. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + Config + + Specifies the HDInsight cluster configuration object that this cmdlet modifies. This object is created by the New-AzureRmHDInsightClusterConfig cmdlet. + + AzureHDInsightConfig + + AzureHDInsightConfig + + + + + + StorageAccountName + + Specifies the name of the default storage account that the HDInsight cluster will use. + + String + + String + + + + + + StorageAccountKey + + Specifies the account key for the default Azure storage account that the HDInsight cluster will use. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Set the default storage account for the in the cluster configuration object -------------------------- + + PS C:\> + + 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-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 + + + + + + + + + + + + + + + + + + + + + + Set-AzureRmHDInsightPersistedScriptAction + + Sets a previously executed script action to be a persisted script action. + + + + + Set + AzureRmHDInsightPersistedScriptAction + + + + 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. + + + + Set-AzureRmHDInsightPersistedScriptAction + + ClusterName + + Specifies the name of the cluster. + + String + + + ScriptExecutionId + + 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. + + Int64 + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + ScriptExecutionId + + 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. + + Int64 + + Int64 + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Set a previously successful script action to be persisted, or run on cluster scale up. -------------------------- + + PS C:\> + + PS C:\> Set-AzureRmHDInsightPersistedScriptAction ` + -ClusterName "your-hadoop-001" ` + -ScriptExecutionId "<id>" + + + + + + + + + + + + + + + + + + + + + + Start-AzureRmHDInsightJob + + Starts a defined Azure HDInsight job on a specified cluster. + + + + + Start + AzureRmHDInsightJob + + + + 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. + + + + Start-AzureRmHDInsightJob + + ClusterName + + Specifies the name of the cluster. + + String + + + JobDefinition + + Specifies the job to start on the Azure HDInsight cluster. + + AzureHDInsightJobDefinition + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + JobDefinition + + Specifies the job to start on the Azure HDInsight cluster. + + AzureHDInsightJobDefinition + + AzureHDInsightJobDefinition + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + ClusterCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + pscredential + + pscredential + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Start a job on the specified cluster -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Hive job details + $statusFolder = "tempStatusFolder/" + $query = "SHOW TABLES" + + New-AzureRMHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzureRMHDInsightJob + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + + + + + + + + + + + + + + + + + + + + + Stop-AzureRmHDInsightJob + + Stops a specified running job on a cluster. + + + + + Stop + AzureRmHDInsightJob + + + + The Stop-AzureRmHDInsightJob cmdlet stops a specified running job on an Azure HDInsight cluster. + + + + Stop-AzureRmHDInsightJob + + ClusterName + + Specifies the name of the cluster. + + String + + + JobId + + Specifies the job ID of the job. + + String + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + JobId + + Specifies the job ID of the job. + + String + + String + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + ClusterCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + pscredential + + pscredential + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Stop a job on the specified cluster -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + Stop-AzureRmHDInsightJob + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + -JobId $jobId + + + + + + + + + + + + + + + + + + + + + + Submit-AzureRmHDInsightScriptAction + + Submits a new script action to an Azure HDInsight cluster. + + + + + Submit + AzureRmHDInsightScriptAction + + + + 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. + + + + Submit-AzureRmHDInsightScriptAction + + ClusterName + + Specifies the name of the cluster. + + String + + + Name + + Specifies the name of the script action. + + String + + + Uri + + Specifies the public URI for the script action (a PowerShell or Bash script). + + Uri + + + NodeTypes + + Specifies the node types on which to run the script action. + + ClusterNodeType[] + + + Parameters + + Specifies the parameters for the script action. + + String + + + PersistOnSuccess + + 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. + + SwitchParameter + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + Name + + Specifies the name of the script action. + + String + + String + + + + + + Uri + + Specifies the public URI for the script action (a PowerShell or Bash script). + + Uri + + Uri + + + + + + NodeTypes + + Specifies the node types on which to run the script action. + + ClusterNodeType[] + + ClusterNodeType[] + + + + + + Parameters + + Specifies the parameters for the script action. + + String + + String + + + + + + PersistOnSuccess + + 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. + + SwitchParameter + + SwitchParameter + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Submit a new script action to a running HDInsight cluster -------------------------- + + PS C:\> + + PS C:\> Submit-AzureRmHDInsightScriptAction ` + -ClusterName "your-hadoop-001" ` + -Name "scriptaction" ` + -Uri "<script action URI>" ` + -NodeTypes Worker -PersistOnSuccess + + + + + + + + + + + + + + + + + + + + + + Use-AzureRmHDInsightCluster + + Selects a cluster to be used with the Invoke-RmAzureHDInsightHiveJob cmdlet. + + + + + Use + AzureRmHDInsightCluster + + + + The Use-AzureRmHDInsightCluster cmdlet selects the Azure HDInsight cluster for the Invoke-AzureRmHDInsightHiveJob cmdlet to use to submit Hive jobs. + + + + Use-AzureRmHDInsightCluster + + ClusterName + + Specifies the name of the cluster. + + String + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + ClusterCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + pscredential + + pscredential + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Select a cluster for Hive query submission. -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + Use-AzureRmHDInsightCluster + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + + + + + + + + + + + + + + + + + Invoke-AzureRmHDInsightHiveJob + + + + + + + + Wait-AzureRmHDInsightJob + + Waits for the completion or failure of a specified job. + + + + + Wait + AzureRmHDInsightJob + + + + The Wait-AzureRmHDInsightJob cmdlet awaits the completion or failure of an Azure HDInsight job. + + + + Wait-AzureRmHDInsightJob + + ClusterName + + Specifies the name of the cluster. + + String + + + JobId + + Specifies the job ID of the job. + + String + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + + InformationAction + + + + ActionPreference + + + InformationVariable + + + + String + + + + + + ClusterName + + Specifies the name of the cluster. + + String + + String + + + + + + JobId + + Specifies the job ID of the job. + + String + + String + + + + + + HttpCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + PSCredential + + PSCredential + + + + + + ResourceGroupName + + Specifies the name of the resource group. + + String + + String + + + + + + InformationAction + + + + ActionPreference + + ActionPreference + + + + + + InformationVariable + + + + String + + String + + + + + + ClusterCredential + + Specifies the cluster login (HTTP) credentials for the cluster. + + pscredential + + pscredential + + + + + + Profile + + + + azureprofile + + azureprofile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Keywords: azure, azurerm, arm, resource, management, manager, hadoop, hdinsight, hd, insight + + + + + -------------------------- Example 1: Wait for the completion or failure of a job -------------------------- + + PS C:\> + + PS C:\&gt; # Cluster info + $clusterResourceGroupName = "Group" + $clusterName = "your-hadoop-001" + $clusterCreds = Get-Credential + + # Hive job details + $statusFolder = "tempStatusFolder/" + $query = "SHOW TABLES" + + New-AzureRmHDInsightHiveJobDefinition -StatusFolder $statusFolder ` + -Query $query ` + | Start-AzureRmHDInsightJob -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds ` + | Wait-AzureRmHDInsightJob -ResourceGroupName $clusterResourceGroupName ` + -ClusterName $clusterName ` + -ClusterCredential $clusterCreds + + + + + + + + + + + + + + + + + + Get-AzureRmHDInsightJob + + + + + \ No newline at end of file