Zend Framework API Documentation
Back to top  

Service 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 service
command-handler-description Windows Azure Service 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.

Create hosted service account.

createCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $label, $description, $location, $affinityGroup, $waitForOperation = false) 
command-name Create
command-description Create hosted service account.
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 $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Name Required. The hosted service account name.
command-parameter-for $label Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Label Required. A label for the hosted service.
command-parameter-for $description Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Description Optional. A description for the hosted service.
command-parameter-for $location Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Location Required if AffinityGroup is not specified. The location where the hosted service will be created.
command-parameter-for $affinityGroup Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --AffinityGroup Required if Location is not specified. The name of an existing affinity group associated with this subscription.
command-parameter-for $waitForOperation Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --WaitFor|-w Optional. Wait for the operation to complete?
command-example Create hosted service account in West Europe
command-example Create -p:"phpazure" --Name:"phptestsdk2" --Label:"phptestsdk2" --Location:"West Europe"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$label

$description

$location

$affinityGroup

$waitForOperation

Delete hosted service account.

deleteCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $waitForOperation = false) 
command-name Delete
command-description Delete hosted service account.
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 $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Name Required. The hosted service account name.
command-parameter-for $waitForOperation Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --WaitFor|-w Optional. Wait for the operation to complete?
command-example Delete hosted service
command-example Delete -p:"phpazure" --Name:"phptestsdk2"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$waitForOperation

Gets the handler.

getHandler() : array
Inherited

Returns

array

Get hosted service account properties.

getPropertiesCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName) 
command-name GetProperties
command-description Get hosted service account properties.
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 $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Name Required. The hosted service account name to operate on.
command-example Get hosted service account properties for service "phptest":
command-example GetProperties -sid:"" -cert:"mycert.pem"
command-example --Name:"phptest"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

Get hosted service account property.

getPropertyCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $property) 
command-name GetProperty
command-description Get storage account property.
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 $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Name Required. The hosted service account name to operate on.
command-parameter-for $property Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Property|-prop Required. The property to retrieve for the hosted service account.
command-example Get hosted service account property "Url" for service "phptest":
command-example GetProperty -sid:"" -cert:"mycert.pem"
command-example --Name:"phptest" --Property:Url

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$property

Displays the help information.

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

List hosted service accounts for a specified subscription.

listCommand($subscriptionId, $certificate, $certificatePassphrase) 
command-name List
command-description List hosted service accounts for a specified subscription.
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-example List hosted service accounts for subscription:
command-example List -sid:"" -cert:"mycert.pem"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

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

Update hosted service account.

updateCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $label, $description, $waitForOperation = false) 
command-name Update
command-description Update hosted service account.
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 $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Name Required. The hosted service account name.
command-parameter-for $label Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Label Required. A label for the hosted service.
command-parameter-for $description Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Description Optional. A description for the hosted service.
command-parameter-for $waitForOperation Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --WaitFor|-w Optional. Wait for the operation to complete?
command-example Update hosted service
command-example Update -p:"phpazure" --Name:"phptestsdk2" --Label:"New label" --Description:"Some description"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$label

$description

$waitForOperation

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