Set-AzDtlAutoShutdownPolicy

  • Reference
Module:
Az.DevTestLabs

Sets the auto shutdown policy of a lab DevTest Labs.

Syntax

Set-AzDtlAutoShutdownPolicy
   [[-Time] <DateTime>]
   [-Enable]
   [-LabName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDtlAutoShutdownPolicy
   [[-Time] <DateTime>]
   [-Disable]
   [-LabName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzDtlAutoShutdownPolicy cmdlet sets the auto shutdown policy of a lab, which automatically shuts down all the virtual machines in the lab at a specified time of the day. The cmdlet uses the specified resource group and name of the lab to set the policy.

Examples

Example 1

Sets the auto shutdown policy of a lab DevTest Labs. (autogenerated)

Set-AzDtlAutoShutdownPolicy -Enable -LabName <String> -ResourceGroupName MyResourceGroup -Time <DateTime>

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Disable

Indicates that the cmdlet disables the policy in the lab.

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

-Enable

Indicates that the cmdlet enables the policy in the lab.

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

-LabName

Specifies the name of the lab for which this cmdlet sets the auto shutdown policy.

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

-ResourceGroupName

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

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

-Time

Specifies the time, as a DateTime object, for when the virtual machines in the lab must shut down.

Type:Nullable<T>[DateTime]
Position:4
Default value:None
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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSSchedule