azure-storage-queue\src\Queue\QueueSharedAccessSignatureHelper.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
Microsoft Corporation  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  
Package
MicrosoftAzure\Storage\Queue  

\MicrosoftAzure\Storage\Queue\QueueSharedAccessSignatureHelper

Package: MicrosoftAzure\Storage\Queue
Provides methods to generate Azure Storage Shared Access Signature
Parent(s)
\MicrosoftAzure\Storage\Common\SharedAccessSignatureHelper
Author
Azure Storage PHP SDK  
Category
Microsoft  
Copyright
2017 Microsoft Corporation  
Inherited_from
\MicrosoftAzure\Storage\Common\SharedAccessSignatureHelper  
License
https://github.com/azure/azure-storage-php/LICENSE  
Link
https://github.com/azure/azure-storage-php  

Properties

>VPropertyprotected$accountKey
Details
Type
n/a
>VPropertyprotected$accountName
Details
Type
n/a

Methods

methodpublic__construct(string $accountName, string $accountKey) : void

Constructor.

Parameters
NameTypeDescription
$accountNamestring

the name of the storage account.

$accountKeystring

the shared key of the storage account

methodpublic__construct(string $accountName, string $accountKey) : void
inherited

Constructor.

Inherited from:
Parameters
NameTypeDescription
$accountNamestring

the name of the storage account.

$accountKeystring

the shared key of the storage account

methodpublicgenerateAccountSharedAccessSignatureToken(string $signedVersion, string $signedPermissions, string $signedService, string $signedResourceType, \Datetime | string $signedExpiry, \Datetime | string $signedStart = "", string $signedIP = "", string $signedProtocol = "") : string
inherited

Generates a shared access signature at the account level.

Inherited from:
Parameters
NameTypeDescription
$signedVersionstring

Specifies the signed version to use.

$signedPermissionsstring

Specifies the signed permissions for the account SAS.

$signedServicestring

Specifies the signed services accessible with the account SAS.

$signedResourceTypestring

Specifies the signed resource types that are accessible with the account SAS.

$signedExpiry\Datetime | string

The time at which the shared access signature becomes invalid, in an ISO 8601 format.

$signedStart\Datetime | string

The time at which the SAS becomes valid, in an ISO 8601 format.

$signedIPstring

Specifies an IP address or a range of IP addresses from which to accept requests.

$signedProtocolstring

Specifies the protocol permitted for a request made with the account SAS.

Returns
TypeDescription
string
Details
See
an account SAS at https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/constructing-an-account-sas  
methodprotectedgenerateCanonicalResource(string $accountName, string $service, string $resource) : string
staticinherited

Generate the canonical resource using the given account name, service type and resource.

Inherited from:
Parameters
NameTypeDescription
$accountNamestring

The account name of the service.

$servicestring

The service name of the service.

$resourcestring

The name of the resource.

Returns
TypeDescription
string
methodpublicgenerateQueueServiceSharedAccessSignatureToken(string $queueName, string $signedPermissions, \Datetime | string $signedExpiry, \Datetime | string $signedStart = "", string $signedIP = "", string $signedProtocol = "", string $signedIdentifier = "") : string

Generates a queue service shared access signature.

This only supports version 2015-04-05 and later.

Parameters
NameTypeDescription
$queueNamestring

The name of the queue.

$signedPermissionsstring

Signed permissions.

$signedExpiry\Datetime | string

Signed expiry date.

$signedStart\Datetime | string

Signed start date.

$signedIPstring

Signed IP address.

$signedProtocolstring

Signed protocol.

$signedIdentifierstring

Signed identifier.

Returns
TypeDescription
string
Details
See
an service SAS at https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas  
methodprotectedvalidateAndSanitizeSignedPermissions(string $signedPermissions) : string
inherited

Validates and sanitizes the signed permissions parameter

Inherited from:
Parameters
NameTypeDescription
$signedPermissionsstring

Specifies the signed permissions for the account SAS.

Returns
TypeDescription
string
methodprotectedvalidateAndSanitizeSignedProtocol(string $signedProtocol) : string
inherited

Validates and sanitizes the signed protocol parameter

Inherited from:
Parameters
NameTypeDescription
$signedProtocolstring

Specifies the signed protocol for the account SAS.

Returns
TypeDescription
string
methodprotectedvalidateAndSanitizeSignedResourceType(string $signedResourceType) : string
inherited

Validates and sanitizes the signed resource type parameter

Inherited from:
Parameters
NameTypeDescription
$signedResourceTypestring

Specifies the signed resource types that are accessible with the account SAS.

Returns
TypeDescription
string
methodprotectedvalidateAndSanitizeSignedService(string $signedService) : string
inherited

Validates and sanitizes the signed service parameter

Inherited from:
Parameters
NameTypeDescription
$signedServicestring

Specifies the signed services accessible with the account SAS.

Returns
TypeDescription
string
methodprotectedvalidateAndSanitizeStringWithArray(string $input,  $array) : string
inherited

Removes duplicate characters from a string

Inherited from:
Parameters
NameTypeDescription
$inputstring

The input string.

$array
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.9.1.