Service/WindowsAzure/CommandLine/Service.php
Show:
inherited
inherited
Classes
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 license@zend.com 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_Service
Package: Zend_Service_WindowsAzure_CommandLine
Service commands
- Parent(s)
- \Zend_Service_Console_Command
- Category
- Zend
- Command-handler
- service
- Command-handler-description
- Windows Azure Service 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
createCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $label, $description, $location, $affinityGroup, $waitForOperation = false) : voidCreate hosted service account.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $serviceName | ||
| $label | ||
| $description | ||
| $location | ||
| $affinityGroup | ||
| $waitForOperation |
- Command-description
- Create hosted service account.
- Command-example
- Create hosted service account in West Europe
- Command-example
- Create -p:"phpazure" --Name:"phptestsdk2" --Label:"phptestsdk2" --Location:"West Europe"
- Command-name
- Create
- 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?
deleteCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $waitForOperation = false) : voidDelete hosted service account.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $serviceName | ||
| $waitForOperation |
- Command-description
- Delete hosted service account.
- Command-example
- Delete hosted service
- Command-example
- Delete -p:"phpazure" --Name:"phptestsdk2"
- 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 --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?
getPropertiesCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName) : voidGet hosted service account properties.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $serviceName |
- Command-description
- Get hosted service account properties.
- Command-example
- Get hosted service account properties for service "phptest":
- Command-example
- GetProperties -sid:"
" -cert:"mycert.pem" - Command-example
- --Name:"phptest"
- 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.
getPropertyCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $property) : voidGet hosted service account property.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $serviceName | ||
| $property |
- Command-description
- Get storage account property.
- Command-example
- Get hosted service account property "Url" for service "phptest":
- Command-example
- GetProperty -sid:"
" -cert:"mycert.pem" - Command-example
- --Name:"phptest" --Property:Url
- 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
- $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.
listCommand( $subscriptionId, $certificate, $certificatePassphrase) : voidList hosted service accounts for a specified subscription.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase |
- Command-description
- List hosted service accounts for a specified subscription.
- Command-example
- List hosted service accounts for subscription:
- Command-example
- List -sid:"
" -cert:"mycert.pem" - Command-name
- List
- 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.
updateCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $label, $description, $waitForOperation = false) : voidUpdate hosted service account.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $serviceName | ||
| $label | ||
| $description | ||
| $waitForOperation |
- Command-description
- Update hosted service account.
- Command-example
- Update hosted service
- Command-example
- Update -p:"phpazure" --Name:"phptestsdk2" --Label:"New label" --Description:"Some description"
- Command-name
- Update
- 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?