dreamfactory/azure-sdk-for-php

本项目提供了一组PHP客户端库，可以轻松访问Windows Azure的表、Blob、队列、服务运行时和服务管理API。

维护者

详细信息

github.com/dreamfactorysoftware/azure-sdk-for-php

来源

安装次数: 5,533

依赖者: 1

建议者: 0

安全: 0

星标: 1

关注者: 10

分支: 276

0.4.0.11 2014-04-16 22:03 UTC

Requires

  • pear-pear.php.net/http_request2: *
  • pear-pear.php.net/mail_mime: *
  • pear-pear.php.net/mail_mimedecode: *
  • pear-pear.php.net/net_url2: *

Requires (Dev)

Apache-2.0 0f3a493fa33cde5e7f74c51d911f8155bfb05d85

  • Azure PHP SDK <azurephpsdk.woop@microsoft.com>
  • Jerry Ablan <jerryablan.woop@dreamfactory.com>

phpsdkazure

This package is auto-updated.

Last update: 2024-09-07 00:32:36 UTC

README

本项目提供一组PHP客户端库，可以轻松访问Windows Azure的表、Blob、队列、服务总线（队列和主题）、服务运行时和服务管理API。有关如何在Windows Azure上托管PHP应用程序的文档，请参阅Windows Azure PHP开发者中心。

功能

  • 表
    • 创建和删除表
    • 创建、查询、插入、更新、合并和删除实体
    • 批量操作
    • REST API版本：2011-08-18
  • Blob
    • 创建、列出和删除容器，处理容器元数据和权限，列出容器中的Blob
    • 创建块Blob和页Blob（从流或字符串），处理Blob块和页面，删除Blob
    • 处理Blob属性、元数据、租约，快照Blob
    • REST API版本：2011-08-18
  • 存储队列
    • 创建、列出和删除队列，并处理队列元数据和属性
    • 创建、获取、查看、更新、删除消息
    • REST API版本：2011-08-18
  • 服务总线
    • 队列：创建、列出和删除队列；发送、接收、解锁和删除消息
    • 主题：创建、列出和删除主题；创建、列出和删除订阅；发送、接收、解锁和删除消息；创建、列出和删除规则
  • 服务运行时
    • 发现服务中其他角色实例的端点地址和端口
    • 获取配置设置和访问本地资源
    • 获取当前角色和其他角色实例的信息
    • 查询和设置当前角色的状态
    • REST API版本：2011-03-08
  • 服务管理
    • 存储帐户：创建、更新、删除、列出、重新生成密钥
    • 亲和组：创建、更新、删除、列出、获取属性
    • 位置：列出
    • 托管服务：创建、更新、删除、列出、获取属性
    • 部署：创建、获取、删除、交换、更改配置、更新状态、升级、回滚
    • 角色实例：重启、重映像
    • REST API版本：2011-10-01
  • 媒体服务
    • 连接
    • 导入资产、上传文件
    • 编码/处理资产，创建作业，作业模板
    • 管理媒体服务实体：创建/更新/读取/删除/获取列表
    • 提供SAS和流式传输媒体内容
    • REST API版本：2.2

入门指南

下载源代码

要从GitHub获取源代码，请输入以下命令：

git clone https://github.com/WindowsAzure/azure-sdk-for-php.git
cd ./azure-sdk-for-php

注意

Windows Azure的PHP客户端库依赖于HTTP_Request2、Mail_mime和Mail_mimeDecode PEAR包。解决这些依赖项的推荐方法是使用PEAR包管理器安装它们。

##通过Composer安装

  1. 在项目的根目录中创建一个名为composer.json的文件，并将其添加以下代码：

     {
 	"require": {
 		"microsoft/windowsazure": "*"
 	},			
 	"repositories": [
 		{
 			"type": "pear",
 			"url": "http://pear.php.net"
 		}
 	],
 	"minimum-stability": "dev"
 }

  2. 在项目的根目录中下载composer.phar。

  3. 在项目根目录中打开命令提示符并执行以下命令：

     php composer.phar install

    注意

    在Windows上，您还需要将Git可执行文件添加到您的PATH环境变量中。

##作为PEAR包安装

要将Windows Azure的PHP客户端库安装为PEAR包，请按照以下步骤操作

  1. 安装PEAR.

  2. 设置Windows Azure PEAR通道

     pear channel-discover pear.windowsazure.com

  3. 安装PEAR包

     pear install pear.windowsazure.com/WindowsAzure-0.4.0

用法

入门指南

在使用库进行调用之前，必须执行以下四个基本步骤

  • 首先，包含自动加载脚本

    如果通过PEAR或Git安装

      require_once "WindowsAzure/WindowsAzure.php";

    如果通过Composer安装

      require_once "vendor/autoload.php";

  • 包含您将要使用的命名空间。

    要创建任何Windows Azure服务客户端，您需要使用ServicesBuilder类

      use WindowsAzure\Common\ServicesBuilder;

    要处理异常，您需要

      use WindowsAzure\Common\ServiceException;

  • 要实例化服务客户端，您还需要一个有效的连接字符串。其格式为

    • 要访问实时存储服务（表、块、队列）

        DefaultEndpointsProtocol=[http|https];AccountName=[yourAccount];AccountKey=[yourKey]

    • 要访问模拟存储

        UseDevelopmentStorage=true

    • 要访问Service Bus

        Endpoint=[yourEndpoint];SharedSecretIssuer=[yourWrapAuthenticationName];SharedSecretValue=[yourWrapPassword]

      其中，端点通常具有以下格式：https://[yourNamespace].servicebus.windows.net。

    • 要访问服务管理API

        SubscriptionID=[yourSubscriptionId];CertificatePath=[filePathToYourCertificate]

  • 实例化一个"REST代理" - 给定服务的可用调用的包装器。

    • 对于存储服务

        $tableRestProxy = ServicesBuilder::getInstance()->createTableService($connectionString);
  $blobRestProxy = ServicesBuilder::getInstance()->createBlobService($connectionString);
  $queueRestProxy = ServicesBuilder::getInstance()->createQueueService($connectionString);

    • 对于Service Bus

        $serviceBusRestProxy = ServicesBuilder::getInstance()->createServiceBusService($connectionString);

    • 对于服务管理

        $serviceManagementRestProxy = ServicesBuilder::getInstance()->createServiceManagementService($connectionString);

    • 对于媒体服务

        $mediaServicesRestProxy = ServicesBuilder->getInstance()->createMediaServicesService(new MediaServicesSettings([YourAccountName], [YourPrimaryOrSecondaryAccessKey]));

表存储

以下是一些使用表服务执行常见操作的示例。更多请参阅如何使用表服务。

创建一个表

要创建一个表，请调用createTable

try	{
	// Create table.
	$tableRestProxy->createTable("mytable");
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

表错误代码和消息

插入实体

要将实体添加到表中，请创建一个新的Entity对象并将其传递给TableRestProxy->insertEntity。请注意，在创建实体时，您必须指定一个PartitionKey和RowKey。这些是实体的唯一标识符，是查询速度比其他实体属性更快的值。系统使用PartitionKey自动将表实体分布到多个存储节点上。

use WindowsAzure\Table\Models\Entity;
use WindowsAzure\Table\Models\EdmType;

$entity = new Entity();
$entity->setPartitionKey("pk");
$entity->setRowKey("1");
$entity->addProperty("PropertyName", EdmType::STRING, "Sample");

try{
	$tableRestProxy->insertEntity("mytable", $entity);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

查询实体

要查询实体，您可以调用queryEntities。您检索的实体子集将由您使用的过滤器确定（有关更多信息，请参阅查询表和实体）。您也可以不提供任何过滤器。

$filter = "RowKey eq '2'";

try	{
	$result = $tableRestProxy->queryEntities("mytable", $filter);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

$entities = $result->getEntities();

foreach($entities as $entity){
	echo $entity->getPartitionKey().":".$entity->getRowKey()."<br />";
}

块存储

要开始使用Blob服务，您必须包含BlobService和BlobSettings命名空间，并设置ACCOUNT_NAME和ACCOUNT_KEY配置设置以配置您的凭据。然后使用BlobService工厂实例化包装器。

以下是一些使用Blob服务执行常见操作的示例。更多请参阅如何使用Blob服务。

创建一个容器

// OPTIONAL: Set public access policy and metadata.
// Create container options object.
$createContainerOptions = new CreateContainerOptions();	

// Set public access policy. Possible values are 
// PublicAccessType::CONTAINER_AND_BLOBS and PublicAccessType::BLOBS_ONLY.
// CONTAINER_AND_BLOBS: full public read access for container and blob data.
// BLOBS_ONLY: public read access for blobs. Container data not available.
// If this value is not specified, container data is private to the account owner.
$createContainerOptions->setPublicAccess(PublicAccessType::CONTAINER_AND_BLOBS);

// Set container metadata
$createContainerOptions->addMetaData("key1", "value1");
$createContainerOptions->addMetaData("key2", "value2");

try	{
	// Create container.
	$blobRestProxy->createContainer("mycontainer", $createContainerOptions);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

块错误代码和消息

有关容器ACL的更多信息，请参阅设置容器ACL（REST API）。

上传一个块

要将文件作为块上传，请使用BlobRestProxy->createBlockBlob方法。此操作将在不存在时创建块，或在存在时覆盖它。下面的代码示例假定容器已经创建，并使用fopen以流的形式打开文件。

$content = fopen("myfile.txt", "r");
$blob_name = "myblob";

try	{
	//Upload blob
	$blobRestProxy->createBlockBlob("mycontainer", $blob_name, $content);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

虽然上面的示例以流的形式上传块，但块也可以以字符串的形式上传。

列出容器中的块

要列出容器中的块，请使用BlobRestProxy->listBlobs方法，并用foreach循环遍历结果。以下代码输出容器中每个块的名字和URI。

try	{
	// List blobs.
	$blob_list = $blobRestProxy->listBlobs("mycontainer");
	$blobs = $blob_list->getBlobs();
	
	foreach($blobs as $blob)
	{
		echo $blob->getName().": ".$blob->getUrl()."<br />";
	}
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

存储队列

要开始使用队列服务，您必须包含QueueService和QueueSettings命名空间，并设置用于凭据的ACCOUNT_NAME和ACCOUNT_KEY配置设置。然后，您可以使用QueueService工厂实例化包装器。

以下是在使用队列服务时执行的一些常见操作示例。有关更多信息，请参阅如何使用队列服务。

创建一个队列

QueueRestProxy对象允许您使用createQueue方法创建一个队列。在创建队列时，您可以设置队列上的选项，但这不是必需的。

$createQueueOptions = new CreateQueueOptions();
$createQueueOptions->addMetaData("key1", "value1");
$createQueueOptions->addMetaData("key2", "value2");

try	{
	// Create queue.
	$queueRestProxy->createQueue("myqueue", $createQueueOptions);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

队列的错误代码和消息

向队列中添加消息

要将消息添加到队列，请使用QueueRestProxy->createMessage。此方法接受队列名称、消息文本和消息选项（这些选项是可选的）。

try	{
	// Create message.
	$queueRestProxy->createMessage("myqueue", "Hello World!");
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

查看下一个消息

您可以通过调用QueueRestProxy->peekMessages来查看队列前面的消息（或消息），而无需将其从队列中删除。

// OPTIONAL: Set peek message options.
$message_options = new PeekMessagesOptions();
$message_options->setNumberOfMessages(1); // Default value is 1.

try	{
	$peekMessagesResult = $queueRestProxy->peekMessages("myqueue", $message_options);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

$messages = $peekMessagesResult->getQueueMessages();

// View messages.
$messageCount = count($messages);
if($messageCount <= 0){
	echo "There are no messages.<br />";
}
else{
	foreach($messages as $message)	{
		echo "Peeked message:<br />";
		echo "Message Id: ".$message->getMessageId()."<br />";
		echo "Date: ".date_format($message->getInsertionDate(), 'Y-m-d')."<br />";
		echo "Message text: ".$message->getMessageText()."<br /><br />";
	}
}

解列下一个消息

您的代码通过两个步骤从队列中删除消息。首先，您调用QueueRestProxy->listMessages，这使得消息对从队列中读取的任何其他代码都不可见。默认情况下，此消息将保持不可见30秒（如果在这段时间内未删除该消息，则它将再次在队列上可见）。要完成从队列中删除消息，您必须调用QueueRestProxy->deleteMessage。

// Get message.
$listMessagesResult = $queueRestProxy->listMessages("myqueue");
$messages = $listMessagesResult->getQueueMessages();
$message = $messages[0];

// Process message

// Get message Id and pop receipt.
$messageId = $message->getMessageId();
$popReceipt = $message->getPopReceipt();

try	{
	// Delete message.
	$queueRestProxy->deleteMessage("myqueue", $messageId, $popReceipt);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

服务总线队列

创建队列

try	{
	$queueInfo = new QueueInfo("myqueue");
	
	// Create queue.
	$serviceBusRestProxy->createQueue($queueInfo);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

错误代码和消息

发送消息

要将消息发送到服务总线队列，您的应用程序将调用ServiceBusRestProxy->sendQueueMessage方法。发送到（和从）服务总线队列的消息是BrokeredMessage类的实例。

try	{
	// Create message.
	$message = new BrokeredMessage();
	$message->setBody("my message");

	// Send message.
	$serviceBusRestProxy->sendQueueMessage("myqueue", $message);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

接收消息

从队列接收消息的主要方法是使用ServiceBusRestProxy->receiveQueueMessage方法。消息可以以两种不同的模式接收：ReceiveAndDelete（在读取时标记消息为已消费）和PeekLock（锁定消息一段时间，但不删除）。

以下示例演示了如何使用PeekLock模式（非默认模式）接收和处理消息。

try	{
	// Set the receive mode to PeekLock (default is ReceiveAndDelete).
	$options = new ReceiveMessageOptions();
	$options->setPeekLock(true);
	
	// Receive message.
	$message = $serviceBusRestProxy->receiveQueueMessage("myqueue", $options);
	echo "Body: ".$message->getBody()."<br />";
	echo "MessageID: ".$message->getMessageId()."<br />";
	
	// *** Process message here ***
	
	// Delete message.
	$serviceBusRestProxy->deleteMessage($message);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

服务总线主题

创建主题

try	{		
	// Create topic.
	$topicInfo = new TopicInfo("mytopic");
	$serviceBusRestProxy->createTopic($topicInfo);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

使用默认（MatchAll）筛选器创建订阅

try	{
	// Create subscription.
	$subscriptionInfo = new SubscriptionInfo("mysubscription");
	$serviceBusRestProxy->createSubscription("mytopic", $subscriptionInfo);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

向主题发送消息

发送到服务总线主题的消息是BrokeredMessage类的实例。

try	{
	// Create message.
	$message = new BrokeredMessage();
	$message->setBody("my message");

	// Send message.
	$serviceBusRestProxy->sendTopicMessage("mytopic", $message);
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

从主题接收消息

从订阅接收消息的主要方法是使用ServiceBusRestProxy->receiveSubscriptionMessage方法。接收到的消息可以在两种不同的模式下工作：ReceiveAndDelete（默认）和类似于服务总线队列的PeekLock。

以下示例演示了如何使用ReceiveAndDelete模式（默认模式）接收和处理消息。

try	{
	// Set receive mode to PeekLock (default is ReceiveAndDelete)
	$options = new ReceiveMessageOptions();
	$options->setReceiveAndDelete();

	// Get message.
	$message = $serviceBusRestProxy->receiveSubscriptionMessage("mytopic", 
																"mysubscription", 
																$options);
	echo "Body: ".$message->getBody()."<br />";
	echo "MessageID: ".$message->getMessageId()."<br />";
} catch(ServiceException $e){
	$code = $e->getCode();
	$error_message = $e->getMessage();
	echo $code.": ".$error_message."<br />";
}

服务管理

设置证书

您需要创建两个证书，一个用于服务器（.cer文件）和一个用于客户端（.pem文件）。要使用OpenSSL创建.pem文件，请执行以下操作

openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout mycert.pem -out mycert.pem

要创建.cer证书，请执行以下操作

openssl x509 -inform pem -in mycert.pem -outform der -out mycert.cer

列出可用位置

$serviceManagementRestProxy->listLocations();
$locations = $result->getLocations();
foreach($locations as $location){
      echo $location->getName()."<br />";
}

创建存储服务

要创建存储服务，您需要一个服务名称（在3到24个字符之间，且在Windows Azure中唯一），一个标签（服务的base-64编码名称，最多100个字符），以及一个位置或亲和组。提供服务的描述是可选的。

$name = "mystorageservice";
$label = base64_encode($name);
$options = new CreateStorageServiceOptions();
$options->setLocation('West US');

$result = $serviceManagementRestProxy->createStorageService($name, $label, $options);

创建云服务

云服务也称为托管服务（来自Windows Azure的早期版本）。createHostedServices 方法允许您通过提供托管服务名称（在Windows Azure中必须是唯一的）、标签（基于64编码的托管服务名称）和允许您设置服务位置或亲和组的CreateServiceOptions对象来创建一个新的托管服务。

$name = "myhostedservice";
$label = base64_encode($name);
$options = new CreateServiceOptions();
$options->setLocation('West US');
// Instead of setLocation, you can use setAffinityGroup to set an affinity group.

$result = $serviceManagementRestProxy->createHostedService($name, $label, $options);

创建部署

要将新的部署上传到Azure，您必须将包文件存储在托管服务的同一订阅下的Windows Azure Blob存储帐户中。您可以使用Windows Azure PowerShell cmdlets或cspack 命令行工具来创建部署包。

$hostedServiceName = "myhostedservice";
$deploymentName = "v1";
$slot = DeploymentSlot::PRODUCTION;
$packageUrl = "URL_for_.cspkg_file";
$configuration = file_get_contents('path_to_.cscfg_file');
$label = base64_encode($hostedServiceName);

$result = $serviceManagementRestProxy->createDeployment($hostedServiceName,
												 $deploymentName,
												 $slot,
												 $packageUrl,
												 $configuration,
												 $label);

$status = $serviceManagementRestProxy->getOperationStatus($result);
echo "Operation status: ".$status->getStatus()."<br />";

## 媒体服务

### 使用文件创建新资产

要创建带有文件的资产，您需要创建一个空的资产，创建具有写入权限的访问策略，创建一个连接您的资产和访问策略的定位器，执行实际的上传并生成文件信息。

$asset = new Asset(Asset::OPTIONS_NONE);
$asset = $restProxy->createAsset($asset);

$access = new AccessPolicy('[Some access policy name]');
$access->setDurationInMinutes([Munites AccessPolicy is valid]);
$access->setPermissions(AccessPolicy::PERMISSIONS_WRITE);
$access = $restProxy->createAccessPolicy($access);

$locator = new Locator($asset,  $access, Locator::TYPE_SAS);
$locator->setStartTime(new \DateTime('now -5 minutes'));
$locator = $restProxy->createLocator($locator);

$restProxy->uploadAssetFile($locator, '[file name]', '[file content]');
$restProxy->createFileInfos($asset);

### 编码资产

要执行媒体文件编码，您需要包含文件的输入资产（$inputAsset）（类似于前一章中的某些内容）。您还需要创建一个任务数据对象数组和作业数据对象。要创建任务对象，请使用媒体处理器、任务XML体和配置名称。

$mediaProcessor = $this->restProxy->getLatestMediaProcessor('[Media processor]');

$task = new Task('[Task XML body]', $mediaProcessor->getId(), TaskOptions::NONE);
$task->setConfiguration('[Configuration name]');

$restProxy->createJob(new Job(), array($inputAsset), array($task));

### 获取编码资产的公共URL

在您上传了媒体文件并对其进行编码后，您可以获取该文件的下载URL。创建一个新的具有读取权限的访问策略，并通过定位器将其链接到作业输出资产。

$accessPolicy = new AccessPolicy('[Some access policy name]');
$accessPolicy->setDurationInMinutes([Munites AccessPolicy is valid]);
$accessPolicy->setPermissions(AccessPolicy::PERMISSIONS_READ);
$accessPolicy = $restProxy->createAccessPolicy($accessPolicy);

$locator = new Locator($asset, $accessPolicy, Locator::TYPE_SAS);
$locator->setStartTime(new \DateTime('now -5 minutes'));
$locator = $restProxy->createLocator($locator);

// Azure needs time to publish media
sleep(30);

$url = $locator->getBaseUri() . '/' . '[File name]' . $locator->getContentAccessComponent()

### 管理媒体服务实体

媒体服务的CRUD操作通过媒体服务REST代理类执行。它具有“创建资产”、“创建定位器”、“创建作业”等用于实体创建的方法。

要获取所有实体列表，您可以使用“getAssetList”、“getAccessPolicyList”、“getLocatorList”、“getJobList”等方法。要获取单个实体数据，请使用“getAsset”、“getJob”、“getTask”等方法，将实体标识符或包含非空标识符的实体数据模型对象作为参数传递。

使用“updateLocator”、“updateAsset”、“updateAssetFile”等方法更新实体，将实体数据模型对象作为参数传递。在数据模型对象中指定有效的实体标识符很重要。

使用“deleteAsset”、“deleteAccessPolicy”、“deleteJob”等方法删除实体，将实体标识符或包含非空标识符的实体数据模型对象作为参数传递。

您还可以使用“getAssetLocators”、“getAssetParentAssets”、“getAssetStorageAccount”、“getLocatorAccessPolicy”、“getJobTasks”等方法获取链接的实体，将实体标识符或包含非空标识符的实体数据模型对象作为参数传递。

您可以在IMediaServices接口中找到所有可用方法的完整列表。

有关更多示例，请参阅Windows Azure PHP开发者中心

需要帮助？

如果您在提供的代码中遇到问题，请务必查看Stack Overflow上的Windows Azure 开发者论坛。

贡献代码或提供反馈

如果您想成为该项目的积极贡献者，请遵循Windows Azure项目贡献指南中提供的说明。

要设置您的开发环境，请遵循此wiki页面中的说明。

如果您在使用库时遇到任何错误，请在该项目的问题部分提交一个问题。

了解更多

Windows Azure PHP开发者中心