InvokeRestMethodCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Utility.dll

Package:

Microsoft.PowerShell.Commands.Utility v7.4.0

The Invoke-RestMethod command This command makes an HTTP or HTTPS request to a web service, and returns the response in an appropriate way. Intended to work against the wide spectrum of "RESTful" web services currently deployed across the web.

public ref class InvokeRestMethodCommand : Microsoft::PowerShell::Commands::WebRequestPSCmdlet

[System.Management.Automation.Cmdlet("Invoke", "RestMethod", DefaultParameterSetName="StandardMethod", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096706")]
[System.Runtime.CompilerServices.Nullable(0)]
[System.Runtime.CompilerServices.NullableContext(2)]
public class InvokeRestMethodCommand : Microsoft.PowerShell.Commands.WebRequestPSCmdlet

[<System.Management.Automation.Cmdlet("Invoke", "RestMethod", DefaultParameterSetName="StandardMethod", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096706")>]
[<System.Runtime.CompilerServices.Nullable(0)>]
[<System.Runtime.CompilerServices.NullableContext(2)>]
type InvokeRestMethodCommand = class
    inherit WebRequestPSCmdlet

Public Class InvokeRestMethodCommand
Inherits WebRequestPSCmdlet

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

WebRequestPSCmdlet

InvokeRestMethodCommand

Attributes

CmdletAttribute NullableAttribute NullableContextAttribute

Constructors

InvokeRestMethodCommand()

Properties

AllowInsecureRedirect	Gets or sets the AllowInsecureRedirect property used to follow HTTP redirects from HTTPS. (Inherited from WebRequestPSCmdlet)
AllowUnencryptedAuthentication	Gets or sets the AllowUnencryptedAuthentication property. (Inherited from WebRequestPSCmdlet)
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. (Inherited from WebRequestPSCmdlet)
Body	Gets or sets the Body property. (Inherited from WebRequestPSCmdlet)
Certificate	Gets or sets the Certificate property. (Inherited from WebRequestPSCmdlet)
CertificateThumbprint	Gets or sets the CertificateThumbprint property. (Inherited from WebRequestPSCmdlet)
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. (Inherited from WebRequestPSCmdlet)
ContentType	Gets or sets the ContentType property. (Inherited from WebRequestPSCmdlet)
Credential	Gets or sets the Credential property. (Inherited from WebRequestPSCmdlet)
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. (Inherited from WebRequestPSCmdlet)
DisableKeepAlive	Gets or sets the DisableKeepAlive property. (Inherited from WebRequestPSCmdlet)
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
FollowRelLink	Enable automatic following of rel links.
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. (Inherited from WebRequestPSCmdlet)
Headers	Gets or sets the Headers property. (Inherited from WebRequestPSCmdlet)
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
HttpVersion	Gets or sets the HTTP Version property. (Inherited from WebRequestPSCmdlet)
InFile	Gets or sets the InFile property. (Inherited from WebRequestPSCmdlet)
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)
MaximumFollowRelLink	Gets or sets the maximum number of rel links to follow.
MaximumRedirection	Gets or sets the RedirectMax property. (Inherited from WebRequestPSCmdlet)
MaximumRetryCount	Gets or sets the MaximumRetryCount property, which determines the number of retries of a failed web request. (Inherited from WebRequestPSCmdlet)
Method	Gets or sets the Method property. (Inherited from WebRequestPSCmdlet)
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
NoProxy	Gets or sets the NoProxy property. (Inherited from WebRequestPSCmdlet)
OperationTimeoutSeconds	Gets or sets the OperationTimeoutSeconds property. (Inherited from WebRequestPSCmdlet)
OutFile	Gets or sets the OutFile property. (Inherited from WebRequestPSCmdlet)
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. (Inherited from WebRequestPSCmdlet)
PreserveAuthorizationOnRedirect	Gets or sets the PreserveAuthorizationOnRedirect property. (Inherited from WebRequestPSCmdlet)
PreserveHttpMethodOnRedirect	Gets or sets the PreserveHttpMethodOnRedirect property. (Inherited from WebRequestPSCmdlet)
Proxy	Gets or sets the Proxy property. (Inherited from WebRequestPSCmdlet)
ProxyCredential	Gets or sets the ProxyCredential property. (Inherited from WebRequestPSCmdlet)
ProxyUseDefaultCredentials	Gets or sets the ProxyUseDefaultCredentials property. (Inherited from WebRequestPSCmdlet)
ResponseHeadersVariable	Gets or sets the ResponseHeadersVariable property.
Resume	Resumes downloading a partial or incomplete file. OutFile is required. (Inherited from WebRequestPSCmdlet)
RetryIntervalSec	Gets or sets the RetryIntervalSec property, which determines the number seconds between retries. (Inherited from WebRequestPSCmdlet)
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
SessionVariable	Gets or sets the SessionVariable property. (Inherited from WebRequestPSCmdlet)
SkipCertificateCheck	Gets or sets the SkipCertificateCheck property. (Inherited from WebRequestPSCmdlet)
SkipHeaderValidation	Gets or sets the SkipHeaderValidation property. (Inherited from WebRequestPSCmdlet)
SkipHttpErrorCheck	Gets or sets whether to skip checking HTTP status for error codes. (Inherited from WebRequestPSCmdlet)
SslProtocol	Gets or sets the TLS/SSL protocol used by the Web Cmdlet. (Inherited from WebRequestPSCmdlet)
StatusCodeVariable	Gets or sets the variable name to use for storing the status code from the response.
Stopping	Is this command stopping? (Inherited from Cmdlet)
TimeoutSec	Gets or sets the TimeOut property. (Inherited from WebRequestPSCmdlet)
Token	Gets or sets the Token property. Token is required by Authentication OAuth and Bearer. (Inherited from WebRequestPSCmdlet)
TransferEncoding	Gets or sets the TransferEncoding property. (Inherited from WebRequestPSCmdlet)
UnixSocket	Gets or sets the UnixSocket property. (Inherited from WebRequestPSCmdlet)
Uri	Gets or sets the Uri property. (Inherited from WebRequestPSCmdlet)
UseBasicParsing	Deprecated. Gets or sets UseBasicParsing. This has no affect on the operation of the Cmdlet. (Inherited from WebRequestPSCmdlet)
UseDefaultCredentials	Gets or sets the UseDefaultCredentials property. (Inherited from WebRequestPSCmdlet)
UserAgent	Gets or sets the UserAgent property. (Inherited from WebRequestPSCmdlet)
WebSession	Gets or sets the Session property. (Inherited from WebRequestPSCmdlet)

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. (Inherited from WebRequestPSCmdlet)
Dispose(Boolean)	Disposes the associated WebSession if it is not being used as part of a persistent session. (Inherited from WebRequestPSCmdlet)
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. (Inherited 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. (Inherited from WebRequestPSCmdlet)
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. (Inherited from WebRequestPSCmdlet)
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)