< Back
Set-VstsConnection
Post
NAME Set-VstsConnection
SYNTAX
Set-VstsConnection [-instanceName] <string> [-projectName] <string> [-accessToken] <string> [<CommonParameters>]
PARAMETERS
-accessToken <string>
Required? true
Position? 2
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-instanceName <string>
Required? true
Position? 0
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-projectName <string>
Required? true
Position? 1
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Object
ALIASES
None
REMARKS
None
examples : @{example=@{introduction=System.Management.Automation.PSObject[]; code=Wait-OctoDeployment -deployment
802; remarks=System.Management.Automation.PSObject[]; title=-------------------------- EXAMPLE 1
--------------------------}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
parameters : @{parameter=@{description=System.Management.Automation.PSObject[]; defaultValue=;
parameterValue=Object; name=deployment; type=@{name=Object}; required=true; globbing=false;
pipelineInput=true (ByValue); position=1}}
details : @{name=Wait-OctoDeployment; description=System.Management.Automation.PSObject[]}
description : {@{Text=Displays a sequence of dots on the screen while the specified deployment runs. If deployment
is successful this will write to the host the build status and deployment
time while writing to output $true. Otherwise writes Build failed in (time) and writes to output
$false.}}
syntax : @{syntaxItem=@{name=Wait-OctoDeployment;
parameter=@{description=System.Management.Automation.PSObject[]; parameterValue=Object;
name=deployment; required=true; globbing=false; pipelineInput=true (ByValue); position=1}}}
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
Name : Wait-OctoDeployment
Category : Function
Synopsis : Pause script while an Octopus deployment completes
Component :
Role :
Functionality :
ModuleName : OctoVsts
description : {@{Text=Pauses the script util the specified build is complete. If the build is in-progress then a
progess bar is displayed. If the build failes then the reason is reported to the console.}}
syntax : @{syntaxItem=@{name=Wait-VstsBuild; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
examples : @{example=@{introduction=System.Management.Automation.PSObject[]; code=Wait-VstsBuild
'BuildDefinitionName' -buildNumber '201709.08.1-develop' -pipeBuild;
remarks=System.Management.Automation.PSObject[]; title=-------------------------- EXAMPLE 1
--------------------------}}
details : @{name=Wait-VstsBuild; description=System.Management.Automation.PSObject[]}
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
Name : Wait-VstsBuild
Category : Function
Synopsis : Pauses the script until the specified build is complete.
Component :
Role :
Functionality :
ModuleName : OctoVsts
SYNTAX
Set-VstsConnection [-instanceName] <string> [-projectName] <string> [-accessToken] <string> [<CommonParameters>]
PARAMETERS
-accessToken <string>
Required? true
Position? 2
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-instanceName <string>
Required? true
Position? 0
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
-projectName <string>
Required? true
Position? 1
Accept pipeline input? false
Parameter set name (All)
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Object
ALIASES
None
REMARKS
None
examples : @{example=@{introduction=System.Management.Automation.PSObject[]; code=Wait-OctoDeployment -deployment
802; remarks=System.Management.Automation.PSObject[]; title=-------------------------- EXAMPLE 1
--------------------------}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
parameters : @{parameter=@{description=System.Management.Automation.PSObject[]; defaultValue=;
parameterValue=Object; name=deployment; type=@{name=Object}; required=true; globbing=false;
pipelineInput=true (ByValue); position=1}}
details : @{name=Wait-OctoDeployment; description=System.Management.Automation.PSObject[]}
description : {@{Text=Displays a sequence of dots on the screen while the specified deployment runs. If deployment
is successful this will write to the host the build status and deployment
time while writing to output $true. Otherwise writes Build failed in (time) and writes to output
$false.}}
syntax : @{syntaxItem=@{name=Wait-OctoDeployment;
parameter=@{description=System.Management.Automation.PSObject[]; parameterValue=Object;
name=deployment; required=true; globbing=false; pipelineInput=true (ByValue); position=1}}}
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
Name : Wait-OctoDeployment
Category : Function
Synopsis : Pause script while an Octopus deployment completes
Component :
Role :
Functionality :
ModuleName : OctoVsts
description : {@{Text=Pauses the script util the specified build is complete. If the build is in-progress then a
progess bar is displayed. If the build failes then the reason is reported to the console.}}
syntax : @{syntaxItem=@{name=Wait-VstsBuild; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
examples : @{example=@{introduction=System.Management.Automation.PSObject[]; code=Wait-VstsBuild
'BuildDefinitionName' -buildNumber '201709.08.1-develop' -pipeBuild;
remarks=System.Management.Automation.PSObject[]; title=-------------------------- EXAMPLE 1
--------------------------}}
details : @{name=Wait-VstsBuild; description=System.Management.Automation.PSObject[]}
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
Name : Wait-VstsBuild
Category : Function
Synopsis : Pauses the script until the specified build is complete.
Component :
Role :
Functionality :
ModuleName : OctoVsts