Storage Accounts - List Service SAS

List service SAS credentials of a specific resource.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas?api-version=2019-06-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
canonicalizedResource True
  • string

The canonical path to the signed resource.

endPk
  • string

The end of partition key.

endRk
  • string

The end of row key.

keyToSign
  • string

The key to sign the account SAS token with.

rscc
  • string

The response header override for cache control.

rscd
  • string

The response header override for content disposition.

rsce
  • string

The response header override for content encoding.

rscl
  • string

The response header override for content language.

rsct
  • string

The response header override for content type.

signedExpiry
  • string

The time at which the shared access signature becomes invalid.

signedIdentifier
  • string

A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table.

signedIp
  • string

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

signedPermission

The signed permissions for the service 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.

signedResource

The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).

signedStart
  • string

The time at which the SAS becomes valid.

startPk
  • string

The start of partition key.

startRk
  • string

The start of row key.

Responses

Name Type Description
200 OK

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

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

StorageAccountListServiceSAS

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7439/providers/Microsoft.Storage/storageAccounts/sto1299/ListServiceSas?api-version=2019-06-01
{
  "canonicalizedResource": "/blob/sto1299/music",
  "signedResource": "c",
  "signedPermission": "l",
  "signedExpiry": "2017-05-24T11:32:48.8457197Z"
}

Sample Response

{
  "serviceSasToken": "sv=2015-04-05&sr=c&se=2017-05-24T11%3A32%3A48Z&sp=l&sig=PoF8yBUGixsjzwroLmw7vG3VbGz4KB2woZC2D4C2oio%3D"
}

Definitions

HttpProtocol

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

ListServiceSasResponse

The List service 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).

ServiceSasParameters

The parameters to list service SAS credentials of a specific resource.

signedResource

The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).

HttpProtocol

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

Name Type Description
https
  • string
https,http
  • string

ListServiceSasResponse

The List service SAS credentials operation response.

Name Type Description
serviceSasToken
  • string

List service SAS credentials of specific resource.

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

ServiceSasParameters

The parameters to list service SAS credentials of a specific resource.

Name Type Description
canonicalizedResource
  • string

The canonical path to the signed resource.

endPk
  • string

The end of partition key.

endRk
  • string

The end of row key.

keyToSign
  • string

The key to sign the account SAS token with.

rscc
  • string

The response header override for cache control.

rscd
  • string

The response header override for content disposition.

rsce
  • string

The response header override for content encoding.

rscl
  • string

The response header override for content language.

rsct
  • string

The response header override for content type.

signedExpiry
  • string

The time at which the shared access signature becomes invalid.

signedIdentifier
  • string

A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table.

signedIp
  • string

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

signedPermission

The signed permissions for the service 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.

signedResource

The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).

signedStart
  • string

The time at which the SAS becomes valid.

startPk
  • string

The start of partition key.

startRk
  • string

The start of row key.

signedResource

The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).

Name Type Description
b
  • string
c
  • string
f
  • string
s
  • string