Pipeworks | Invoke-WebCommand

Invoke-WebCommand

Invokes the commands within a Pipeworks web service

Getting Started
Play with Pipeworks
Connecting the Clouds
Join Windows and Web

Invoke-WebCommand (View Source)

Invokes the commands within a web service

Invokes the commands within a Pipeworks web service

AdSenseID

The AdSenseID used to monetize the command with Google AdSense

AdSlot

The AdSlotId used to monetize the command with Google AdSense

AllowDownload

If set, allows the command to be downloaded

AnalyticsId

The ID to use for Google Analytics tracking

AntiSocial

If set, will not add sharing links to the page

AsEmail

If provided, will lookup the user by email and will run commands as them. This is used for montezation, and should only be used directly very carefully.

AsTypename

If provided, the output will be rendered with a given type name. Changing this will allow you to override the look and feel of any object.

AsUserId

If provided, will lookup the user by email and will run commands as them. This is used for montezation, and should only be used directly very carefully.

BillingFrequency

The frequency for the subscription. By default, every month. Additional billing frequencies are used to create additional subscription options.

ConfirmationMessage

A custom confirmation message. If provided, -PromptForConfirmation is assumed.

ContentType

If set, will output the results of the command with a particular content type

CookieParameter

A table of parameters that will get their value from a cookie

Cost

The cost to run the command. Providing more than one cost is used to create additional subscription options.

Currency

The currency used for the transaction. By default, US Dollars. Additional currencies are treated as additional purchasing options

EscapeOutput

If set, escapes the output from the command, so it can be embedded into a webpage

HelpObject

If provided, will use this PSOBject for the command help.

Hidden

If set, the command will be hidden from web front ends, but can still be directly invoked.

HideParameter

If set, these parameters will be hidden from a command handler's input and output parameters. They will still be visible in help.

HideRelatedItem

If set, will hide the related items in command help.

IfLoggedInAs

Allows the command to be run only if the user is logged as one of the values. Values can be email addresses or userids. With email addresses, wildcards (i.e. *@microsoft.com) will be supported.

IgnoreManifest

If set, default values and other information the pipeworks manifest will be ignored. This allows you to execute commands with parameters that would not be available to a web user.

KeepHistory

If set, will keep a history of command input and output

KeepResult

If set, will keep results in the UseTrackingTable

KeepUserHistory

If set, will track parameters the user supplied for a command, and when they ran it.

LinkTo

Will link selected items to items from a command

MarginPercent

The margin on either side of the module content. Defaults to 7.5%.

MarginPercentLeft

The margin on the left side of the module content. Defaults to 7.5%.

MarginPercentRight

The margin on the left side of the module content. Defaults to 7.5%.

Method

Sets the method used for the web form. By default, POST is used, but Get is required if the command outputs binary data (like image streams)

MobileWebFrontEnd

The Mobile Web Front End for a command, declared in HTML. Setting a Mobile Web Front End will override the default front end with any web page.

NoAjax

If provided, will not use ajax while running the command

NoOutputMessage

The string shown to a person when the command does not throw an error but has not output

Notify

If provided, will use window.external.notify to provide a notification message when complete.

OutputProperty

The properties from the output to display

ParameterAlias

A table of parameter URL aliases. These allow URLs to the sevice to become shorter.

ParameterFromSetting

Parameters that are taken from the web.config settings

ParameterFromUser

Parameters that are taken from the user settings

PaymentProcessed

If set, the payment has been processed by the server. This is used internally to finalize actions after payments.

PayNow

If set, makes the person pay before the command is actually executed

PipeInto

Any additional commands that the command can be piped into. In the Sandbox service, these commands will be allowed as well

PlainOutput

If set, will output the results of the command without encasing it in a container

PromptForConfirmation

If set, prompts for confirmation before a command will be run

RedirectIn

The amount of time to wait before redirecting (by default, no time)

RedirectTo

A location to redirect to when the command is complete.

RequireAppKey

If set, will require an app key to run the command. Logged in users will automatically use their app key

RequireLogin

If set, will only allow logged-in users to run the command

RunInSandBox

If set, will allow the command to be run in a sandbox

If set, the command will be enabled as a web service. This parameter is implied by almost every other parameter (except -ShowHelp, which contravenes it), and is primarily present for backwards-compatibility.

RunWithoutInput

If set, allows the command to be run without any parameters. This is especially useful for Get- commands.

SaveInCookie

If set, will save the output in a cookie.

ServiceUrl

The Module Service URL. If this is not set, this will automatically be the url to the command directory.

SessionThrottle

If SessionThrottle is set, the request handler will wait for at least the -SessionThrottle before allowing the user to re-run the command. This can be useful in mitigating Denial of Service attacks as well as providing an avenue to upsell (i.e. a free user can run a command once a minute, where as a premium user can run requests without the throttle)

ShowHelp

If set, will show the help for a command, but will not run it

StorageAccountSetting

The name of the web.config setting containing the storage account name. Required for tracking.

StorageKeySetting

The name of the web.config setting containing the storage account key. Required for tracking.

Style

The CSS Style section to use for the page

SubscribeNow

If set, makes the person subscribe before the command is actually executed

TrackParameter

If set, will track unique parameters in the input, such as the number of times an input value is used

TrackProperty

If set, will track unique properties of the output, such as the number of times an item with a particular ID is output.

UserPartition

The partition in a usertable containing data

UserTable

If set, will track uses of an appkey.

UseTrackingTable

If set, will track uses of the command.

ValidUserPartition

Validates that users are allowed to run the command by checking objects with a Condition property found in ValidUserPartition

WebFrontEnd

The Web Front End for a command, declared in HTML. Setting a Web Front End will override the default front end with any web page.

Examples

Example 1

----------------------- EXAMPLE 1 -------------------------- PS C:\># Invoke-WebCommand is the Pipeworks function runs commands in a web service. It's automatically called in many places, but can be used on the command line to emulate and debug running on the web.

Provided By

Powered With