azure-storage-queue\src\Queue\QueueSharedAccessSignatureHelper.php
Classes
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
- 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
Methods
__construct(string $accountName, string $accountKey) : voidConstructor.
| Name | Type | Description |
|---|---|---|
| $accountName | string | the name of the storage account. |
| $accountKey | string | the shared key of the storage account |
__construct(string $accountName, string $accountKey) : voidConstructor.
Inherited from:| Name | Type | Description |
|---|---|---|
| $accountName | string | the name of the storage account. |
| $accountKey | string | the shared key of the storage account |
generateAccountSharedAccessSignatureToken(string $signedVersion, string $signedPermissions, string $signedService, string $signedResourceType, \Datetime | string $signedExpiry, \Datetime | string $signedStart = "", string $signedIP = "", string $signedProtocol = "") : stringGenerates a shared access signature at the account level.
Inherited from:| Name | Type | Description |
|---|---|---|
| $signedVersion | string | Specifies the signed version to use. |
| $signedPermissions | string | Specifies the signed permissions for the account SAS. |
| $signedService | string | Specifies the signed services accessible with the account SAS. |
| $signedResourceType | string | 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. |
| $signedIP | string | Specifies an IP address or a range of IP addresses from which to accept requests. |
| $signedProtocol | string | Specifies the protocol permitted for a request made with the account SAS. |
| Type | Description |
|---|---|
| string |
generateCanonicalResource(string $accountName, string $service, string $resource) : stringGenerate the canonical resource using the given account name, service type and resource.
Inherited from:| Name | Type | Description |
|---|---|---|
| $accountName | string | The account name of the service. |
| $service | string | The service name of the service. |
| $resource | string | The name of the resource. |
| Type | Description |
|---|---|
| string |
generateQueueServiceSharedAccessSignatureToken(string $queueName, string $signedPermissions, \Datetime | string $signedExpiry, \Datetime | string $signedStart = "", string $signedIP = "", string $signedProtocol = "", string $signedIdentifier = "") : stringGenerates a queue service shared access signature.
This only supports version 2015-04-05 and later.
| Name | Type | Description |
|---|---|---|
| $queueName | string | The name of the queue. |
| $signedPermissions | string | Signed permissions. |
| $signedExpiry | \Datetime | string | Signed expiry date. |
| $signedStart | \Datetime | string | Signed start date. |
| $signedIP | string | Signed IP address. |
| $signedProtocol | string | Signed protocol. |
| $signedIdentifier | string | Signed identifier. |
| Type | Description |
|---|---|
| string |
validateAndSanitizeSignedPermissions(string $signedPermissions) : stringValidates and sanitizes the signed permissions parameter
Inherited from:| Name | Type | Description |
|---|---|---|
| $signedPermissions | string | Specifies the signed permissions for the account SAS. |
| Type | Description |
|---|---|
| string |
validateAndSanitizeSignedProtocol(string $signedProtocol) : stringValidates and sanitizes the signed protocol parameter
Inherited from:| Name | Type | Description |
|---|---|---|
| $signedProtocol | string | Specifies the signed protocol for the account SAS. |
| Type | Description |
|---|---|
| string |
validateAndSanitizeSignedResourceType(string $signedResourceType) : stringValidates and sanitizes the signed resource type parameter
Inherited from:| Name | Type | Description |
|---|---|---|
| $signedResourceType | string | Specifies the signed resource types that are accessible with the account SAS. |
| Type | Description |
|---|---|
| string |
validateAndSanitizeSignedService(string $signedService) : stringValidates and sanitizes the signed service parameter
Inherited from:| Name | Type | Description |
|---|---|---|
| $signedService | string | Specifies the signed services accessible with the account SAS. |
| Type | Description |
|---|---|
| string |
validateAndSanitizeStringWithArray(string $input, $array) : stringRemoves duplicate characters from a string
Inherited from:| Name | Type | Description |
|---|---|---|
| $input | string | The input string. |
| $array |
| Type | Description |
|---|---|
| string |