WebRequestPSCmdlet Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Utility.dll

Package:

Microsoft.PowerShell.Commands.Utility v7.4.0

Base class for Invoke-RestMethod and Invoke-WebRequest commands.

public ref class WebRequestPSCmdlet abstract : System::Management::Automation::PSCmdlet

public abstract class WebRequestPSCmdlet : System.Management.Automation.PSCmdlet, IDisposable

type WebRequestPSCmdlet = class
    inherit PSCmdlet
    interface IDisposable

Public MustInherit Class WebRequestPSCmdlet
Inherits PSCmdlet
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

WebRequestPSCmdlet

Derived

Microsoft.PowerShell.Commands.InvokeRestMethodCommand

Microsoft.PowerShell.Commands.InvokeWebRequestCommand

Implements

IDisposable

Constructors

WebRequestPSCmdlet()

Properties

AllowInsecureRedirect	Gets or sets the AllowInsecureRedirect property used to follow HTTP redirects from HTTPS.
AllowUnencryptedAuthentication	Gets or sets the AllowUnencryptedAuthentication property.
Authentication	Gets or sets the Authentication property used to determine the Authentication method for the web session. Authentication does not work with UseDefaultCredentials. Authentication over unencrypted sessions requires AllowUnencryptedAuthentication. Basic: Requires Credential. OAuth/Bearer: Requires Token.
Body	Gets or sets the Body property.
Certificate	Gets or sets the Certificate property.
CertificateThumbprint	Gets or sets the CertificateThumbprint property.
CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
ConnectionTimeoutSeconds	Gets or sets the ConnectionTimeoutSeconds property.
ContentType	Gets or sets the ContentType property.
Credential	Gets or sets the Credential property.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
CustomMethod	Gets or sets the CustomMethod property.
DisableKeepAlive	Gets or sets the DisableKeepAlive property.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Form	Dictionary for use with RFC-7578 multipart/form-data submissions. Keys are form fields and their respective values are form values. A value may be a collection of form values or single form value.
Headers	Gets or sets the Headers property.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
HttpVersion	Gets or sets the HTTP Version property.
InFile	Gets or sets the InFile property.
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
MaximumRedirection	Gets or sets the RedirectMax property.
MaximumRetryCount	Gets or sets the MaximumRetryCount property, which determines the number of retries of a failed web request.
Method	Gets or sets the Method property.
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
NoProxy	Gets or sets the NoProxy property.
OperationTimeoutSeconds	Gets or sets the OperationTimeoutSeconds property.
OutFile	Gets or sets the OutFile property.
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
PassThru	Gets or sets the PassThrough property.
PreserveAuthorizationOnRedirect	Gets or sets the PreserveAuthorizationOnRedirect property.
PreserveHttpMethodOnRedirect	Gets or sets the PreserveHttpMethodOnRedirect property.
Proxy	Gets or sets the Proxy property.
ProxyCredential	Gets or sets the ProxyCredential property.
ProxyUseDefaultCredentials	Gets or sets the ProxyUseDefaultCredentials property.
Resume	Resumes downloading a partial or incomplete file. OutFile is required.
RetryIntervalSec	Gets or sets the RetryIntervalSec property, which determines the number seconds between retries.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
SessionVariable	Gets or sets the SessionVariable property.
SkipCertificateCheck	Gets or sets the SkipCertificateCheck property.
SkipHeaderValidation	Gets or sets the SkipHeaderValidation property.
SkipHttpErrorCheck	Gets or sets whether to skip checking HTTP status for error codes.
SslProtocol	Gets or sets the TLS/SSL protocol used by the Web Cmdlet.
Stopping	Is this command stopping? (Inherited from Cmdlet)
Token	Gets or sets the Token property. Token is required by Authentication OAuth and Bearer.
TransferEncoding	Gets or sets the TransferEncoding property.
UnixSocket	Gets or sets the UnixSocket property.
Uri	Gets or sets the Uri property.
UseBasicParsing	Deprecated. Gets or sets UseBasicParsing. This has no affect on the operation of the Cmdlet.
UseDefaultCredentials	Gets or sets the UseDefaultCredentials property.
UserAgent	Gets or sets the UserAgent property.
WebSession	Gets or sets the Session property.

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	Disposes the associated WebSession if it is not being used as part of a persistent session.
Dispose(Boolean)	Disposes the associated WebSession if it is not being used as part of a persistent session.
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	The main execution method for cmdlets derived from WebRequestPSCmdlet.
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	To implement ^C.
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)