Service/WindowsAzure/CommandLine/Storage.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 [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_Storage
Package: Zend_Service_WindowsAzure_CommandLine
Storage commands
- Parent(s)
- \Zend_Service_Console_Command
- Category
- Zend
- Command-handler
- storage
- Command-handler-description
- Windows Azure Storage 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
getKeyCommand( $subscriptionId, $certificate, $certificatePassphrase, $accountName, $key = 'primary') : voidGet storage account key.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $accountName | ||
| $key |
- Command-description
- Get storage account key.
- Command-example
- Get primary storage account key for account "phptest":
- Command-example
- GetKey -sid:"
" -cert:"mycert.pem" - Command-example
- --AccountName:"phptest" -Key:primary
- Command-name
- GetKey
- 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
- $accountName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --AccountName Required. The storage account name to operate on.
- Command-parameter-for
- $key Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Key|-k Optional. Specifies the key to regenerate (primary|secondary). If omitted, primary key is used as the default.
getKeysCommand( $subscriptionId, $certificate, $certificatePassphrase, $accountName) : voidGet storage account keys.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $accountName |
- Command-description
- Get storage account keys.
- Command-example
- Get storage account keys for account "phptest":
- Command-example
- GetKeys -sid:"
" -cert:"mycert.pem" - Command-example
- --AccountName:"phptest"
- Command-name
- GetKeys
- 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
- $accountName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --AccountName Required. The storage account name to operate on.
getPropertiesCommand( $subscriptionId, $certificate, $certificatePassphrase, $accountName) : voidGet storage account properties.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $accountName |
- Command-description
- Get storage account properties.
- Command-example
- Get storage account properties for account "phptest":
- Command-example
- GetProperties -sid:"
" -cert:"mycert.pem" - Command-example
- --AccountName:"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
- $accountName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --AccountName Required. The storage account name to operate on.
getPropertyCommand( $subscriptionId, $certificate, $certificatePassphrase, $accountName, $property) : voidGet storage account property.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $accountName | ||
| $property |
- Command-description
- Get storage account property.
- Command-example
- Get storage account property "Url" for account "phptest":
- Command-example
- GetProperty -sid:"
" -cert:"mycert.pem" - Command-example
- --AccountName:"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
- $accountName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --AccountName Required. The storage 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 storage account.
listAccountsCommand( $subscriptionId, $certificate, $certificatePassphrase) : voidList storage accounts for a specified subscription.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase |
- Command-description
- List storage accounts for a specified subscription.
- Command-example
- List storage accounts for subscription:
- Command-example
- ListAccounts -sid:"
" -cert:"mycert.pem" - Command-name
- ListAccounts
- 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.
regenerateKeysCommand( $subscriptionId, $certificate, $certificatePassphrase, $accountName, $key = 'primary', $waitForOperation = false) : voidRegenerate storage account keys.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $subscriptionId | ||
| $certificate | ||
| $certificatePassphrase | ||
| $accountName | ||
| $key | ||
| $waitForOperation |
- Command-description
- Regenerate storage account keys.
- Command-example
- Regenerate secondary key for account "phptest":
- Command-example
- RegenerateKeys -sid:"
" -cert:"mycert.pem" - Command-example
- --AccountName:"phptest" -Key:secondary
- Command-name
- RegenerateKeys
- 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
- $accountName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --AccountName Required. The storage account name to operate on.
- Command-parameter-for
- $key Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --Key|-k Optional. Specifies the key to regenerate (primary|secondary). If omitted, primary key is used as the default.
- 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?