Set-PSUEndpoint
SYNOPSIS
Updates an endpoint in PowerShell Universal.
SYNTAX
Id
Set-PSUEndpoint [-Id] <Int64> [-Method <String[]>] [-Url <String>] [-Description <String>]
[-Endpoint <ScriptBlock>] [-Path <String>] [-Authentication] [-Role <String[]>] [-RegEx] [-Tag <Tag[]>]
[-Timeout <Int32>] [-Environment <String>] [-PersistentLog] [-Documentation <String>] [-ComputerName <String>]
[-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
[-Cookies] [<CommonParameters>]InputObject
Set-PSUEndpoint [-InputObject] <Endpoint> [-Method <String[]>] [-Url <String>] [-Description <String>]
[-Endpoint <ScriptBlock>] [-Path <String>] [-Authentication] [-Role <String[]>] [-RegEx] [-Tag <Tag[]>]
[-Timeout <Int32>] [-Environment <String>] [-PersistentLog] [-Documentation <String>] [-ComputerName <String>]
[-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
[-Cookies] [<CommonParameters>]DESCRIPTION
Updates an endpoint in PowerShell Universal.
EXAMPLES
Example 1
Updates the endpoint with the ID of 1 to have the URL of '/test' and the method of 'GET'.
PARAMETERS
-AppToken
The AppToken that is used for calling the PowerShell Universal Management API. You can also call Connect-PSUServer before calling this cmdlet to set the AppToken for the entire session.
-Authentication
Enables authentication for the endpoint.
-ComputerName
Specifies the computer name or URL that should be called when accessing the PowerShell Universal Management API. You can also use Connect-PSUServer before calling this cmdlet to set the computer name for the entire session.
-Description
A description of the endpoint.
-Documentation
The documentation for the endpoint.
-Endpoint
The endpoint script block.
-Environment
The environment to run the endpoint in.
-Id
The ID of the endpoint to update.
-InputObject
The endpoint to update.
-Integrated
Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.
-Method
The HTTP method to use for the endpoint.
-Path
The path to the endpoint.
-PersistentLog
Enables persistent logging for the endpoint.
-RegEx
Enables regular expression matching for the endpoint.
-Role
The role that can access the endpoint.
-Tag
The tags for the endpoint.
-Timeout
The timeout for the endpoint in seconds.
-Url
The URL of the endpoint.
-UseDefaultCredentials
Use default credentials when connecting to the management API
-Credential
Credentials to login to the PowerShell Universal Management API.
-TrustCertificate
Whether the cmdlet should ignore certificate issues.
-Cookies
Reuses and persists authentication cookies for the current PowerShell session.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters.
INPUTS
PowerShellUniversal.Endpoint
OUTPUTS
System.Object
NOTES
RELATED LINKS
PERMISSIONS
The access token requires apis.endpoints/update to run this cmdlet remotely.
Last updated
Was this helpful?