Update-VSTeamServiceEndpoint
SYNOPSIS
Updates an existing service connection
SYNTAX
Update-VSTeamServiceEndpoint [-id] <String> -object <Hashtable> [-Force] -ProjectName <String> [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing service connection
EXAMPLES
Example 1
$endpointPayload = @{
name = "MyNewEndpoint";
type = "generic";
url = "https://api.endpoint.com";
isShared = $false
}
Update-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -Object $endpointPayload
Updates the service endpoint with ID `12345678-abcd-1234-abcd-1234567890ab` with the specified properties in the `$endpointPayload` hashtable.
Example 2
$endpointPayload = @{
name = "MyNewEndpoint";
type = "generic";
url = "https://api.endpoint.com";
isShared = $false
}
Update-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -Object $endpointPayload -ProjectName "MyProject"
Updates the service endpoint within the "MyProject" project with ID `12345678-abcd-1234-abcd-1234567890ab` with the specified properties in the `$endpointPayload` hashtable.
Example 3
$endpointPayload = @{
name = "MyNewEndpoint";
type = "generic";
url = "https://api.endpoint.com";
isShared = $false
}
Update-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -Object $endpointPayload -Force
Updates the service endpoint with ID `12345678-abcd-1234-abcd-1234567890ab` with the specified properties in the `$endpointPayload` hashtable and forces the update without any confirmation prompts.
PARAMETERS
-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: True
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
-id
UUID of existing services endpoint from AzD
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-object
Hashtable of payload for REST call
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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
vsteam_lib.ServiceEndpoint
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
Add-VSTeamServiceFabricEndpoint