你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Storage Accounts - List Account SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

列出存储帐户的 SAS 凭据。

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。 Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	用户订阅中的资源组的名称。 此名称不区分大小写。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
signedExpiry	True	string	共享访问签名变为无效的时间。
signedPermission	True	Permissions	帐户 SAS 的已签名权限。 可能的值包括：Read (r) 、Write (w) 、Delete (d) 、List (l) 、Add () 、Create (c) 、Update (u) 和 Process (p) 。
signedResourceTypes	True	SignedResourceTypes	可通过帐户 SAS 访问的已签名资源类型。 服务 () ：访问服务级别 API;容器 (c) ：访问容器级 API;对象 (o) ：访问 Blob、队列消息、表实体和文件的对象级 API。
signedServices	True	Services	使用帐户 SAS 访问的已签名服务。 可能的值包括：Blob (b) 、Queue (q) 、Table (t) 、File (f) 。
keyToSign		string	用于对帐户 SAS 令牌进行签名的密钥。
signedIp		string	从中接受请求的 IP 地址或一系列 IP 地址。
signedProtocol		HttpProtocol	允许使用帐户 SAS 发出的请求的协议。
signedStart		string	SAS 生效的时间。

响应

名称	类型	说明
200 OK	ListAccountSasResponse	确定 -- 已返回为请求的存储帐户创建的帐户 SAS。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

StorageAccountListAccountSAS

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7985/providers/Microsoft.Storage/storageAccounts/sto8588/ListAccountSas?api-version=2023-01-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"
}

Java

import com.azure.resourcemanager.storage.models.AccountSasParameters;
import com.azure.resourcemanager.storage.models.HttpProtocol;
import com.azure.resourcemanager.storage.models.Permissions;
import com.azure.resourcemanager.storage.models.Services;
import com.azure.resourcemanager.storage.models.SignedResourceTypes;
import java.time.OffsetDateTime;

/** Samples for StorageAccounts ListAccountSas. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListAccountSAS.
     * json
     */
    /**
     * Sample code: StorageAccountListAccountSAS.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountListAccountSAS(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().listAccountSasWithResponse("res7985",
            "sto8588",
            new AccountSasParameters().withServices(Services.B).withResourceTypes(SignedResourceTypes.S)
                .withPermissions(Permissions.R).withProtocols(HttpProtocol.HTTPS_HTTP)
                .withSharedAccessStartTime(OffsetDateTime.parse("2017-05-24T10:42:03.1567373Z"))
                .withSharedAccessExpiryTime(OffsetDateTime.parse("2017-05-24T11:42:03.1567373Z"))
                .withKeyToSign("fakeTokenPlaceholder"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_list_account_sas.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.list_account_sas(
        resource_group_name="res7985",
        account_name="sto8588",
        parameters={
            "keyToSign": "key1",
            "signedExpiry": "2017-05-24T11:42:03.1567373Z",
            "signedPermission": "r",
            "signedProtocol": "https,http",
            "signedResourceTypes": "s",
            "signedServices": "b",
            "signedStart": "2017-05-24T10:42:03.1567373Z",
        },
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListAccountSAS.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListAccountSAS.json
func ExampleAccountsClient_ListAccountSAS() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().ListAccountSAS(ctx, "res7985", "sto8588", armstorage.AccountSasParameters{
		KeyToSign:              to.Ptr("key1"),
		SharedAccessExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-24T11:42:03.156Z"); return t }()),
		Permissions:            to.Ptr(armstorage.PermissionsR),
		Protocols:              to.Ptr(armstorage.HTTPProtocolHTTPSHTTP),
		ResourceTypes:          to.Ptr(armstorage.SignedResourceTypesS),
		Services:               to.Ptr(armstorage.ServicesB),
		SharedAccessStartTime:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-24T10:42:03.156Z"); return t }()),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ListAccountSasResponse = armstorage.ListAccountSasResponse{
	// 	AccountSasToken: to.Ptr("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"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List SAS credentials of a storage account.
 *
 * @summary List SAS credentials of a storage account.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListAccountSAS.json
 */
async function storageAccountListAccountSas() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res7985";
  const accountName = "sto8588";
  const parameters = {
    keyToSign: "key1",
    sharedAccessExpiryTime: new Date("2017-05-24T11:42:03.1567373Z"),
    permissions: "r",
    protocols: "https,http",
    resourceTypes: "s",
    services: "b",
    sharedAccessStartTime: new Date("2017-05-24T10:42:03.1567373Z"),
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.listAccountSAS(
    resourceGroupName,
    accountName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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"
}

定义

名称	说明
AccountSasParameters	用于列出存储帐户的 SAS 凭据的参数。
HttpProtocol	允许使用帐户 SAS 发出的请求的协议。
ListAccountSasResponse	列出 SAS 凭据操作响应。
Permissions	帐户 SAS 的已签名权限。 可能的值包括：Read (r) 、Write (w) 、Delete (d) 、List (l) 、Add () 、Create (c) 、Update (u) 和 Process (p) 。
Services	使用帐户 SAS 访问的已签名服务。 可能的值包括：Blob (b) 、Queue (q) 、Table (t) 、File (f) 。
SignedResourceTypes	可通过帐户 SAS 访问的已签名资源类型。 服务 () ：访问服务级别 API;容器 (c) ：访问容器级 API;对象 (o) ：访问 Blob、队列消息、表实体和文件的对象级 API。

AccountSasParameters

用于列出存储帐户的 SAS 凭据的参数。

名称	类型	说明
keyToSign	string	用于对帐户 SAS 令牌进行签名的密钥。
signedExpiry	string	共享访问签名变为无效的时间。
signedIp	string	从中接受请求的 IP 地址或一系列 IP 地址。
signedPermission	Permissions	帐户 SAS 的已签名权限。 可能的值包括：Read (r) 、Write (w) 、Delete (d) 、List (l) 、Add () 、Create (c) 、Update (u) 和 Process (p) 。
signedProtocol	HttpProtocol	允许使用帐户 SAS 发出的请求的协议。
signedResourceTypes	SignedResourceTypes	可通过帐户 SAS 访问的已签名资源类型。 服务 () ：访问服务级别 API;容器 (c) ：访问容器级 API;对象 (o) ：访问 Blob、队列消息、表实体和文件的对象级 API。
signedServices	Services	使用帐户 SAS 访问的已签名服务。 可能的值包括：Blob (b) 、Queue (q) 、Table (t) 、File (f) 。
signedStart	string	SAS 生效的时间。

HttpProtocol

允许使用帐户 SAS 发出的请求的协议。

名称	类型	说明
https	string
https,http	string

ListAccountSasResponse

列出 SAS 凭据操作响应。

名称	类型	说明
accountSasToken	string	列出存储帐户的 SAS 凭据。

Permissions

帐户 SAS 的已签名权限。 可能的值包括：Read (r) 、Write (w) 、Delete (d) 、List (l) 、Add () 、Create (c) 、Update (u) 和 Process (p) 。

名称	类型	说明
a	string
c	string
d	string
l	string
p	string
r	string
u	string
w	string

Services

使用帐户 SAS 访问的已签名服务。 可能的值包括：Blob (b) 、Queue (q) 、Table (t) 、File (f) 。

名称	类型	说明
b	string
f	string
q	string
t	string

SignedResourceTypes

可通过帐户 SAS 访问的已签名资源类型。 服务 () ：访问服务级别 API;容器 (c) ：访问容器级 API;对象 (o) ：访问 Blob、队列消息、表实体和文件的对象级 API。

名称	类型	说明
c	string
o	string
s	string