Get/Set Service Properties
and Get Service Stats
operations.SAS Query Parameter | Description |
---|---|
api-version | Optional. Specifies the storage service version to use to execute the request made using the account SAS URI. |
SignedVersion (sv) | Required. Specifies the signed storage service version to use to authorize requests made with this account SAS. Must be set to version 2015-04-05 or later. |
SignedServices (ss) | Required. Specifies the signed services accessible with the account SAS. Possible values include: - Blob ( b )- Queue ( q )- Table ( t )- File ( f )You can combine values to provide access to more than one service. For example, ss=bf specifies access to the Blob and File endpoints. |
SignedResourceTypes (srt) | Required. Specifies the signed resource types that are accessible with the account SAS. - Service ( s ): Access to service-level APIs (e.g., Get/Set Service Properties, Get Service Stats, List Containers/Queues/Tables/Shares)- Container ( c ): Access to container-level APIs (e.g., Create/Delete Container, Create/Delete Queue, Create/Delete Table, Create/Delete Share, List Blobs/Files and Directories)- Object ( o ): Access to object-level APIs for blobs, queue messages, table entities, and files(e.g. Put Blob, Query Entity, Get Messages, Create File, etc.)You can combine values to provide access to more than one resource type. For example, srt=sc specifies access to service and container resources. |
SignedPermission (sp) | Required. Specifies the signed permissions for the account SAS. Permissions are only valid if they match the specified signed resource type; otherwise they are ignored. - Read ( r ): Valid for all signed resources types (Service, Container, and Object). Permits read permissions to the specified resource type.- Write ( w ): Valid for all signed resources types (Service, Container, and Object). Permits write permissions to the specified resource type.- Delete ( d ): Valid for Container and Object resource types, except for queue messages.- List ( l ): Valid for Service and Container resource types only.- Add ( a ): Valid for the following Object resource types only: queue messages, table entities, and append blobs.- Create ( c ): Valid for the following Object resource types only: blobs and files. Users can create new blobs or files, but may not overwrite existing blobs or files.- Update ( u ): Valid for the following Object resource types only: queue messages and table entities.- Process ( p ): Valid for the following Object resource type only: queue messages. |
SignedStart (st) | Optional. The time at which the SAS becomes valid, in an ISO 8601 format. If omitted, start time for this call is assumed to be the time when the storage service receives the request. |
SignedExpiry (se) | Required. The time at which the shared access signature becomes invalid, in an ISO 8601 format. |
SignedIP (sip) | Optional. Specifies an IP address or a range of IP addresses from which to accept requests. When specifying a range, note that the range is inclusive. For example, sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 . |
SignedProtocol (spr) | Optional. Specifies the protocol permitted for a request made with the account SAS. Possible values are both HTTPS and HTTP (https,http ) or HTTPS only (https ). The default value is https,http .Note that HTTP only is not a permitted value. |
Signature (sig) | Required. The signature part of the URI is used to authorize the request made with the shared access signature. The string-to-sign is a unique string constructed from the fields that must be verified in order to authorize the request. The signature is an HMAC computed over the string-to-sign and key using the SHA256 algorithm, and then encoded using Base64 encoding. |
SignedStart
and SignedExpiry
Supreme commander cd key. fields must be expressed as UTC times and must adhere to a valid ISO 8601 format. Supported ISO 8601 formats include the following:Operation | Signed Service | Signed Resource Type | Signed Permission |
---|---|---|---|
List Containers | Blob (b) | Service (s) | List (l) |
Get Blob Service Properties | Blob (b) | Service (s) | Read (r) |
Set Blob Service Properties | Blob (b) | Service (s) | Write (w) |
Get Blob Service Stats | Blob (b) | Service (s) | Read (r) |
Create Container | Blob (b) | Container (c) | Create(c) or Write (w) |
Get Container Properties | Blob (b) | Container (c) | Read (r) |
Get Container Metadata | Blob (b) | Container (c) | Read (r) |
Set Container Metadata | Blob (b) | Container (c) | Write (w) |
Lease Container | Blob (b) | Container (c) | Write (w) or Delete (d)1 |
Delete Container | Blob (b) | Container (c) | Delete (d) |
List Blobs | Blob (b) | Container (c) | List (l) |
Put Blob (create new block blob) | Blob (b) | Object (o) | Create (c) or Write (w) |
Put Blob (overwrite existing block blob) | Blob (b) | Object (o) | Write (w) |
Put Blob (create new page blob) | Blob (b) | Object (o) | Create (c) or Write (w) |
Put Blob (overwrite existing page blob) | Blob (b) | Object (o) | Write (w) |
Get Blob | Blob (b) | Object (o) | Read (r) |
Get Blob Properties | Blob (b) | Object (o) | Read (r) |
Set Blob Properties | Blob (b) | Object (o) | Write (w) |
Get Blob Metadata | Blob (b) | Object (o) | Read (r) |
Set Blob Metadata | Blob (b) | Object (o) | Write (w) |
Delete Blob | Blob (b) | Object (o) | Delete (d) |
Lease Blob | Blob (b) | Object (o) | Write (w) or Delete (d)1 |
Snapshot Blob | Blob (b) | Object (o) | Create (c) or Write (w) |
Copy Blob (destination is new blob) | Blob (b) | Object (o) | Create (c) or Write (w) |
Copy Blob (destination is an existing blob) | Blob (b) | Object (o) | Write (w) |
Incremental Copy | Blob (b) | Object (o) | Create (c) or Write (w) |
Abort Copy Blob | Blob (b) | Object (o) | Write (w) |
Put Block | Blob (b) | Object (o) | Write (w) |
Put Block List (create new blob) | Blob (b) | Object (o) | Write (w) |
Put Block List (update existing blob) | Blob (b) | Object (o) | Write (w) |
Get Block List | Blob (b) | Object (o) | Read (r) |
Put Page | Blob (b) | Object (o) | Write (w) |
Get Page Ranges | Blob (b) | Object (o) | Read (r) |
Append Block | Blob (b) | Object (o) | Add (a) or Write (w) |
Clear Page | Blob (b) | Object (o) | Write (w) |
Delete
permission allows breaking a lease on a blob or container with version 2017-07-29 and later.Operation | Signed Service | Signed Resource Type | Signed Permission |
---|---|---|---|
Get Queue Service Properties | Queue (q) | Service (s) | Read (r) |
Set Queue Service Properties | Queue (q) | Service (s) | Write (w) |
List Queues | Queue (q) | Service (s) | List (l) |
Get Queue Service Stats | Queue (q) | Service (s) | Read (r) |
Create Queue | Queue (q) | Container (c) | Create(c) or Write (w) |
Delete Queue | Queue (q) | Container (c) | Delete (d) |
Get Queue Metadata | Queue (q) | Container (c) | Read (r) |
Set Queue Metadata | Queue (q) | Container (c) | Write (w) |
Put Message | Queue (q) | Object (o) | Add (a) |
Get Messages | Queue (q) | Object (o) | Process (p) |
Peek Messages | Queue (q) | Object (o) | Read (r) |
Delete Message | Queue (q) | Object (o) | Process (p) |
Clear Messages | Queue (q) | Object (o) | Delete (d) |
Update Message | Queue (q) | Object (o) | Update (u) |
Operation | Signed Service | Signed Resource Type | Signed Permission |
---|---|---|---|
Get Table Service Properties | Table (t) | Service (s) | Read (r) |
Set Table Service Properties | Table (t) | Service (s) | Write (w) |
Get Table Service Stats | Table (t) | Service (s) | Read (r) |
Query Tables | Table (t) | Container (c) | List (l) |
Create Table | Table (t) | Container (c) | Create (c) or Write (w) |
Delete Table | Table (t) | Container (c) | Delete (d) |
Query Entities | Table (t) | Object (o) | Read (r) |
Insert Entity | Table (t) | Object (o) | Add (a) |
Insert Or Merge Entity | Table (t) | Object (o) | Add (a) and Update (u)1 |
Insert Or Replace Entity | Table (t) | Object (o) | Add (a) and Update (u)1 |
Update Entity | Table (t) | Object (o) | Update (u) |
Merge Entity | Table (t) | Object (o) | Update (u) |
Delete Entity | Table (t) | Object (o) | Delete (d) |
Operation | Signed Service | Signed Resource Type | Signed Permission |
---|---|---|---|
List Shares | File (f) | Service (s) | List (l) |
Get File Service Properties | File (f) | Service (s) | Read (r) |
Set File Service Properties | File (f) | Service (s) | Write (w) |
Get Share Stats | File (f) | Container (c) | Read (r) |
Create Share | File (f) | Container (c) | Create (c) or Write (w) |
Snapshot Share | File (f) | Container (c) | Create (c) or Write (w) |
Get Share Properties | File (f) | Container (c) | Read (r) |
Set Share Properties | File (f) | Container (c) | Write (w) |
Get Share Metadata | File (f) | Container (c) | Read (r) |
Set Share Metadata | File (f) | Container (c) | Write (w) |
Delete Share | File (f) | Container (c) | Delete (d) |
List Directories and Files | File (f) | Container (c) | List (l) |
Create Directory | File (f) | Object (o) | Create (c) or Write (w) |
Get Directory Properties | File (f) | Object (o) | Read (r) |
Get Directory Metadata | File (f) | Object (o) | Read (r) |
Set Directory Metadata | File (f) | Object (o) | Write (w) |
Delete Directory | File (f) | Object (o) | Delete (d) |
Create File (create new) | File (f) | Object (o) | Create (c) or Write (w) |
Create File (overwrite existing) | File (f) | Object (o) | Write (w) |
Get File | File (f) | Object (o) | Read (r) |
Get File Properties | File (f) | Object (o) | Read (r) |
Get File Metadata | File (f) | Object (o) | Read (r) |
Set File Metadata | File (f) | Object (o) | Write (w) |
Delete File | File (f) | Object (o) | Delete (d) |
Put Range | File (f) | Object (o) | Write (w) |
List Ranges | File (f) | Object (o) | Read (r) |
Abort Copy File | File (f) | Object (o) | Write (w) |
Copy File | File (f) | Object (o) | Write (w) |
Clear Range | File (f) | Object (o) | Write (w) |
Name | SAS portion | Description |
---|---|---|
Resource URI | https://myaccount.blob.core.windows.net/?restype=service&comp=properties | The service endpoint, with parameters for getting service properties (when called with GET) or setting service properties (when called with SET). Based on the value of the signed services field (ss ), this SAS can be used with either Blob storage or Azure Files. |
Storage services version | sv=2019-02-02 | For storage services version 2012-02-12 and later, this parameter indicates the version to use. |
Services | ss=bf | The SAS applies to the Blob and File services |
Resource types | srt=s | The SAS applies to service-level operations. |
Start time | st=2019-08-01T22%3A18%3A26Z | Specified in UTC time. If you want the SAS to be valid immediately, omit the start time. |
Expiry time | se=2019-08-10T02%3A23%3A26Z | Specified in UTC time. |
Permissions | sp=rw | The permissions grant access to read and write operations. |
IP range | sip=168.1.5.60-168.1.5.70 | The range of IP addresses from which a request will be accepted. |
Protocol | spr=https | Only requests using HTTPS are permitted. |
Signature | sig=F%6GRVAZ5Cdj2Pw4tgU7IlSTkWgn7bUkkAg8P6HESXwmf%4B | Used to authorize access to the blob. The signature is an HMAC computed over a string-to-sign and key using the SHA256 algorithm, and then encoded using Base64 encoding. |
services | platforms | author |
---|---|---|
nodejs |
manualIntegration
which controls whether or not a deployment trigger is registered with GitHub. Use true
if you are deploying from the main Azure-Samples repo (does not register hook), false
otherwise (registers hook). Since a value of false
registers the deployment hook with GitHub, deployment will fail if you don't have write permissions to the repo.container
- required. Name of container in storage accountblobName
- optional. Used to scope permissions to a particular blobpermissions
- optional. Default value is read permissions. Possible values are: 'a' (Add), 'r' (Read), 'w' (Write), 'd' (Delete), 'l' (List). Concatenate multiple permissions, such as 'rwa' = Read, Write, Addtoken
- SAS token, which does not include a leading '?'uri
- Resource URI with token appended as query string