New-PSURateLimit
SYNOPSIS
Creates a new rate limit for the PowerShell Universal server.
SYNTAX
New-PSURateLimit [-Name <String>] -Endpoint <String> -Period <TimeSpan> -Limit <Int32> [-ComputerName <String>]
[-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
[-Cookies] [<CommonParameters>]DESCRIPTION
Creates a new rate limit for the PowerShell Universal server. Rate limits affect the entire server. You can limit the scope of the rate limit based on URLs.
Rate limit configurations are stored in .universal/rateLimits.ps1
You can also use this cmdlet to create rate limits through the REST API.
You can use Set-PSUSetting to configure allow lists for IPs, endpoints and computer names that are not affected by the rate limiting.
EXAMPLES
Example 1
Creates a new rate limit that prevents the user from calling the /myEndpoint endpoint more than 100 times in 10 minutes.
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.
-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.
-Endpoint
The URL of the endpoint to rate limit. The URL can contain wildcards using the * character.
-Limit
The number of requests over the period.
-Period
The period of time to enforce the limit.
-UseDefaultCredentials
Use default credentials when connecting to the management API
-Integrated
Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.
-Credential
Credentials to login to the PowerShell Universal Management API.
-TrustCertificate
Whether the cmdlet should ignore certificate issues.
-Name
The name of this rate limit rule.
-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
None
OUTPUTS
System.Object
NOTES
RELATED LINKS
Last updated
Was this helpful?