Invoke-AzHdInsightOnAksManageClusterLibrary

Module:

Az.HdInsightOnAks

Library management operations on HDInsight on AKS cluster.

Syntax

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -InputObject <IHdInsightOnAksIdentity>
      -Operation <IClusterLibraryManagementOperation>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -ClusterName <String>
      -ClusterPoolName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonString <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -ClusterName <String>
      -ClusterPoolName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -JsonFilePath <String>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -ClusterName <String>
      -ClusterpoolInputObject <IHdInsightOnAksIdentity>
      -Action <String>
      -Library <IClusterLibrary[]>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -ClusterName <String>
      -ClusterpoolInputObject <IHdInsightOnAksIdentity>
      -Operation <IClusterLibraryManagementOperation>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -ClusterName <String>
      -ClusterPoolName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Action <String>
      -Library <IClusterLibrary[]>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -ClusterName <String>
      -ClusterPoolName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Operation <IClusterLibraryManagementOperation>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

PowerShell

Invoke-AzHdInsightOnAksManageClusterLibrary
      -InputObject <IHdInsightOnAksIdentity>
      -Action <String>
      -Library <IClusterLibrary[]>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Library management operations on HDInsight on AKS cluster.

Examples

Example 1: Install maven library to cluster.

PowerShell

$libObj=New-AzHdInsightOnAksClusterMavenLibraryObject -GroupId "com.azure.resourcemanager" -Name "azure-resourcemanager-hdinsight-containers" -Version "1.0.0-beta.2" -Remark "Maven lib"
Invoke-AzHdInsightOnAksManageClusterLibrary -ResourceGroupName hilocli-test -ClusterPoolName hilopoolwus3 -ClusterName cluster2024521155147  -Action Install -Library $libObj -AsJob

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
1      Invoke-AzHdIns…                 Running       True            localhost            Invoke-AzHdInsightOnAksM…

Install azure-resourcemanager-hdinsight-containers library to the cluster.

Example 2: Uninstall pypi library to cluster.

PowerShell

$libObj=New-AzHdInsightOnAksClusterPyPiLibraryObject -Name pandas -Version 2.2.2 
Invoke-AzHdInsightOnAksManageClusterLibrary -ResourceGroupName hilocli-test -ClusterPoolName hilopoolwus3 -ClusterName cluster2024521155147  -Action Uninstall -Library $libObj -AsJob

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
1      Invoke-AzHdIns…                 Running       True            localhost            Invoke-AzHdInsightOnAksM…

Uninstall the pandas library on the cluster.

Parameters

-Action

The library management action.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterName

The name of the HDInsight cluster.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterpoolInputObject

Identity Parameter

Type:	IHdInsightOnAksIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ClusterPoolName

The name of the cluster pool.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter

Type:	IHdInsightOnAksIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JsonFilePath

Path of Json file supplied to the Manage operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-JsonString

Json string supplied to the Manage operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Library

The libraries to be installed/updated/uninstalled.

Type:	IClusterLibrary[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Operation

Library management operation.

Type:	IClusterLibraryManagementOperation
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IClusterLibraryManagementOperation

IHdInsightOnAksIdentity

Outputs

Boolean