Set-VSTeamEnvironmentStatus

SYNOPSIS

Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.

SYNTAX

Set-VSTeamEnvironmentStatus -EnvironmentId <Int32[]> -ReleaseId <Int32> -Status <String> [-Comment <String>]
 [-ScheduledDeploymentTime <DateTime>] [-Force] [-ProjectName <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.

EXAMPLES

Example 1

Set-VSTeamEnvironmentStatus -ReleaseId 54 -Id 5 -status inProgress

This command will set the status of environment with id 5 of release 54 to inProgress. You can use this call to redeploy an environment.

PARAMETERS

-EnvironmentId

Specifies one or more environments by ID you wish to deploy.

The Environment Ids are unique for each environment and in each release.

To specify multiple IDs, use commas to separate the IDs.

To find the ID of an environment type Get-VSTeamRelease -expand environments.

Type: Int32[]
Parameter Sets: (All)
Aliases: Id

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

-ReleaseId

Specifies the release by ID.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Status

The status to set for the environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.

Type: String
Parameter Sets: (All)
Aliases: EnvironmentStatus

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

-Comment

The comment to set for the status change.

Type: String
Parameter Sets: (All)
Aliases:

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

-ScheduledDeploymentTime

The date and time to schedule when setting the status to scheduled.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-ProjectName

Specifies the team project for which this function operates.

You can tab complete from a list of available projects.

You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.

Type: String
Parameter Sets: (All)
Aliases:

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

-Force

Forces the function without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WhatIf

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

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

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

-Confirm

Prompts you for confirmation before running the function.

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

Required: False
Position: Named
Default value: False
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

OUTPUTS

NOTES

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

• check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
• use Set-VSTeamDefaultProject to set default project for every call
• use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
• use Profiles to load an account and the correct version

RELATED LINKS