Storage Accounts - List Account SAS

List SAS credentials of a storage account.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas?api-version=2018-07-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The ID of the target subscription.

resourceGroupName
path True
  • string

The name of the resource group within the user's subscription. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

accountName
path True
  • string

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

api-version
query True
  • string

The API version to use for this operation.

Request Body

Name Required Type Description
keyToSign
  • string

The key to sign the account SAS token with.

signedExpiry True
  • string

The time at which the shared access signature becomes invalid.

signedIp
  • string

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

signedPermission True

The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).

signedProtocol

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

signedResourceTypes True

The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.

signedServices True

The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).

signedStart
  • string

The time at which the SAS becomes valid.

Responses

Name Type Description
200 OK

OK -- returned the account SAS created for the storage account requested.

Examples

StorageAccountListAccountSAS

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7985/providers/Microsoft.Storage/storageAccounts/sto8588/ListAccountSas?api-version=2018-07-01
{
  "signedServices": "b",
  "signedResourceTypes": "s",
  "signedPermission": "r",
  "signedProtocol": "https,http",
  "signedStart": "2017-05-24T10:42:03.1567373Z",
  "signedExpiry": "2017-05-24T11:42:03.1567373Z",
  "keyToSign": "key1"
}

Sample Response

{
  "accountSasToken": "sv=2015-04-05&ss=b&srt=s&sp=r&st=2017-05-24T10%3A42%3A03Z&se=2017-05-24T11%3A42%3A03Z&spr=https,http&sig=Z0I%2BEpM%2BPPlTC8ApfUf%2BcffO2aahMgZim3U0iArqsS0%3D"
}

Definitions

AccountSasParameters

The parameters to list SAS credentials of a storage account.

HttpProtocol

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

ListAccountSasResponse

The List SAS credentials operation response.

Permissions

The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).

Services

The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).

SignedResourceTypes

The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.

AccountSasParameters

The parameters to list SAS credentials of a storage account.

Name Type Description
keyToSign
  • string

The key to sign the account SAS token with.

signedExpiry
  • string

The time at which the shared access signature becomes invalid.

signedIp
  • string

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

signedPermission

The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).

signedProtocol

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

signedResourceTypes

The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.

signedServices

The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).

signedStart
  • string

The time at which the SAS becomes valid.

HttpProtocol

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

Name Type Description
https
  • string
https,http
  • string

ListAccountSasResponse

The List SAS credentials operation response.

Name Type Description
accountSasToken
  • string

List SAS credentials of storage account.

Permissions

The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).

Name Type Description
a
  • string
c
  • string
d
  • string
l
  • string
p
  • string
r
  • string
u
  • string
w
  • string

Services

The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).

Name Type Description
b
  • string
f
  • string
q
  • string
t
  • string

SignedResourceTypes

The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.

Name Type Description
c
  • string
o
  • string
s
  • string