Edit

Share via

Set-AzDtlVMsPerUserPolicy

Module:
Az.DevTestLabs Module

Sets the virtual machines per user policy of a lab in DevTest Labs.

Syntax

Enable (Default) 

Set-AzDtlVMsPerUserPolicy
    [[-MaxVMs] <Int32>]
    [-LabName] <String>
    [-ResourceGroupName] <String>
    [-Enable]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Disable 

Set-AzDtlVMsPerUserPolicy
    [[-MaxVMs] <Int32>]
    [-LabName] <String>
    [-ResourceGroupName] <String>
    [-Disable]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AzDtlVMsPerUserPolicy cmdlet sets the virtual machines per user policy of a lab, which sets the maximum number of virtual machines allowed per user. The cmdlet uses the specified resource group and name of the lab to set the policy.

Examples

Example 1

Set-AzDtlVMsPerUserPolicy -LabName debtestlab -ResourceGroupName yuzhi-rg

Name               : MaxVmsAllowedPerUser
Type               : Microsoft.DevTestLab/labs/policySets/policies
Tags               :
Id                 : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourcegroups/yuzhi-rg/providers/microsoft.devtestlab/labs/debte
                     stlab/policysets/default/policies/maxvmsallowedperuser
Location           :
Fact Name          : UserOwnedLabVmCount
Threshold          : 1
Evaluator Type     : MaxValuePolicy
Description        :
Status             : Enabled
Provisioning State :

Sets the virtual machines per user policy of a lab in DevTest Labs.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Disable

Indicates that this cmdlet disables the policy for the lab.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Disable
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Enable

Indicates that this cmdlet enables the policy for the lab.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Enable
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LabName

Specifies the name of the lab for which this cmdlet sets the virtual machines per user policy.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaxVMs

Specifies the maximum number of virtual machines that can be created in the lab.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Specifies the name of the resource group that the lab belongs to.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

PSPolicy