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 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	指定資源群組內的記憶體帳戶名稱。儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。名稱不區分大小寫。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
signedExpiry	True	string	共用存取簽章變成無效的時間。
signedPermission	True	Permissions	帳戶 SAS 的已簽署許可權。可能的值為：讀取 (r) 、寫入 (w) 、刪除 (d) 、List (l) 、新增 () 、建立 (c) 、Update (u) 和 Process (p) 。
signedResourceTypes	True	SignedResourceTypes	帳戶 SAS 可存取的已簽署資源類型。服務 (s) ：存取服務層級 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 生效的時間。

回應

名稱	類型	Description
200 OK	ListAccountSasResponse	確定 -- 傳回為要求的記憶體帳戶所建立的帳戶 SAS。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

StorageAccountListAccountSAS

Sample Request

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


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

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

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

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

定義

名稱	Description
AccountSasParameters	要列出記憶體帳戶 SAS 認證的參數。
HttpProtocol	允許使用帳戶 SAS 提出要求的通訊協定。
ListAccountSasResponse	列出 SAS 認證作業回應。
Permissions	帳戶 SAS 的已簽署許可權。可能的值為：讀取 (r) 、寫入 (w) 、刪除 (d) 、List (l) 、新增 () 、建立 (c) 、Update (u) 和 Process (p) 。
Services	可透過帳戶 SAS 存取的已簽署服務。可能的值為：Blob (b) 、Queue (q) 、Table (t) 、File (f) 。
SignedResourceTypes	帳戶 SAS 可存取的已簽署資源類型。服務 (s) ：存取服務層級 API;容器 (c) ：容器層級 API 的存取權;物件 (o) ：存取 Blob、佇列訊息、數據表實體和檔案的物件層級 API。

AccountSasParameters

要列出記憶體帳戶 SAS 認證的參數。

名稱	類型	Description
keyToSign	string	用來簽署帳戶 SAS 令牌的金鑰。
signedExpiry	string	共用存取簽章變成無效的時間。
signedIp	string	要接受要求的IP位址或IP位址範圍。
signedPermission	Permissions	帳戶 SAS 的已簽署許可權。可能的值為：讀取 (r) 、寫入 (w) 、刪除 (d) 、List (l) 、新增 () 、建立 (c) 、Update (u) 和 Process (p) 。
signedProtocol	HttpProtocol	允許使用帳戶 SAS 提出要求的通訊協定。
signedResourceTypes	SignedResourceTypes	帳戶 SAS 可存取的已簽署資源類型。服務 (s) ：存取服務層級 API;容器 (c) ：容器層級 API 的存取權;物件 (o) ：存取 Blob、佇列訊息、數據表實體和檔案的物件層級 API。
signedServices	Services	可透過帳戶 SAS 存取的已簽署服務。可能的值為：Blob (b) 、Queue (q) 、Table (t) 、File (f) 。
signedStart	string	SAS 生效的時間。

HttpProtocol

允許使用帳戶 SAS 提出要求的通訊協定。

名稱	類型	Description
https	string
https,http	string

ListAccountSasResponse

列出 SAS 認證作業回應。

名稱	類型	Description
accountSasToken	string	列出記憶體帳戶的 SAS 認證。

Permissions

帳戶 SAS 的已簽署許可權。可能的值為：讀取 (r) 、寫入 (w) 、刪除 (d) 、List (l) 、新增 () 、建立 (c) 、Update (u) 和 Process (p) 。

名稱	類型	Description
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) 。

名稱	類型	Description
b	string
f	string
q	string
t	string

SignedResourceTypes

帳戶 SAS 可存取的已簽署資源類型。服務 (s) ：存取服務層級 API;容器 (c) ：容器層級 API 的存取權;物件 (o) ：存取 Blob、佇列訊息、數據表實體和檔案的物件層級 API。

名稱	類型	Description
c	string
o	string
s	string

Storage Accounts - List Account SAS

URI 參數

要求本文

回應

安全性

azure_auth

Scopes

範例

StorageAccountListAccountSAS

Sample Request

Sample Response

定義

AccountSasParameters

HttpProtocol

ListAccountSasResponse

Permissions

Services

SignedResourceTypes

其他資源