Zend Framework API Documentation » \Zend_Service_WindowsAzure_CommandLine

Deployment 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	deployment
command-handler-description	Windows Azure Deployment 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.

Creates a deployment from a local package file and service configuration.

createFromLocalCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentName, $label, $staging = false, $production = false, $packageLocation, $serviceConfigurationLocation, $storageAccount, $startImmediately = true, $warningsAsErrors = false, $waitForOperation = false)

command-name	CreateFromLocal
command-description	Creates a deployment from a local package file and service configuration.
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	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --DeploymentName Required. The name for the deployment.
command-parameter-for	$label Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Label Required. The label for the deployment.
command-parameter-for	$staging Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Staging Host the service in the staging slot.
command-parameter-for	$production Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Production Host the service in the staging slot.
command-parameter-for	$packageLocation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --PackageLocation Required. The location of the .cspkg file.
command-parameter-for	$serviceConfigurationLocation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ServiceConfigLocation Required. The location of the .cspkg file.
command-parameter-for	$storageAccount Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --StorageAccount Required. Storage account to use when creating the deployment.
command-parameter-for	$startImmediately Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --StartImmediately Optional. Start the deployment after creation.
command-parameter-for	$warningsAsErrors Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --WarningsAsErrors Optional. Treat warnings as errors.
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 a deployment from a local .cspkg:
command-example	CreateFromLocal -sid:"" -cert:"mycert.pem" --Name:"hostedservicename" --DeploymentName:"deploymentname"
command-example	--Label:"deploymentlabel" --Production --PackageLocation:".\service.cspkg"
command-example	--ServiceConfigLocation:".\ServiceConfiguration.cscfg" --StorageAccount:"mystorage"
command-example	--StartImmediately --WaitFor

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentName

$label

$staging

$production

$packageLocation

$serviceConfigurationLocation

$storageAccount

$startImmediately

$warningsAsErrors

$waitForOperation

Creates a deployment from a remote package file and service configuration.

createFromStorageCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentName, $label, $staging = false, $production = false, $packageUrl, $serviceConfigurationLocation, $startImmediately = true, $warningsAsErrors = false, $waitForOperation = false)

command-name	CreateFromStorage
command-description	Creates a deployment from a remote package file and service configuration.
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	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --DeploymentName Required. The name for the deployment.
command-parameter-for	$label Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Label Required. The label for the deployment.
command-parameter-for	$staging Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Staging Host the service in the staging slot.
command-parameter-for	$production Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Production Host the service in the staging slot.
command-parameter-for	$packageUrl Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --PackageUrl Required. The remote location of the .cspkg file.
command-parameter-for	$serviceConfigurationLocation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ServiceConfigLocation Required. The location of the .cspkg file.
command-parameter-for	$startImmediately Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --StartImmediately Optional. Start the deployment after creation.
command-parameter-for	$warningsAsErrors Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --WarningsAsErrors Optional. Treat warnings as errors.
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 a deployment from a remote .cspkg:
command-example	CreateFromStorage -sid:"" -cert:"mycert.pem" --Name:"hostedservicename" --DeploymentName:"deploymentname"
command-example	--Label:"deploymentlabel" --Production
command-example	--PackageUrl:"http://acct.blob.core.windows.net/pkgs/service.cspkg"
command-example	--ServiceConfigLocation:".\ServiceConfiguration.cscfg" --StartImmediately --WaitFor

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentName

$label

$staging

$production

$packageUrl

$serviceConfigurationLocation

$startImmediately

$warningsAsErrors

$waitForOperation

Deletes a deployment.

deleteCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $waitForOperation = false)

command-name	Delete
command-description	Deletes a deployment.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
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 a deployment:
command-example	Delete -sid:"" -cert:"mycert.pem" --Name:"hostedservicename" --DeploymentName:"deploymentname"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$waitForOperation

Updates the number of instances.

editInstanceNumberCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $roleName, $newInstanceNumber = 1, $waitForOperation = false)

command-name	EditInstanceNumber
command-description	Updates the number of instances.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$roleName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --RoleName\|-r Required. Role name to update the number of instances for.
command-parameter-for	$newInstanceNumber Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --NewInstanceNumber\|-i Required. New number of instances.
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	Suspend a deployment:
command-example	EditInstanceNumber -sid:"" -cert:"mycert.pem"
command-example	--Name:"hostedservicename" --ByName:"deploymentname"
command-example	--NewInstanceNumber:"4"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$roleName

$newInstanceNumber

$waitForOperation

Gets the handler.

getHandler() : array

Inherited

Returns

array

Get deployment properties.

getPropertiesCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName)

command-name	GetProperties
command-description	Get deployment 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-parameter-for	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-example	Get deployment properties for service "phptest" (production slot):
command-example	GetProperties -sid:"" -cert:"mycert.pem" --Name:"servicename" --BySlot:"production"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

Get hosted service account property.

getPropertyCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $property)

command-name	GetProperty
command-description	Get deployment 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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
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 deployment property "Name" for service "phptest" (production slot):
command-example	GetProperties -sid:"" -cert:"mycert.pem"
command-example	--Name:"servicename" --BySlot:"production" --Property:"Name"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$property

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

Reboots a role instance.

rebootInstanceCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $instanceName, $waitForOperation = false)

command-name	RebootInstance
command-description	Reboots a role instance.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$instanceName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --RoleInstanceName Required. The name of the role instance to work with.
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	Reboot a role instance:
command-example	RebootInstance -sid:"" -cert:"mycert.pem"
command-example	--Name:"hostedservicename" --ByName:"deploymentname"
command-example	--RoleInstanceName:"PhpOnAzure.Web_IN_0"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$instanceName

$waitForOperation

Reimages a role instance.

reimageInstanceCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $instanceName, $waitForOperation = false)

command-name	ReimageInstance
command-description	Reimages a role instance.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$instanceName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --RoleInstanceName Required. The name of the role instance to work with.
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	Reimage a role instance:
command-example	ReimageInstance -sid:"" -cert:"mycert.pem"
command-example	--Name:"hostedservicename" --ByName:"deploymentname"
command-example	--RoleInstanceName:"PhpOnAzure.Web_IN_0"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$instanceName

$waitForOperation

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

Swap deployment slots (perform VIP swap).

swapCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $waitForOperation = false)

command-name	Swap
command-description	Swap deployment slots (perform VIP swap).
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	$waitForOperation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --WaitFor\|-w Optional. Wait for the operation to complete?
command-example	Swap deployment slots:
command-example	Swap -sid:"" -cert:"mycert.pem" --Name:"servicename"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$waitForOperation

Updates a deployment's configuration.

updateConfigurationCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $serviceConfigurationLocation, $waitForOperation = false)

command-name	UpdateConfig
command-description	Updates a deployment's configuration.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$serviceConfigurationLocation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ServiceConfigLocation Required. The location of the .cspkg file.
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 configuration:
command-example	UpdateConfig -sid:"" -cert:"mycert.pem"
command-example	--Name:"hostedservicename" --ByName:"deploymentname"
command-example	--ServiceConfigLocation:".\ServiceConfiguration.cscfg"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$serviceConfigurationLocation

$waitForOperation

Updates a deployment's status.

updateStatusCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $newStatus, $waitForOperation = false)

command-name	UpdateStatus
command-description	Updates a deployment's status.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$newStatus Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Status Required. New status (Suspended\|Running)
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	Suspend a deployment:
command-example	UpdateStatus -sid:"" -cert:"mycert.pem"
command-example	--Name:"hostedservicename" --ByName:"deploymentname"
command-example	--Status:"Suspended"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$newStatus

$waitForOperation

Upgrades a deployment from a local package file and service configuration.

upgradeFromLocalCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $label, $packageLocation, $serviceConfigurationLocation, $storageAccount, $mode = 'auto', $roleName = null, $waitForOperation = false)

command-name	UpgradeFromLocal
command-description	Upgrades a deployment from a local package file and service configuration.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$label Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Label Required. The label for the deployment.
command-parameter-for	$packageLocation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --PackageLocation Required. The location of the .cspkg file.
command-parameter-for	$serviceConfigurationLocation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ServiceConfigLocation Required. The location of the .cspkg file.
command-parameter-for	$storageAccount Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --StorageAccount Required. Storage account to use when creating the deployment.
command-parameter-for	$mode Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Mode Required. Set to auto\|manual.
command-parameter-for	$roleName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --RoleName Optional. Role name to upgrade.
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?

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$label

$packageLocation

$serviceConfigurationLocation

$storageAccount

$mode

$roleName

$waitForOperation

Upgrades a deployment from a remote package file and service configuration.

upgradeFromStorageCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $label, $packageUrl, $serviceConfigurationLocation, $mode = 'auto', $roleName = null, $waitForOperation = false)

command-name	UpgradeFromStorage
command-description	Upgrades a deployment from a remote package file and service configuration.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$label Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Label Required. The label for the deployment.
command-parameter-for	$packageUrl Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --PackageUrl Required. The remote location of the .cspkg file.
command-parameter-for	$serviceConfigurationLocation Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ServiceConfigLocation Required. The location of the .cspkg file.
command-parameter-for	$mode Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --Mode Required. Set to auto\|manual.
command-parameter-for	$roleName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --RoleName Optional. Role name to upgrade.
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?

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$label

$packageUrl

$serviceConfigurationLocation

$mode

$roleName

$waitForOperation

Walks upgrade domains.

walkUpgradeDomainsCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $deploymentSlot, $deploymentName, $upgradeDomain, $waitForOperation = false)

command-name	WalkUpgradeDomains
command-description	Walks upgrade domains.
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	$deploymentSlot Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --BySlot Required if deployment name is omitted. The slot to retrieve property information for.
command-parameter-for	$deploymentName Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --ByName Required if deployment slot is omitted. The deployment name to retrieve property information for.
command-parameter-for	$upgradeDomain Zend_Service_Console_Command_ParameterSource_Argv\|Zend_Service_Console_Command_ParameterSource_ConfigFile --UpgradeDomain Required. The upgrade domain index.
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?

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$deploymentSlot

$deploymentName

$upgradeDomain

$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