< Back
New-AzureRmHDInsightClusterConfig
Post
NAME New-AzureRmHDInsightClusterConfig
SYNOPSIS
Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration.
SYNTAX
New-AzureRmHDInsightClusterConfig [-AadTenantId <Guid>] [-CertificateFileContents <Byte[]>] [-CertificateFilePath <String>] [-CertificatePassword
<String>] [-ClusterTier {Standard | Premium}] [-ClusterType <String>] [-DefaultProfile <IAzureContextContainer>] [-DefaultStorageAccountKey
<String>] [-DefaultStorageAccountName <String>] [-DefaultStorageAccountType {AzureStorage | AzureDataLakeStore}] [-EdgeNodeSize <String>]
[-HeadNodeSize <String>] [-HiveMetastore <AzureHDInsightMetastore>] [-ObjectId <Guid>] [-OozieMetastore <AzureHDInsightMetastore>]
[-WorkerNodeSize <String>] [-ZookeeperNodeSize <String>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmHDInsightClusterConfig cmdlet creates a non-persisted object that describes an Azure HDInsight cluster configuration.
PARAMETERS
-AadTenantId <Guid>
Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateFileContents <Byte[]>
Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateFilePath <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificatePassword <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClusterTier <Tier>
Specifies the HDInsight cluster tier. The acceptable values for this parameter are:
- Standard
- Premium
The default value is Standard. The Premium tier can only be used with Linux clusters, and it enables the use of some new features.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClusterType <String>
Specifies the type of cluster to create. The acceptable values for this parameter are:
- Hadoop
- HBase
- Storm
- Spark
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultStorageAccountKey <String>
Specifies the account key for the default Azure Storage account that the HDInsight cluster will use.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultStorageAccountName <String>
Specifies the name of the default storage account that the HDInsight cluster will use.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultStorageAccountType <StorageType>
Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore.
Required? false
Position? named
Default value AzureStorage
Accept pipeline input? False
Accept wildcard characters? false
-EdgeNodeSize <String>
Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page.
This parameter is valid only for RServer clusters.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HeadNodeSize <String>
Specifies the size of the virtual machine for the Head node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HiveMetastore <AzureHDInsightMetastore>
Specifies the metastore to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ObjectId <Guid>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OozieMetastore <AzureHDInsightMetastore>
Specifies the metastore to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WorkerNodeSize <String>
Specifies the size of the virtual machine for the Worker node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ZookeeperNodeSize <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig
NOTES
Example 1: Create a cluster configuration object
PS C:\\># Primary storage account info
PS C:\\> $storageAccountResourceGroupName = "Group"
PS C:\\> $storageAccountName = "yourstorageacct001"
PS C:\\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value
PS C:\\> $storageContainer = "container002"
# Cluster configuration info
PS C:\\> $location = "East US 2"
PS C:\\> $clusterResourceGroupName = "Group"
PS C:\\> $clusterName = "your-hadoop-002"
PS C:\\> $clusterCreds = Get-Credential
# If the cluster's resource group doesn't exist yet, run:
# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location
# Create the cluster
PS C:\\> New-AzureRmHDInsightClusterConfig `
| Add-AzureRmHDInsightStorage `
-StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" `
-StorageAccountKey $key2 `
| New-AzureRmHDInsightCluster `
-ClusterType Hadoop `
-OSType Windows `
-ClusterSizeInNodes 4 `
-ResourceGroupName $clusterResourceGroupName `
-ClusterName $clusterName `
-HttpCredential $clusterCreds `
-Location $location `
-DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" `
-DefaultStorageAccountKey $storageAccountKey `
-DefaultStorageContainer $storageContainer
This command creates a cluster configuration object.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sterconfig
Add-AzureRmHDInsightStorage
SYNOPSIS
Creates a non-persisted cluster configuration object that describes an Azure HDInsight cluster configuration.
SYNTAX
New-AzureRmHDInsightClusterConfig [-AadTenantId <Guid>] [-CertificateFileContents <Byte[]>] [-CertificateFilePath <String>] [-CertificatePassword
<String>] [-ClusterTier {Standard | Premium}] [-ClusterType <String>] [-DefaultProfile <IAzureContextContainer>] [-DefaultStorageAccountKey
<String>] [-DefaultStorageAccountName <String>] [-DefaultStorageAccountType {AzureStorage | AzureDataLakeStore}] [-EdgeNodeSize <String>]
[-HeadNodeSize <String>] [-HiveMetastore <AzureHDInsightMetastore>] [-ObjectId <Guid>] [-OozieMetastore <AzureHDInsightMetastore>]
[-WorkerNodeSize <String>] [-ZookeeperNodeSize <String>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmHDInsightClusterConfig cmdlet creates a non-persisted object that describes an Azure HDInsight cluster configuration.
PARAMETERS
-AadTenantId <Guid>
Specifies the Azure AD Tenant ID that will be used when accessing Azure Data Lake Store.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateFileContents <Byte[]>
Specifies file contents of the certificate that will be used when accessing Azure Data Lake Store.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificateFilePath <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CertificatePassword <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClusterTier <Tier>
Specifies the HDInsight cluster tier. The acceptable values for this parameter are:
- Standard
- Premium
The default value is Standard. The Premium tier can only be used with Linux clusters, and it enables the use of some new features.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ClusterType <String>
Specifies the type of cluster to create. The acceptable values for this parameter are:
- Hadoop
- HBase
- Storm
- Spark
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultStorageAccountKey <String>
Specifies the account key for the default Azure Storage account that the HDInsight cluster will use.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultStorageAccountName <String>
Specifies the name of the default storage account that the HDInsight cluster will use.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultStorageAccountType <StorageType>
Specifies the type of the default storage account that the HDInsight cluster will use. Possible values are AzureStorage and AzureDataLakeStore.
Required? false
Position? named
Default value AzureStorage
Accept pipeline input? False
Accept wildcard characters? false
-EdgeNodeSize <String>
Specifies the size of the virtual machine for the edge node. Use Get-AzureRmVMSize for acceptable VM sizes, and see HDInsight's pricing page.
This parameter is valid only for RServer clusters.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HeadNodeSize <String>
Specifies the size of the virtual machine for the Head node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HiveMetastore <AzureHDInsightMetastore>
Specifies the metastore to store Hive metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ObjectId <Guid>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OozieMetastore <AzureHDInsightMetastore>
Specifies the metastore to store Oozie metadata. You can alternatively use the Add-AzureRmHDInsightMetastore cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WorkerNodeSize <String>
Specifies the size of the virtual machine for the Worker node. Use Get-AzureRMVMSize for acceptable VM sizes, and see HDInsight's pricing page.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ZookeeperNodeSize <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.HDInsight.Models.AzureHDInsightConfig
NOTES
Example 1: Create a cluster configuration object
PS C:\\># Primary storage account info
PS C:\\> $storageAccountResourceGroupName = "Group"
PS C:\\> $storageAccountName = "yourstorageacct001"
PS C:\\> $storageAccountKey = (Get-AzureRmStorageAccountKey -ResourceGroupName $storageAccountResourceGroupName -Name $storageAccountName)[0].value
PS C:\\> $storageContainer = "container002"
# Cluster configuration info
PS C:\\> $location = "East US 2"
PS C:\\> $clusterResourceGroupName = "Group"
PS C:\\> $clusterName = "your-hadoop-002"
PS C:\\> $clusterCreds = Get-Credential
# If the cluster's resource group doesn't exist yet, run:
# New-AzureRmResourceGroup -Name $clusterResourceGroupName -Location $location
# Create the cluster
PS C:\\> New-AzureRmHDInsightClusterConfig `
| Add-AzureRmHDInsightStorage `
-StorageAccountName "$secondStorageAccountName.blob.core.contoso.net" `
-StorageAccountKey $key2 `
| New-AzureRmHDInsightCluster `
-ClusterType Hadoop `
-OSType Windows `
-ClusterSizeInNodes 4 `
-ResourceGroupName $clusterResourceGroupName `
-ClusterName $clusterName `
-HttpCredential $clusterCreds `
-Location $location `
-DefaultStorageAccountName "$storageAccountName.blob.core.contoso.net" `
-DefaultStorageAccountKey $storageAccountKey `
-DefaultStorageContainer $storageContainer
This command creates a cluster configuration object.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... sterconfig
Add-AzureRmHDInsightStorage