azure-storage-table\src\Table\TableRestProxy.php

Show: PublicProtectedPrivateinherited
Table of Contents
LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

PHP version 5

Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2016 Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  
Package
MicrosoftAzure\Storage\Table  

\MicrosoftAzure\Storage\Table\TableRestProxy

Package: MicrosoftAzure\Storage\Table
This class constructs HTTP requests and receive HTTP responses for table service layer.
Implements
Parent(s)
\MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy
Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2016 Microsoft Corporation  
Inherited_from
\MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  

Properties

>VPropertyprotected\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer $dataSerializer
Details
Type
\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer

Methods

methodpublic__construct(string $primaryUri, string $secondaryUri, \MicrosoftAzure\Storage\Table\Internal\IODataReaderWriter $odataSerializer, \MicrosoftAzure\Storage\Table\Internal\IMimeReaderWriter $mimeSerializer, array $options = array()) : void

Initializes new TableRestProxy object.

Parameters
NameTypeDescription
$primaryUristring

The storage account primary uri.

$secondaryUristring

The storage account secondary uri.

$odataSerializer\MicrosoftAzure\Storage\Table\Internal\IODataReaderWriter

The odata serializer.

$mimeSerializer\MicrosoftAzure\Storage\Table\Internal\IMimeReaderWriter

The MIME serializer.

$optionsarray

Array of options to pass to the service

methodpublic__construct(\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer $dataSerializer = null) : void
inherited

Initializes new RestProxy object.

Inherited from:
Parameters
NameTypeDescription
$dataSerializer\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer

The data serializer.

methodprotectedaddMetadataHeaders(array $headers, array $metadata = null) : array
inherited

Adds metadata elements to headers array

Inherited from:
Parameters
NameTypeDescription
$headersarray

HTTP request headers

$metadataarray

user specified metadata

Returns
TypeDescription
array
methodprotectedaddOptionalHeader(array $headers, string $key, string $value) : void
inherited

Adds optional header.

Inherited from:

Doesn't add the value if it satisfies empty().

Parameters
NameTypeDescription
$headersarray

&$headers The HTTP header parameters.

$keystring

The HTTP header name.

$valuestring

The HTTP header value.

methodprotectedaddOptionalQueryParam(array $queryParameters, string $key, string $value) : void
inherited

Adds optional query parameter.

Inherited from:

Doesn't add the value if it satisfies empty().

Parameters
NameTypeDescription
$queryParametersarray

&$queryParameters The query parameters.

$keystring

The query variable name.

$valuestring

The query variable value.

methodpublicaddPostParameter(array $postParameters, string $key, string $value) : array
inherited

Adds HTTP POST parameter to the specified

Inherited from:
Parameters
NameTypeDescription
$postParametersarray

An array of HTTP POST parameters.

$keystring

The key of a HTTP POST parameter.

$valuestring

the value of a HTTP POST parameter.

Returns
TypeDescription
array
methodpublicbatch(\MicrosoftAzure\Storage\Table\BatchOperations $batchOperations, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\BatchResult

Does batch of operations on the table service.

Parameters
NameTypeDescription
$batchOperations\MicrosoftAzure\Storage\Table\BatchOperations

The operations to apply.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\BatchResult
methodpublicbatchAsync(\MicrosoftAzure\Storage\Table\BatchOperations $batchOperations, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise that does batch of operations on the table service.

Parameters
NameTypeDescription
$batchOperations\MicrosoftAzure\Storage\Table\BatchOperations

The operations to apply.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
methodprotectedcreateMiddlewareStack(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions) : \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack
inherited

Create a middleware stack with given middleware.

Inherited from:
Parameters
NameTypeDescription
$serviceOptions\MicrosoftAzure\Storage\Common\Models\ServiceOptions

The options user passed in.

Returns
TypeDescription
\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack
methodprotectedcreateRequest(string $method, array $headers, array $queryParams, array $postParameters, string $path,  $locationMode, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING) : \GuzzleHttp\Psr7\Request
inherited

Create the request to be sent.

Inherited from:
Parameters
NameTypeDescription
$methodstring

The method of the HTTP request

$headersarray

The header field of the request

$queryParamsarray

The query parameter of the request

$postParametersarray

The HTTP POST parameters

$pathstring

URL path

$locationMode
$bodystring

Request body

Returns
TypeDescription
\GuzzleHttp\Psr7\Request
methodpubliccreateTable(string $table, \MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions $options = null) : \Psr\Http\Message\ResponseInterface

Creates new table in the storage account

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions

The optional parameters.

Returns
TypeDescription
\Psr\Http\Message\ResponseInterface
Details
See
 
methodpubliccreateTableAsync(string $table, \MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to create new table in the storage account

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpubliccreateTableService(string $connectionString, array $options = array()) : \MicrosoftAzure\Storage\Table\TableRestProxy
static

Builds a table service object, it accepts the following options:

  • http: (array) the underlying guzzle options. refer to http://docs.guzzlephp.org/en/latest/request-options.html for detailed available options
  • middlewares: (mixed) the middleware should be either an instance of a sub-class that implements \MicrosoftAzure\Storage\Table\MicrosoftAzure\Storage\Common\Middlewares\IMiddleware, or a callable that follows the Guzzle middleware implementation convention

Please refer to https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string for how to construct a connection string with storage account name/key, or with a shared access signature (SAS Token).

Parameters
NameTypeDescription
$connectionStringstring

The configuration connection string.

$optionsarray

Array of options to pass to the service

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\TableRestProxy
methodpublicdeleteEntity(string $table, string $partitionKey, string $rowKey, \MicrosoftAzure\Storage\Table\Models\DeleteEntityOptions $options = null) : void

Deletes an existing entity in a table.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$partitionKeystring

The entity partition key.

$rowKeystring

The entity row key.

$options\MicrosoftAzure\Storage\Table\Models\DeleteEntityOptions

The optional parameters.

Details
See
 
methodpublicdeleteEntityAsync(string $table, string $partitionKey, string $rowKey, \MicrosoftAzure\Storage\Table\Models\DeleteEntityOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to delete an existing entity in a table.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$partitionKeystring

The entity partition key.

$rowKeystring

The entity row key.

$options\MicrosoftAzure\Storage\Table\Models\DeleteEntityOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicdeleteTable(string $table, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : void

Deletes the specified table and any data it contains.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Details
See
 
methodpublicdeleteTableAsync(string $table, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to delete the specified table and any data it contains.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicgenerateMetadataHeaders(array $metadata = null) : array
inherited

Generates metadata headers by prefixing each element with 'x-ms-meta'.

Inherited from:
Parameters
NameTypeDescription
$metadataarray

user defined metadata.

Returns
TypeDescription
array
methodprotectedgenerateRequestOptions(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions, callable $handler) : array
inherited

Generate the request options using the given service options and stored information.

Inherited from:
Parameters
NameTypeDescription
$serviceOptions\MicrosoftAzure\Storage\Common\Models\ServiceOptions

The service options used to generate request options.

$handlercallable

The handler used to send the request.

Returns
TypeDescription
array
methodpublicgetAccountName() : string
inherited

Gets the account name.

Inherited from:
Returns
TypeDescription
string
methodpublicgetEntity(string $table, string $partitionKey, string $rowKey, \MicrosoftAzure\Storage\Table\Models\GetEntityOptions | null $options = null) : \MicrosoftAzure\Storage\Table\Models\GetEntityResult

Gets table entity.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$partitionKeystring

The entity partition key.

$rowKeystring

The entity row key.

$options\MicrosoftAzure\Storage\Table\Models\GetEntityOptions | null

The optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\GetEntityResult
Details
See
 
methodpublicgetEntityAsync(string $table, string $partitionKey, string $rowKey, \MicrosoftAzure\Storage\Table\Models\GetEntityOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to get table entity.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$partitionKeystring

The entity partition key.

$rowKeystring

The entity row key.

$options\MicrosoftAzure\Storage\Table\Models\GetEntityOptions | null

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicgetMiddlewares() : array
inherited

Gets middlewares that will be handling the request and response.

Inherited from:
Returns
TypeDescription
array
methodpublicgetPsrPrimaryUri() : \GuzzleHttp\Psr7\Uri
inherited

Get the primary URI in PSR form.

Inherited from:
Returns
TypeDescription
\GuzzleHttp\Psr7\Uri
methodpublicgetPsrSecondaryUri() : \GuzzleHttp\Psr7\Uri
inherited

Get the secondary URI in PSR form.

Inherited from:
Returns
TypeDescription
\GuzzleHttp\Psr7\Uri
methodpublicgetServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServicePropertiesResult
inherited

Gets the properties of the service.

Inherited from:
Parameters
NameTypeDescription
$options\MicrosoftAzure\Storage\Common\Models\ServiceOptions

The optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Common\Models\GetServicePropertiesResult
Details
See
 
methodpublicgetServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
inherited

Creates promise to get the properties of the service.

Inherited from:
Parameters
NameTypeDescription
$options\MicrosoftAzure\Storage\Common\Models\ServiceOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicgetServiceStats(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult
inherited

Retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.

Inherited from:
Parameters
NameTypeDescription
$options\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null

The options this operation sends with.

Returns
TypeDescription
\MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult
methodpublicgetServiceStatsAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface
inherited

Creates promise that retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.

Inherited from:
Parameters
NameTypeDescription
$options\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null

The options this operation sends with.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
methodpublicgetTable(string $table, \MicrosoftAzure\Storage\Table\Models\GetTableOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\GetTableResult

Gets the table.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\GetTableOptions

The optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\GetTableResult
methodpublicgetTableAcl(string $table, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\TableACL

Gets the access control list (ACL)

Parameters
NameTypeDescription
$tablestring

The table name.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\TableACL
Details
See
 
methodpublicgetTableAclAsync(string $table, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates the promise to gets the access control list (ACL)

Parameters
NameTypeDescription
$tablestring

The table name.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicgetTableAsync(string $table, \MicrosoftAzure\Storage\Table\Models\GetTableOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates the promise to get the table.

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\GetTableOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
methodpublicgroupQueryValues(array $values) : string
staticinherited

Groups set of values into one value separated with Resources::SEPARATOR

Inherited from:
Parameters
NameTypeDescription
$valuesarray

array of values to be grouped.

Returns
TypeDescription
string
methodpublicinsertEntity(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\InsertEntityResult

Inserts new entity to the table.

Parameters
NameTypeDescription
$tablestring

name of the table.

$entity\MicrosoftAzure\Storage\Table\Models\Entity

table entity.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions

optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\InsertEntityResult
Details
See
 
methodpublicinsertEntityAsync(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Inserts new entity to the table.

Parameters
NameTypeDescription
$tablestring

name of the table.

$entity\MicrosoftAzure\Storage\Table\Models\Entity

table entity.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceCreateOptions

optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicinsertOrMergeEntity(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\UpdateEntityResult

Updates an existing entity or inserts a new entity if it does not exist in the table.

Parameters
NameTypeDescription
$tablestring

name of the table

$entity\MicrosoftAzure\Storage\Table\Models\Entity

table entity

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\UpdateEntityResult
Details
See
 
methodpublicinsertOrMergeEntityAsync(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to update an existing entity or inserts a new entity if it does not exist in the table.

Parameters
NameTypeDescription
$tablestring

name of the table

$entity\MicrosoftAzure\Storage\Table\Models\Entity

table entity

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicinsertOrReplaceEntity(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\UpdateEntityResult

Replaces an existing entity or inserts a new entity if it does not exist in the table.

Parameters
NameTypeDescription
$tablestring

name of the table

$entity\MicrosoftAzure\Storage\Table\Models\Entity

table entity

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\UpdateEntityResult
Details
See
 
methodpublicinsertOrReplaceEntityAsync(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates a promise to replace an existing entity or inserts a new entity if it does not exist in the table.

Parameters
NameTypeDescription
$tablestring

name of the table

$entity\MicrosoftAzure\Storage\Table\Models\Entity

table entity

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicmergeEntity(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\UpdateEntityResult

Updates an existing entity by updating the entity's properties. This operation does not replace the existing entity, as the updateEntity operation does.

Parameters
NameTypeDescription
$tablestring

The table name.

$entity\MicrosoftAzure\Storage\Table\Models\Entity

The table entity.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\UpdateEntityResult
Details
See
 
methodpublicmergeEntityAsync(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to update an existing entity by updating the entity's properties. This operation does not replace the existing entity, as the updateEntity operation does.

Parameters
NameTypeDescription
$tablestring

The table name.

$entity\MicrosoftAzure\Storage\Table\Models\Entity

The table entity.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodprotectedonRejected(string | \Exception $reason, array | integer $expected) : \Psr\Http\Message\ResponseInterface
inherited

Inherited from:
Parameters
NameTypeDescription
$reasonstring | \Exception

Rejection reason.

$expectedarray | integer

Expected Status Codes.

Returns
TypeDescription
\Psr\Http\Message\ResponseInterface
methodpublicpushMiddleware(callable | \MicrosoftAzure\Storage\Common\Internal\IMiddleware $middleware) : void
inherited

Push a new middleware into the middlewares array. The newly added middleware will be the most inner middleware when executed.

Inherited from:
Parameters
NameTypeDescription
$middlewarecallable | \MicrosoftAzure\Storage\Common\Internal\IMiddleware

the middleware to be added.

methodpublicqueryEntities(string $table, \MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter $options = null) : \MicrosoftAzure\Storage\Table\Models\QueryEntitiesResult

Quries entities for the given table name

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter

Coule be optional parameters, query string or filter to apply.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\QueryEntitiesResult
Details
See
 
methodpublicqueryEntitiesAsync(string $table, \MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter $options = null) : \GuzzleHttp\Promise\PromiseInterface

Quries entities for the given table name

Parameters
NameTypeDescription
$tablestring

The name of the table.

$options\MicrosoftAzure\Storage\Table\Models\QueryEntitiesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter

Coule be optional parameters, query string or filter to apply.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicqueryTables(\MicrosoftAzure\Storage\Table\Models\QueryTablesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter $options = null) : \MicrosoftAzure\Storage\Table\Models\QueryTablesResult

Quries tables in the given storage account.

Parameters
NameTypeDescription
$options\MicrosoftAzure\Storage\Table\Models\QueryTablesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter

Could be optional parameters, table prefix or filter to apply.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\QueryTablesResult
Details
See
 
methodpublicqueryTablesAsync(\MicrosoftAzure\Storage\Table\Models\QueryTablesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to query the tables in the given storage account.

Parameters
NameTypeDescription
$options\MicrosoftAzure\Storage\Table\Models\QueryTablesOptions | string | \MicrosoftAzure\Storage\Table\Models\Filters\Filter

Could be optional parameters, table prefix or filter to apply.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodprotectedsendAsync(string $method, array $headers, array $queryParams, array $postParameters, string $path, array | integer $expected = \MicrosoftAzure\Storage\Common\Internal\Resources::STATUS_OK, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions = null) : \GuzzleHttp\Promise\PromiseInterface
inherited

Create promise of sending HTTP request with the specified parameters.

Inherited from:
Parameters
NameTypeDescription
$methodstring

HTTP method used in the request

$headersarray

HTTP headers.

$queryParamsarray

URL query parameters.

$postParametersarray

The HTTP POST parameters.

$pathstring

URL path

$expectedarray | integer

Expected Status Codes.

$bodystring

Request body

$serviceOptions\MicrosoftAzure\Storage\Common\Models\ServiceOptions

Service options

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
methodprotectedsendConcurrentAsync(callable $generator, integer $statusCode, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options) : \GuzzleHttp\Promise\Promise | \GuzzleHttp\Promise\PromiseInterface
inherited

Send the requests concurrently. Number of concurrency can be modified by inserting a new key/value pair with the key 'number_of_concurrency' into the $requestOptions of $serviceOptions. Return only the promise.

Inherited from:
Parameters
NameTypeDescription
$generatorcallable

the generator function to generate request upon fulfillment

$statusCodeinteger

The expected status code for each of the request generated by generator.

$options\MicrosoftAzure\Storage\Common\Models\ServiceOptions

The service options for the concurrent requests.

Returns
TypeDescription
\GuzzleHttp\Promise\Promise | \GuzzleHttp\Promise\PromiseInterface
methodprotectedsendContext(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Psr7\Response
inherited

Sends the context.

Inherited from:
Parameters
NameTypeDescription
$context\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext

The context of the request.

Returns
TypeDescription
\GuzzleHttp\Psr7\Response
methodprotectedsendContextAsync(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Promise\PromiseInterface
inherited

Creates the promise to send the context.

Inherited from:
Parameters
NameTypeDescription
$context\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext

The context of the request.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
methodpublicsetServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : void
inherited

Sets the properties of the service.

Inherited from:

It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.

Parameters
NameTypeDescription
$serviceProperties\MicrosoftAzure\Storage\Common\Models\ServiceProperties

The service properties.

$options\MicrosoftAzure\Storage\Common\Models\ServiceOptions

The optional parameters.

Details
See
 
methodpublicsetServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface
inherited

Creates the promise to set the properties of the service.

Inherited from:

It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.

Parameters
NameTypeDescription
$serviceProperties\MicrosoftAzure\Storage\Common\Models\ServiceProperties

The service properties.

$options\MicrosoftAzure\Storage\Common\Models\ServiceOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicsetTableAcl(string $table, \MicrosoftAzure\Storage\Table\Models\TableACL $acl, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : void

Sets the ACL.

Parameters
NameTypeDescription
$tablestring

name

$acl\MicrosoftAzure\Storage\Table\Models\TableACL

access control list for Table

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Details
See
 
methodpublicsetTableAclAsync(string $table, \MicrosoftAzure\Storage\Table\Models\TableACL $acl, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set the ACL

Parameters
NameTypeDescription
$tablestring

name

$acl\MicrosoftAzure\Storage\Table\Models\TableACL

access control list for Table

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

optional parameters

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
methodpublicthrowIfError(\Psr\Http\Message\ResponseInterface $response, array | integer $expected) : void
staticinherited

Throws ServiceException if the received status code is not expected.

Inherited from:
Parameters
NameTypeDescription
$response\Psr\Http\Message\ResponseInterface

The response received

$expectedarray | integer

The expected status codes.

Throws
ExceptionDescription
\MicrosoftAzure\Storage\Common\Exceptions\ServiceException
methodpublicupdateEntity(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \MicrosoftAzure\Storage\Table\Models\UpdateEntityResult

Updates an existing entity in a table. The Update Entity operation replaces the entire entity and can be used to remove properties.

Parameters
NameTypeDescription
$tablestring

The table name.

$entity\MicrosoftAzure\Storage\Table\Models\Entity

The table entity.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\UpdateEntityResult
Details
See
 
methodpublicupdateEntityAsync(string $table, \MicrosoftAzure\Storage\Table\Models\Entity $entity, \MicrosoftAzure\Storage\Table\Models\TableServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to update an existing entity in a table. The Update Entity operation replaces the entire entity and can be used to remove properties.

Parameters
NameTypeDescription
$tablestring

The table name.

$entity\MicrosoftAzure\Storage\Table\Models\Entity

The table entity.

$options\MicrosoftAzure\Storage\Table\Models\TableServiceOptions

The optional parameters.

Returns
TypeDescription
\GuzzleHttp\Promise\PromiseInterface
Details
See
 
Documentation was generated by phpDocumentor 2.9.1.