New-AzureRmDataLakeAnalyticsComputePolicy

Creates a Data Lake Analytics compute policy rule for a specific Microsoft Entra entity.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmDataLakeAnalyticsComputePolicy
   [-ResourceGroupName <String>]
   [-Account] <String>
   [-Name] <String>
   [-ObjectId] <Guid>
   [-ObjectType] <String>
   [-MaxAnalyticsUnitsPerJob <Int32>]
   [-MinPriorityPerJob <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmDataLakeAnalyticsComputePolicy creates the specified compute policy rule for a specific Microsoft Entra entity in an Azure Data Lake Analytics account.

Examples

Example 1: Create a compute policy with only one rule

PS C:\>New-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -ObjectId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -ObjectType User -MaxAnalyticsUnitsPerJob 5

This command creates a policy called "myPolicy" in account "contosoadla" for the user with id "83cb7ad2-3523-4b82-b909-d478b0d8aea3" that ensures they cannot submit any job with more than 5 analytics units.

Example 2: Create a compute policy with both rules set

PS C:\>New-AzureRmDataLakeAnalyticsComputePolicy -Account "contosoadla" -Name "myPolicy" -ObjectId 83cb7ad2-3523-4b82-b909-d478b0d8aea3 -ObjectType User -MaxAnalyticsUnitsPerJob 5 -MinPriorityPerJob 100

This command creates a policy called "myPolicy" in account "contosoadla" for the user with id "83cb7ad2-3523-4b82-b909-d478b0d8aea3" that ensures they cannot submit any job with more than 5 analytics units or with a priority lower than 100

Parameters

-Account

Name of the account to add the compute policy to.

Type:String
Aliases:AccountName
Position:0
Default value:None
Required:True
Accept pipeline input:True
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 credentials, account, tenant, and subscription used for communication with azure

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

-MaxAnalyticsUnitsPerJob

The maximum supported analytics units per job for this policy. Either this, MinPriorityPerJob, or both parameters must be specified.

Type:Nullable<T>[Int32]
Aliases:MaxDegreeOfParallelismPerJob
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MinPriorityPerJob

The minimum supported priority per job for this policy. Either this, MaxAnalyticsUnitsPerJob, or both parameters must be specified.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Name of the compute policy to create.

Type:String
Aliases:ComputePolicyName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ObjectId

The Microsoft Entra object id for the user or group to apply the policy to.

Type:Guid
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ObjectType

The Microsoft Entra object type for the object ID passed in.

Type:String
Accepted values:User, Group, ServicePrincipal
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Name of resource group under which you the account exists. Optional and will attempt to discover if not provided.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

String

Guid

Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

PSDataLakeAnalyticsComputePolicy