WebRequestPSCmdlet WebRequestPSCmdlet WebRequestPSCmdlet 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
Derived

Constructors

WebRequestPSCmdlet() WebRequestPSCmdlet() WebRequestPSCmdlet() WebRequestPSCmdlet()

Properties

AllowUnencryptedAuthentication AllowUnencryptedAuthentication AllowUnencryptedAuthentication AllowUnencryptedAuthentication
Authentication Authentication Authentication Authentication
Body Body Body Body

gets or sets the Body property

Certificate Certificate Certificate Certificate

gets or sets the Certificate property

CertificateThumbprint CertificateThumbprint CertificateThumbprint CertificateThumbprint

gets or sets the CertificateThumbprint property

CommandOrigin CommandOrigin CommandOrigin CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime CommandRuntime CommandRuntime CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
ContentType ContentType ContentType ContentType

gets or sets the ContentType property

Credential Credential Credential Credential

gets or sets the Credential property

CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

(Inherited from Cmdlet)
CustomMethod CustomMethod CustomMethod CustomMethod
DisableKeepAlive DisableKeepAlive DisableKeepAlive DisableKeepAlive

gets or sets the DisableKeepAlive property

Events Events Events Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Form Form Form Form
Headers Headers Headers Headers

gets or sets the Headers property

Host Host Host Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
InFile InFile InFile InFile

gets or sets the InFile property

InvokeCommand InvokeCommand InvokeCommand InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider InvokeProvider InvokeProvider InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from PSCmdlet)
JobManager JobManager JobManager JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository JobRepository JobRepository JobRepository

Repostiory for jobs

(Inherited from PSCmdlet)
MaximumRedirection MaximumRedirection MaximumRedirection MaximumRedirection

gets or sets the RedirectMax property

MaximumRetryCount MaximumRetryCount MaximumRetryCount MaximumRetryCount
Method Method Method Method

gets or sets the Method property

MyInvocation MyInvocation MyInvocation MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
NoProxy NoProxy NoProxy NoProxy
OutFile OutFile OutFile OutFile

gets or sets the OutFile property

PagingParameters PagingParameters PagingParameters 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 ParameterSetName ParameterSetName ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
PassThru PassThru PassThru PassThru

gets or sets the PassThrough property

PreserveAuthorizationOnRedirect PreserveAuthorizationOnRedirect PreserveAuthorizationOnRedirect PreserveAuthorizationOnRedirect
Proxy Proxy Proxy Proxy

gets or sets the Proxy property

ProxyCredential ProxyCredential ProxyCredential ProxyCredential

gets or sets the ProxyCredential property

ProxyUseDefaultCredentials ProxyUseDefaultCredentials ProxyUseDefaultCredentials ProxyUseDefaultCredentials

gets or sets the ProxyUseDefaultCredentials property

Resume Resume Resume Resume
RetryIntervalSec RetryIntervalSec RetryIntervalSec RetryIntervalSec
SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SessionVariable SessionVariable SessionVariable SessionVariable

gets or sets the SessionVariable property

SkipCertificateCheck SkipCertificateCheck SkipCertificateCheck SkipCertificateCheck
SkipHeaderValidation SkipHeaderValidation SkipHeaderValidation SkipHeaderValidation
SslProtocol SslProtocol SslProtocol SslProtocol
Stopping Stopping Stopping Stopping

Is this command stopping?

(Inherited from Cmdlet)
TimeoutSec TimeoutSec TimeoutSec TimeoutSec

gets or sets the TimeOut property

Token Token Token Token
TransferEncoding TransferEncoding TransferEncoding TransferEncoding

gets or sets the TransferEncoding property

Uri Uri Uri Uri

gets or sets the Uri property

UseBasicParsing UseBasicParsing UseBasicParsing UseBasicParsing

gets or sets the parameter UseBasicParsing

UseDefaultCredentials UseDefaultCredentials UseDefaultCredentials UseDefaultCredentials

gets or sets the UseDefaultCredentials property

UserAgent UserAgent UserAgent UserAgent

gets or sets the UserAgent property

WebSession WebSession WebSession WebSession

gets or sets the Session property

Methods

BeginProcessing() BeginProcessing() BeginProcessing() 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) CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) Inherited from PSCmdlet
EndProcessing() EndProcessing() EndProcessing() 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) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) Inherited from PSCmdlet
GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String) 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) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) Inherited from PSCmdlet
GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) Inherited from PSCmdlet
GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) Inherited from PSCmdlet
Invoke() Invoke() Invoke() Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>() Invoke<T>() Invoke<T>() Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
ProcessRecord() ProcessRecord() ProcessRecord() ProcessRecord()

the main execution method for cmdlets derived from WebRequestPSCmdlet.

ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String) 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) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) 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) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) 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) ShouldProcess(String) ShouldProcess(String) 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) ShouldProcess(String, String) ShouldProcess(String, String) 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) ShouldProcess(String, String, String) ShouldProcess(String, String, String) 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) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) 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() StopProcessing() StopProcessing() StopProcessing()

Implementing ^C, after start the BeginGetResponse

ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error

(Inherited from Cmdlet)
TransactionAvailable() TransactionAvailable() TransactionAvailable() TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
VerifyInternetExplorerAvailable(Boolean) VerifyInternetExplorerAvailable(Boolean) VerifyInternetExplorerAvailable(Boolean) VerifyInternetExplorerAvailable(Boolean)

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

WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String) WriteDebug(String) WriteDebug(String) WriteDebug(String)

Display debug information

(Inherited from Cmdlet)
WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object) WriteObject(Object) WriteObject(Object) WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean) 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) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String) WriteVerbose(String) WriteVerbose(String) WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String) WriteWarning(String) WriteWarning(String) WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Applies to