Skip to main content

Set-VSTeamAgentPoolMaintenance

SYNOPSIS

{{ Fill in the Synopsis }}

SYNTAX

Disabled (Default)

Set-VSTeamAgentPoolMaintenance [-Id] <Int32> [-Disable] [-WhatIf] [-Confirm] [<CommonParameters>]

Enabled

Set-VSTeamAgentPoolMaintenance [-Id] <Int32> -JobTimeoutInMinutes <Int32>
-MaxConcurrentAgentsPercentage <Int32> -NumberOfHistoryRecordsToKeep <Int32>
-WorkingDirectoryExpirationInDays <Int32> -StartHours <Int32> -StartMinutes <Int32> -TimeZoneId <String>
-WeekDaysToBuild <AgentPoolMaintenanceDays> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-Disable

{{ Fill Disable Description }}

Type: SwitchParameter
Parameter Sets: Disabled
Aliases:

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

-Id

{{ Fill Id Description }}

Type: Int32
Parameter Sets: (All)
Aliases: PoolID

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-JobTimeoutInMinutes

{{ Fill JobTimeoutInMinutes Description }}

Type: Int32
Parameter Sets: Enabled
Aliases:

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

-MaxConcurrentAgentsPercentage

{{ Fill MaxConcurrentAgentsPercentage Description }}

Type: Int32
Parameter Sets: Enabled
Aliases:

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

-NumberOfHistoryRecordsToKeep

{{ Fill NumberOfHistoryRecordsToKeep Description }}

Type: Int32
Parameter Sets: Enabled
Aliases:

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

-StartHours

{{ Fill StartHours Description }}

Type: Int32
Parameter Sets: Enabled
Aliases:

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

-StartMinutes

{{ Fill StartMinutes Description }}

Type: Int32
Parameter Sets: Enabled
Aliases:

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

-TimeZoneId

{{ Fill TimeZoneId Description }}

Type: String
Parameter Sets: Enabled
Aliases:

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

-WeekDaysToBuild

{{ Fill WeekDaysToBuild Description }}

Type: AgentPoolMaintenanceDays
Parameter Sets: Enabled
Aliases:
Accepted values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-WorkingDirectoryExpirationInDays

{{ Fill WorkingDirectoryExpirationInDays Description }}

Type: Int32
Parameter Sets: Enabled
Aliases:

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

CommonParameters

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

INPUTS

System.Int32

OUTPUTS

System.Object

NOTES

https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamAgentPoolMaintenance