Service/WindowsAzure/CommandLine/Certificate.php
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_Certificate
Package: Zend_Service_WindowsAzure_CommandLine
Certificate commands
- Parent(s)
- \Zend_Service_Console_Command
- Category
- Zend
- Command-handler
- certificate
- Command-handler-description
- Windows Azure Certificate 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
addCertificateCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $certificateLocation, $certificatePassword, $waitForOperation = false) : void
Add a certificate for a specified hosted service in a specified subscription.
Parameters
Details
Name | Type | Description |
---|---|---|
$subscriptionId | ||
$certificate | ||
$certificatePassphrase | ||
$serviceName | ||
$certificateLocation | ||
$certificatePassword | ||
$waitForOperation |
- Command-description
- Add a certificate for a specified hosted service in a specified subscription.
- Command-example
- Add certificates for service name "phptest":
- Command-example
- Add -sid:"
" -cert:"mycert.pem" -sn:"phptest" --CertificateLocation:"cert.pfx" --CertificatePassword:"certpassword" - Command-name
- Add
- 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?
deleteCertificateCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $thumbprint, $algorithm = "sha1", $waitForOperation = false) : void
Deletes a certificate from a specified hosted service in a specified subscription.
Parameters
Details
Name | Type | Description |
---|---|---|
$subscriptionId | ||
$certificate | ||
$certificatePassphrase | ||
$serviceName | ||
$thumbprint | ||
$algorithm | ||
$waitForOperation |
- Command-description
- Deletes a certificate from a specified hosted service in a specified subscription.
- Command-example
- Get certificate for service name "phptest":
- Command-example
- Get -sid:"
" -cert:"mycert.pem" -sn:"phptest" --CertificateThumbprint:" " --CertificateAlgorithm:"sha1" - 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 --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?
getCertificateCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $thumbprint, $algorithm = "sha1") : void
Gets a certificate from a specified hosted service in a specified subscription.
Parameters
Details
Name | Type | Description |
---|---|---|
$subscriptionId | ||
$certificate | ||
$certificatePassphrase | ||
$serviceName | ||
$thumbprint | ||
$algorithm |
- Command-description
- Gets a certificate from a specified hosted service in a specified subscription.
- Command-example
- Get certificate for service name "phptest":
- Command-example
- Get -sid:"
" -cert:"mycert.pem" -sn:"phptest" --CertificateThumbprint:" " --CertificateAlgorithm:"sha1" - Command-name
- Get
- 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.
getCertificatePropertyCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName, $thumbprint, $algorithm = "sha1", $property) : void
Gets a certificate property from a specified hosted service in a specified subscription.
Parameters
Details
Name | Type | Description |
---|---|---|
$subscriptionId | ||
$certificate | ||
$certificatePassphrase | ||
$serviceName | ||
$thumbprint | ||
$algorithm | ||
$property |
- Command-description
- Gets a certificate property from a specified hosted service in a specified subscription.
- Command-example
- Get certificate for service name "phptest":
- Command-example
- Get -sid:"
" -cert:"mycert.pem" -sn:"phptest" --CertificateThumbprint:" " --CertificateAlgorithm:"sha1" - 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 --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.
listCertificatesCommand( $subscriptionId, $certificate, $certificatePassphrase, $serviceName) : void
List certificates for a specified hosted service in a specified subscription.
Parameters
Details
Name | Type | Description |
---|---|---|
$subscriptionId | ||
$certificate | ||
$certificatePassphrase | ||
$serviceName |
- Command-description
- List certificates for a specified hosted service in a specified subscription.
- Command-example
- List certificates for service name "phptest":
- Command-example
- List -sid:"
" -cert:"mycert.pem" -sn:"phptest" - 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.
- 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.