< Back
Get-AzureDevOpsAgentInstallParameters
Post
NAME Get-AzureDevOpsAgentInstallParameters
SYNOPSIS
Generate a set of parameter for CI Agent or Deployment Agent
SYNTAX
Get-AzureDevOpsAgentInstallParameters [[-poolName] <String>] [[-deploymentGroup] <String>] [[-projectName]
<String>] [[-deploymentGroupTags] <String[]>] [[-agentName] <String>] [[-organizationUri] <String>] [[-vstsToken]
<String>] [-runasservice] [[-credential] <PSCredential>] [<CommonParameters>]
DESCRIPTION
Generate a set of parameter see also:
https://docs.microsoft.com/en-us/azure/ ... ure-devops
PARAMETERS
-poolName <String>
Name of the Pool
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-deploymentGroup <String>
Name of the Deployment Group
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-projectName <String>
Name of the Azure DevOps Project
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-deploymentGroupTags <String[]>
Optional Tags for the Agent, if it is used as a deployment group agent
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-agentName <String>
Name of the agent
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-organizationUri <String>
Uri of your Azure DevOps organization.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vstsToken <String>
VSTS-Token to use PAT authentication.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-runasservice [<SwitchParameter>]
Add the agent as service.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-credential <PSCredential>
Optional Credentials for Service Registration
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? 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
OUTPUTS
NOTES
General notes
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Install Agent at a Deployment Pool:
Get-AzureDevOpsAgentInstallParameters -deploymentGroup $poolName -projectName $projectName -organizationUri
$devOpsURL -vstsToken $vstsToken -agentName $containerName -credential $credential -runasservice
Install Agent at an Agent Pool:
Get-AzureDevOpsAgentInstallParameters -poolName $pool.name -organizationUri $devOpsURL -vstsToken $vstsToken
-agentName $containerName -credential $credential -runasservice
RELATED LINKS
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Get-AzureDevOpsAgentUnInstallParameters; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : Get-AgentUnInstallParams
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-AzureDevOpsAgentUnInstallParameters [[-vstsToken] <string>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-AzureDevOpsAgentUnInstallParameters
Category : Function
Component :
Role :
Functionality :
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Add-AzureDevOpsAgentPool; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AzureDevOpsAgentPool [[-name] <string>] [[-organizationUri] <string>] [[-vstsToken]
<string>] [[-autoProvision] <bool>] [[-autoSize] <bool>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AzureDevOpsAgentPool
Category : Function
Component :
Role :
Functionality :
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Add-AzureDevOpsDeploymentGroup; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AzureDevOpsDeploymentGroup [[-name] <string>] [[-organizationUri] <string>]
[[-projectName] <string>] [[-vstsToken] <string>] [[-description] <string>] [[-poolType]
<string>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AzureDevOpsDeploymentGroup
Category : Function
Component :
Role :
Functionality :
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Add-AzureDevOpsVariableGroup; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AzureDevOpsVariableGroup [[-name] <string>] [[-projectName] <string>]
[[-organizationUri] <string>] [[-description] <string>] [[-variables] <hashtable>]
[[-secrets] <hashtable>] [[-vstsToken] <string>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AzureDevOpsVariableGroup
Category : Function
Component :
Role :
Functionality :
SYNOPSIS
Generate a set of parameter for CI Agent or Deployment Agent
SYNTAX
Get-AzureDevOpsAgentInstallParameters [[-poolName] <String>] [[-deploymentGroup] <String>] [[-projectName]
<String>] [[-deploymentGroupTags] <String[]>] [[-agentName] <String>] [[-organizationUri] <String>] [[-vstsToken]
<String>] [-runasservice] [[-credential] <PSCredential>] [<CommonParameters>]
DESCRIPTION
Generate a set of parameter see also:
https://docs.microsoft.com/en-us/azure/ ... ure-devops
PARAMETERS
-poolName <String>
Name of the Pool
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-deploymentGroup <String>
Name of the Deployment Group
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-projectName <String>
Name of the Azure DevOps Project
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-deploymentGroupTags <String[]>
Optional Tags for the Agent, if it is used as a deployment group agent
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-agentName <String>
Name of the agent
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-organizationUri <String>
Uri of your Azure DevOps organization.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vstsToken <String>
VSTS-Token to use PAT authentication.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-runasservice [<SwitchParameter>]
Add the agent as service.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-credential <PSCredential>
Optional Credentials for Service Registration
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? 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
OUTPUTS
NOTES
General notes
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Install Agent at a Deployment Pool:
Get-AzureDevOpsAgentInstallParameters -deploymentGroup $poolName -projectName $projectName -organizationUri
$devOpsURL -vstsToken $vstsToken -agentName $containerName -credential $credential -runasservice
Install Agent at an Agent Pool:
Get-AzureDevOpsAgentInstallParameters -poolName $pool.name -organizationUri $devOpsURL -vstsToken $vstsToken
-agentName $containerName -credential $credential -runasservice
RELATED LINKS
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Get-AzureDevOpsAgentUnInstallParameters; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : Get-AgentUnInstallParams
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-AzureDevOpsAgentUnInstallParameters [[-vstsToken] <string>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-AzureDevOpsAgentUnInstallParameters
Category : Function
Component :
Role :
Functionality :
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Add-AzureDevOpsAgentPool; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AzureDevOpsAgentPool [[-name] <string>] [[-organizationUri] <string>] [[-vstsToken]
<string>] [[-autoProvision] <bool>] [[-autoSize] <bool>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AzureDevOpsAgentPool
Category : Function
Component :
Role :
Functionality :
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Add-AzureDevOpsDeploymentGroup; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AzureDevOpsDeploymentGroup [[-name] <string>] [[-organizationUri] <string>]
[[-projectName] <string>] [[-vstsToken] <string>] [[-description] <string>] [[-poolType]
<string>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AzureDevOpsDeploymentGroup
Category : Function
Component :
Role :
Functionality :
CommonParameters : False
WorkflowCommonParameters : False
details : @{name=Add-AzureDevOpsVariableGroup; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AzureDevOpsVariableGroup [[-name] <string>] [[-projectName] <string>]
[[-organizationUri] <string>] [[-description] <string>] [[-variables] <hashtable>]
[[-secrets] <hashtable>] [[-vstsToken] <string>]
ModuleName : AzureDevOpsAPIUtils
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AzureDevOpsVariableGroup
Category : Function
Component :
Role :
Functionality :