Microsoft_Console
[ class tree: Microsoft_Console ] [ index: Microsoft_Console ] [ all elements ]
Packages:
Microsoft_WindowsAzure
Microsoft
Microsoft_Console
Microsoft_Http
Microsoft_Log
Microsoft_SqlAzure
Microsoft_SqlAzure_CommandLine
Microsoft_Uri
Microsoft_WindowsAzure_CommandLine
Microsoft_WindowsAzure_Storage

Source for file GetAsynchronousOperation.php

Documentation is available at GetAsynchronousOperation.php

  1. <?php
  2. /**
  3.  * Copyright (c) 2009 - 2011, RealDolmen
  4.  * All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions are met:
  8.  *     * Redistributions of source code must retain the above copyright
  9.  *       notice, this list of conditions and the following disclaimer.
  10.  *     * Redistributions in binary form must reproduce the above copyright
  11.  *       notice, this list of conditions and the following disclaimer in the
  12.  *       documentation and/or other materials provided with the distribution.
  13.  *     * Neither the name of RealDolmen nor the
  14.  *       names of its contributors may be used to endorse or promote products
  15.  *       derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY RealDolmen ''AS IS'' AND ANY
  18.  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20.  * DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY
  21.  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22.  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  *
  28.  * @category   Microsoft
  29.  * @package    Microsoft_Console
  30.  * @subpackage Exception
  31.  * @version    $Id: Exception.php 55733 2011-01-03 09:17:16Z unknown $
  32.  * @copyright  Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
  33.  * @license    http://phpazure.codeplex.com/license
  34.  */
  35.  
  36. /**
  37.  * @see Microsoft_AutoLoader
  38.  */
  39. require_once dirname(__FILE__) . '/../../AutoLoader.php';
  40.  
  41. /**
  42.  * Asynchronous Operation commands
  43.  * 
  44.  * @category   Microsoft
  45.  * @package    Microsoft_WindowsAzure_CommandLine
  46.  * @copyright  Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
  47.  * @license    http://phpazure.codeplex.com/license
  48.  * 
  49.  * @command-handler getasynchronousoperation
  50.  * @command-handler-description Windows Azure Asynchronous Operation commands
  51.  * @command-handler-header Windows Azure SDK for PHP
  52.  * @command-handler-header Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
  53.  * @command-handler-footer Note: Parameters that are common across all commands can be stored
  54.  * @command-handler-footer in two dedicated environment variables.
  55.  * @command-handler-footer - SubscriptionId: The Windows Azure Subscription Id to operate on.
  56.  * @command-handler-footer - Certificate The Windows Azure .cer Management Certificate.
  57.  * @command-handler-footer
  58.  * @command-handler-footer All commands support the --ConfigurationFile or -F parameter.
  59.  * @command-handler-footer The parameter file is a simple INI file carrying one parameter
  60.  * @command-handler-footer value per line. It accepts the same parameters as one can
  61.  * @command-handler-footer use from the command line command.
  62.  */
  63. class Microsoft_WindowsAzure_CommandLine_GetAsynchronousOperation
  64.     extends Microsoft_Console_Command
  65. {    
  66.     /**
  67.      * Get information for a specific asynchronous request.
  68.      * 
  69.      * @command-name GetInfo
  70.      * @command-description Get information for a specific asynchronous request.
  71.      * @command-parameter-for $subscriptionId Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile|Microsoft_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
  72.      * @command-parameter-for $certificate Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile|Microsoft_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
  73.      * @command-parameter-for $certificatePassphrase Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile --Passphrase|-p The certificate passphrase. If not specified, a prompt will be displayed.
  74.      * @command-parameter-for $requestId Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile|Microsoft_Console_Command_ParameterSource_StdIn --RequestId|-r Required. The value returned by a call that starts an asynchronous operation to monitor.
  75.      * @command-example Get information for a specific asynchronous operation:
  76.      * @command-example GetInfo -sid="<your_subscription_id>" -cert="mycert.pem" -r="dab87a4b70e94a36805f5af2d20fc593"
  77.      */
  78.     public function getInfoCommand($subscriptionId, $certificate, $certificatePassphrase, $requestId)
  79.     {
  80.         $client = new Microsoft_WindowsAzure_Management_Client($subscriptionId, $certificate, $certificatePassphrase);
  81.         $result = $client->getOperationStatus($requestId);
  82.  
  83.         $this->_displayObjectInformation($result, array('ID', 'Status', 'ErrorMessage'));
  84.     }
  85.     
  86.     /**
  87.      * Wait for a specific asynchronous request to complete.
  88.      * 
  89.      * @command-name WaitFor
  90.      * @command-description Wait for a specific asynchronous request to complete.
  91.      * @command-parameter-for $subscriptionId Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile|Microsoft_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
  92.      * @command-parameter-for $certificate Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile|Microsoft_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
  93.      * @command-parameter-for $certificatePassphrase Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile --Passphrase|-p The certificate passphrase. If not specified, a prompt will be displayed.
  94.      * @command-parameter-for $requestId Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile|Microsoft_Console_Command_ParameterSource_StdIn --RequestId|-r Required. The value returned by a call that starts an asynchronous operation to monitor.
  95.      * @command-parameter-for $interval Microsoft_Console_Command_ParameterSource_Argv|Microsoft_Console_Command_ParameterSource_ConfigFile --Interval|-i Optional. The interval between two status checks (in milliseconds).
  96.      * @command-example Wait for a specific asynchronous operation:
  97.      * @command-example WaitFor -sid="<your_subscription_id>" -cert="mycert.pem" -r="dab87a4b70e94a36805f5af2d20fc593"
  98.      */
  99.     public function waitForCommand($subscriptionId, $certificate, $certificatePassphrase, $requestId, $interval = 250)
  100.     {
  101.         $client = new Microsoft_WindowsAzure_Management_Client($subscriptionId, $certificate, $certificatePassphrase);
  102.         $client->waitForOperation($requestId, $interval);
  103.     }
  104. }
  105.  
  106. Microsoft_Console_Command::bootstrap($_SERVER['argv']);
Documentation generated on Sat, 03 Dec 2011 13:59:25 +0100 by phpDocumentor 1.4.3