WebRequestPSCmdlet Class

Definition

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
type WebRequestPSCmdlet = class
    inherit PSCmdlet
Public MustInherit Class WebRequestPSCmdlet
Inherits PSCmdlet
Inheritance
WebRequestPSCmdlet
Derived

Constructors

WebRequestPSCmdlet()

Properties

AllowUnencryptedAuthentication
Authentication
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)
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
DisableKeepAlive

gets or sets the DisableKeepAlive property

Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Form
Headers

gets or sets the Headers property

Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
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

Repostiory for jobs

(Inherited from PSCmdlet)
MaximumRedirection

gets or sets the RedirectMax property

MaximumRetryCount
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
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
Proxy

gets or sets the Proxy property

ProxyCredential

gets or sets the ProxyCredential property

ProxyUseDefaultCredentials

gets or sets the ProxyUseDefaultCredentials property

Resume
RetryIntervalSec
SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SessionVariable

gets or sets the SessionVariable property

SkipCertificateCheck
SkipHeaderValidation
SslProtocol
Stopping

Is this command stopping?

(Inherited from Cmdlet)
TimeoutSec

gets or sets the TimeOut property

Token
TransferEncoding

gets or sets the TransferEncoding property

Uri

gets or sets the Uri property

UseBasicParsing

gets or sets the parameter UseBasicParsing

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)
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) (Inherited from PSCmdlet)
GetVariableValue(String, Object) (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)

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)
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, 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)
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)
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, 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, 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)
StopProcessing()

Implementing ^C, after start the BeginGetResponse

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)
VerifyInternetExplorerAvailable(Boolean)

Verifies that Internet Explorer is available, and that its first-run configuration is complete.

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)

Writes the object to the output pipe.

(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)
WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Applies to