Zend Framework API Documentation
Back to top  

Certificate 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 certificate
command-handler-description Windows Azure Certificate 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

Add a certificate for a specified hosted service in a specified subscription.

addCertificateCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $certificateLocation, $certificatePassword, $waitForOperation = false) 
command-name Add
command-description Add a certificate for a specified hosted service in a specified subscription.
command-parameter-for $subscriptionId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
command-parameter-for $certificate Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
command-parameter-for $certificatePassphrase Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --Passphrase|-p Required. The certificate passphrase. If not specified, a prompt will be displayed.
command-parameter-for $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --ServiceName|-sn Required. The name of the hosted service.
command-parameter-for $certificateLocation Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --CertificateLocation Required. Path to the .pfx certificate to be added.
command-parameter-for $certificatePassword Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --CertificatePassword Required. The password for the certificate that will be added.
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 Add certificates for service name "phptest":
command-example Add -sid:"" -cert:"mycert.pem" -sn:"phptest" --CertificateLocation:"cert.pfx" --CertificatePassword:"certpassword"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$certificateLocation

$certificatePassword

$waitForOperation

Bootstrap the shell command.

bootstrap(array $argv) 
InheritedStatic

Parameters

$argv

array

PHP argument values.

Deletes a certificate from a specified hosted service in a specified subscription.

deleteCertificateCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $thumbprint, $algorithm = "sha1", $waitForOperation = false) 
command-name Delete
command-description Deletes a certificate from a specified hosted service in a specified subscription.
command-parameter-for $subscriptionId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
command-parameter-for $certificate Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
command-parameter-for $certificatePassphrase Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --Passphrase|-p Required. The certificate passphrase. If not specified, a prompt will be displayed.
command-parameter-for $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --ServiceName|-sn Required. The name of the hosted service.
command-parameter-for $thumbprint Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --CertificateThumbprint Required. The certificate thumbprint for which to retrieve the certificate.
command-parameter-for $algorithm Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --CertificateAlgorithm Required. The certificate's algorithm.
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 Get certificate for service name "phptest":
command-example Get -sid:"" -cert:"mycert.pem" -sn:"phptest" --CertificateThumbprint:"" --CertificateAlgorithm:"sha1"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$thumbprint

$algorithm

$waitForOperation

Gets a certificate from a specified hosted service in a specified subscription.

getCertificateCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $thumbprint, $algorithm = "sha1") 
command-name Get
command-description Gets a certificate from a specified hosted service in a specified subscription.
command-parameter-for $subscriptionId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
command-parameter-for $certificate Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
command-parameter-for $certificatePassphrase Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --Passphrase|-p Required. The certificate passphrase. If not specified, a prompt will be displayed.
command-parameter-for $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --ServiceName|-sn Required. The name of the hosted service.
command-parameter-for $thumbprint Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --CertificateThumbprint Required. The certificate thumbprint for which to retrieve the certificate.
command-parameter-for $algorithm Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --CertificateAlgorithm Required. The certificate's algorithm.
command-example Get certificate for service name "phptest":
command-example Get -sid:"" -cert:"mycert.pem" -sn:"phptest" --CertificateThumbprint:"" --CertificateAlgorithm:"sha1"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$thumbprint

$algorithm

Gets a certificate property from a specified hosted service in a specified subscription.

getCertificatePropertyCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName, $thumbprint, $algorithm = "sha1", $property) 
command-name GetProperty
command-description Gets a certificate property from a specified hosted service in a specified subscription.
command-parameter-for $subscriptionId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
command-parameter-for $certificate Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
command-parameter-for $certificatePassphrase Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --Passphrase|-p Required. The certificate passphrase. If not specified, a prompt will be displayed.
command-parameter-for $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --ServiceName|-sn Required. The name of the hosted service.
command-parameter-for $thumbprint Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --CertificateThumbprint Required. The certificate thumbprint for which to retrieve the certificate.
command-parameter-for $algorithm Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile --CertificateAlgorithm Required. The certificate's algorithm.
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 certificate.
command-example Get certificate for service name "phptest":
command-example Get -sid:"" -cert:"mycert.pem" -sn:"phptest" --CertificateThumbprint:"" --CertificateAlgorithm:"sha1"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

$thumbprint

$algorithm

$property

Gets the handler.

getHandler() : array
Inherited

Returns

array

Displays the help information.

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

List certificates for a specified hosted service in a specified subscription.

listCertificatesCommand($subscriptionId, $certificate, $certificatePassphrase, $serviceName) 
command-name List
command-description List certificates for a specified hosted service in a specified subscription.
command-parameter-for $subscriptionId Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --SubscriptionId|-sid Required. This is the Windows Azure Subscription Id to operate on.
command-parameter-for $certificate Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --Certificate|-cert Required. This is the .pem certificate that user has uploaded to Windows Azure subscription as Management Certificate.
command-parameter-for $certificatePassphrase Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Prompt --Passphrase|-p Required. The certificate passphrase. If not specified, a prompt will be displayed.
command-parameter-for $serviceName Zend_Service_Console_Command_ParameterSource_Argv|Zend_Service_Console_Command_ParameterSource_ConfigFile|Zend_Service_Console_Command_ParameterSource_Env --ServiceName|-sn Required. The name of the hosted service.
command-example List certificates for service name "phptest":
command-example List -sid:"" -cert:"mycert.pem" -sn:"phptest"

Parameters

$subscriptionId

$certificate

$certificatePassphrase

$serviceName

Replaces PHP's error handler

phpstderr(mixed $errno, mixed $errstr, mixed $errfile, mixed $errline) 
InheritedStatic

Parameters

$errno

mixed

$errstr

mixed

$errfile

mixed

$errline

mixed

Replaces PHP's exception handler

phpstdex(\Exception $exception) 
InheritedStatic

Parameters

$exception

\Exception

Sets the handler.

setHandler(array $handler) : \Zend_Service_Console_Command
Inherited

Parameters

$handler

array

Returns

\Zend_Service_Console_Command

Writes output to STDERR, followed by a newline (optional)

stderr(string $errorMessage, string $newLine = true) 
InheritedStatic

Parameters

$errorMessage

string

$newLine

string

Builds the handler model.

_buildModel() : array
InheritedStatic

Returns

array

Display information on an object

_displayObjectInformation(object $object, array $propertiesToDump = array()) 
Inherited

Parameters

$object

object

Object

$propertiesToDump

array

Property names to display

Finds the value for a specific docComment.

_findValueForDocComment(string $docCommentName, \unknown_type $docComment) : array
InheritedStatic

Parameters

$docCommentName

string

Comment name

$docComment

\unknown_type

Comment object

Returns

array

 Properties

 

The handler.

$_handler : array

Default