Endpoint version error response type
Get-APIEndpointVersionErrorResponseType
Synopsis
Get an error response.
Syntax
name (Default)
Get-APIEndpointVersionErrorResponseType -APIEndpointName <String> -VersionNumber <String> -Type <String>
[-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
id
Get-APIEndpointVersionErrorResponseType -APIEndpointID <Int32> -VersionNumber <String> -Type <String>
[-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Description
Returns a customizable error response of the selected type.
Parameters
-APIEndpointID
The ID for the endpoint.
Type: Int32
Parameter Sets: id
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-APIEndpointName
The name of the endpoint.
Type: String
Parameter Sets: name
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccountSwitchKey
Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run Get-AccountSwitchKey
to list the account switch keys available to you.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EdgeRCFile
EdgeRC file to authenticate your command. Defaults to ~/.edgerc
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Section
EdgeRC section to retrieve authentication credentials from. Defaults to default
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type
The type of the customizable error response.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: API_KEY_INVALID, API_KEY_FORBIDDEN, QUOTA_EXCEEDED, JWT_SIGNATURE_INVALID, JWT_CLAIM_VALUE_INVALID
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VersionNumber
The ID for the endpoint version. Defaults to latest
.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: False
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
None
Outputs
System.Object
Related links
Updated 7 days ago