Asynchronous Operation commands

category Zend
package Zend_Service_WindowsAzure_CommandLine
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
command-handler getasynchronousoperation
command-handler-description Windows Azure Asynchronous Operation commands
command-handler-header Windows Azure SDK for PHP
command-handler-header Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
command-handler-footer Note: Parameters that are common across all commands can be stored
command-handler-footer in two dedicated environment variables.
command-handler-footer - SubscriptionId: The Windows Azure Subscription Id to operate on.
command-handler-footer - Certificate The Windows Azure .cer Management Certificate.
command-handler-footer
command-handler-footer All commands support the --ConfigurationFile or -F parameter.
command-handler-footer The parameter file is a simple INI file carrying one parameter
command-handler-footer value per line. It accepts the same parameters as one can
command-handler-footer use from the command line command.
inherited_from \Zend_Service_Console_Command

 Methods

Bootstrap the shell command.

bootstrap(array $argv) 
InheritedStatic

Parameters

$argv

array

PHP argument values.

Gets the handler.

getHandler() : array
Inherited

Returns

array

Get information for a specific asynchronous request.

getInfoCommand($subscriptionId, $certificate, $certificatePassphrase, $requestId) 
command-name GetInfo
command-description Get information for a specific asynchronous request.
command-parameter-for $subscriptionId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
command-parameter-for $certificate Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
command-parameter-for $certificatePassphrase Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --Passphrase|-p Required. The certificate passphrase. If not specified, a prompt will be displayed.
command-parameter-for $requestId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --RequestId|-r Required. The value returned by a call that starts an asynchronous operation to monitor.
command-example Get information for a specific asynchronous operation:
command-example GetInfo -sid:"" -cert:"mycert.pem" -r:"dab87a4b70e94a36805f5af2d20fc593"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$requestId

Displays the help information.

helpCommand() 
Inherited
command-name
command-name -h
command-name -help
command-description Displays the current help information.

Replaces PHP's error handler

phpstderr(mixed $errno, mixed $errstr, mixed $errfile, mixed $errline) 
InheritedStatic

Parameters

$errno

mixed

$errstr

mixed

$errfile

mixed

$errline

mixed

Replaces PHP's exception handler

phpstdex(\Exception $exception) 
InheritedStatic

Parameters

$exception

\Exception

Sets the handler.

setHandler(array $handler) : \Zend_Service_Console_Command
Inherited

Parameters

$handler

array

Returns

\Zend_Service_Console_Command

Writes output to STDERR, followed by a newline (optional)

stderr(string $errorMessage, string $newLine = true
InheritedStatic

Parameters

$errorMessage

string

$newLine

string

Wait for a specific asynchronous request to complete.

waitForCommand($subscriptionId, $certificate, $certificatePassphrase, $requestId, $interval = 250
command-name WaitFor
command-description Wait for a specific asynchronous request to complete.
command-parameter-for $subscriptionId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
command-parameter-for $certificate Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
command-parameter-for $certificatePassphrase Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --Passphrase|-p Required. The certificate passphrase. If not specified, a prompt will be displayed.
command-parameter-for $requestId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --RequestId|-r Required. The value returned by a call that starts an asynchronous operation to monitor.
command-parameter-for $interval Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Interval|-i Optional. The interval between two status checks (in milliseconds).
command-example Wait for a specific asynchronous operation:
command-example WaitFor -sid:"" -cert:"mycert.pem" -r:"dab87a4b70e94a36805f5af2d20fc593"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$requestId

$interval

Builds the handler model.

_buildModel() : array
InheritedStatic

Returns

array

Display information on an object

_displayObjectInformation(object $object, array $propertiesToDump = array()
Inherited

Parameters

$object

object

Object

$propertiesToDump

array

Property names to display

Finds the value for a specific docComment.

_findValueForDocComment(string $docCommentName, \unknown_type $docComment) : array
InheritedStatic

Parameters

$docCommentName

string

Comment name

$docComment

\unknown_type

Comment object

Returns

array

 Properties

 

The handler.

$_handler : array

Default