Service/WindowsAzure/CommandLine/Deployment.php

Show:

inherited

Classes
- \Zend_Service_WindowsAzure_CommandLine_Deployment

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service_Console
Subpackage: Exception
Version: $Id$

\Zend_Service_WindowsAzure_CommandLine_Deployment
jump to top

Package: Zend_Service_WindowsAzure_CommandLine

Deployment commands

Parent(s): \Zend_Service_Console_Command
Category: Zend
Command-handler: deployment
Command-handler-description: Windows Azure Deployment commands
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.
Command-handler-header: Windows Azure SDK for PHP
Command-handler-header: Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Methods

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

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

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentName
$label
$staging
$production
$packageLocation
$serviceConfigurationLocation
$storageAccount
$startImmediately
$warningsAsErrors
$waitForOperation

Details

Command-description: Creates a deployment from a local package file and service configuration.
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
Command-name: CreateFromLocal
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?

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

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

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentName
$label
$staging
$production
$packageUrl
$serviceConfigurationLocation
$startImmediately
$warningsAsErrors
$waitForOperation

Details

Command-description: Creates a deployment from a remote package file and service configuration.
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
Command-name: CreateFromStorage
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?

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

Deletes a deployment.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$waitForOperation

Details

Command-description: Deletes a deployment.
Command-example: Delete a deployment:
Command-example: Delete -sid:"" -cert:"mycert.pem" --Name:"hostedservicename" --DeploymentName:"deploymentname"
Command-name: Delete
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?

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

Updates the number of instances.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$roleName
$newInstanceNumber
$waitForOperation

Details

Command-description: Updates the number of instances.
Command-example: Suspend a deployment:
Command-example: EditInstanceNumber -sid:"" -cert:"mycert.pem"
Command-example: --Name:"hostedservicename" --ByName:"deploymentname"
Command-example: --NewInstanceNumber:"4"
Command-name: EditInstanceNumber
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?

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

Get deployment properties.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName

Details

Command-description: Get deployment properties.
Command-example: Get deployment properties for service "phptest" (production slot):
Command-example: GetProperties -sid:"" -cert:"mycert.pem" --Name:"servicename" --BySlot:"production"
Command-name: GetProperties
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.

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

Get hosted service account property.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$property

Details

Command-description: Get deployment property.
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"
Command-name: GetProperty
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.

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

Reboots a role instance.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$instanceName
$waitForOperation

Details

Command-description: Reboots a role instance.
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"
Command-name: RebootInstance
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?

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

Reimages a role instance.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$instanceName
$waitForOperation

Details

Command-description: Reimages a role instance.
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"
Command-name: ReimageInstance
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?

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

Swap deployment slots (perform VIP swap).

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$waitForOperation

Details

Command-description: Swap deployment slots (perform VIP swap).
Command-example: Swap deployment slots:
Command-example: Swap -sid:"" -cert:"mycert.pem" --Name:"servicename"
Command-name: 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?

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

Updates a deployment's configuration.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$serviceConfigurationLocation
$waitForOperation

Details

Command-description: Updates a deployment's configuration.
Command-example: Update configuration:
Command-example: UpdateConfig -sid:"" -cert:"mycert.pem"
Command-example: --Name:"hostedservicename" --ByName:"deploymentname"
Command-example: --ServiceConfigLocation:".\ServiceConfiguration.cscfg"
Command-name: UpdateConfig
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?

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

Updates a deployment's status.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$newStatus
$waitForOperation

Details

Command-description: Updates a deployment's status.
Command-example: Suspend a deployment:
Command-example: UpdateStatus -sid:"" -cert:"mycert.pem"
Command-example: --Name:"hostedservicename" --ByName:"deploymentname"
Command-example: --Status:"Suspended"
Command-name: UpdateStatus
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?

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

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

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$label
$packageLocation
$serviceConfigurationLocation
$storageAccount
$mode
$roleName
$waitForOperation

Details

Command-description: Upgrades a deployment from a local package file and service configuration.
Command-name: UpgradeFromLocal
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?

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

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

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$label
$packageUrl
$serviceConfigurationLocation
$mode
$roleName
$waitForOperation

Details

Command-description: Upgrades a deployment from a remote package file and service configuration.
Command-name: UpgradeFromStorage
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?

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

Walks upgrade domains.

Parameters

Name	Type	Description
$subscriptionId
$certificate
$certificatePassphrase
$serviceName
$deploymentSlot
$deploymentName
$upgradeDomain
$waitForOperation

Details

Command-description: Walks upgrade domains.
Command-name: WalkUpgradeDomains
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?

Service/WindowsAzure/CommandLine/Deployment.php

\Zend_Service_WindowsAzure_CommandLine_Deploymentjump to top

Methods

\Zend_Service_WindowsAzure_CommandLine_Deployment
jump to top