Storage Accounts - List Service SAS

服務:

Storage Resource Provider

API 版本:

2023-05-01

列出特定資源的服務 SAS 認證。

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

URI 參數

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

要求本文

名稱	必要	類型	Description
canonicalizedResource	True	string	已簽署資源的正式路徑。
endPk		string	數據分割索引鍵的結尾。
endRk		string	數據列索引鍵的結尾。
keyToSign		string	用來簽署帳戶 SAS 令牌的金鑰。
rscc		string	快取控件的回應標頭覆寫。
rscd		string	內容處置的響應標頭覆寫。
rsce		string	內容編碼的響應標頭覆寫。
rscl		string	內容語言的響應標頭覆寫。
rsct		string	內容類型的響應標頭覆寫。
signedExpiry		string	共用存取簽章失效的時間。
signedIdentifier		string	長度高達 64 個字元的唯一值，與針對容器、佇列或數據表指定的存取原則相互關聯。
signedIp		string	要接受要求的IP位址或IP位址範圍。
signedPermission		Permissions	服務 SAS 的已簽署許可權。 可能的值包括：Read （r）、Write （w）、Delete （d）、List （l）、Add （a）、Create （c）、Update （u） 和 Process （p）。
signedProtocol		HttpProtocol	允許使用帳戶 SAS 提出要求的通訊協定。
signedResource		signedResource	使用服務 SAS 存取的已簽署服務。 可能的值包括：Blob（b）、容器（c）、檔案（f）、共用（s）。
signedStart		string	SAS 生效的時間。
startPk		string	數據分割索引鍵的開頭。
startRk		string	數據列索引鍵的開頭。

回應

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

StorageAccountListServiceSAS

範例要求

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7439/providers/Microsoft.Storage/storageAccounts/sto1299/ListServiceSas?api-version=2023-05-01

{
  "canonicalizedResource": "/blob/sto1299/music",
  "signedResource": "c",
  "signedPermission": "l",
  "signedExpiry": "2017-05-24T11:32:48.8457197Z"
}

Java

import com.azure.resourcemanager.storage.models.Permissions;
import com.azure.resourcemanager.storage.models.ServiceSasParameters;
import com.azure.resourcemanager.storage.models.SignedResource;
import java.time.OffsetDateTime;

/**
 * Samples for StorageAccounts ListServiceSas.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountListServiceSAS.
     * json
     */
    /**
     * Sample code: StorageAccountListServiceSAS.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountListServiceSAS(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().listServiceSasWithResponse("res7439",
            "sto1299",
            new ServiceSasParameters().withCanonicalizedResource("/blob/sto1299/music").withResource(SignedResource.C)
                .withPermissions(Permissions.L).withSharedAccessExpiryTime(
                    OffsetDateTime.parse("2017-05-24T11:32:48.8457197Z")),
            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 typing import Any, IO, Union

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_service_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_service_sas(
        resource_group_name="res7439",
        account_name="sto1299",
        parameters={
            "canonicalizedResource": "/blob/sto1299/music",
            "signedExpiry": "2017-05-24T11:32:48.8457197Z",
            "signedPermission": "l",
            "signedResource": "c",
        },
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountListServiceSAS.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/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountListServiceSAS.json
func ExampleAccountsClient_ListServiceSAS() {
	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().ListServiceSAS(ctx, "res7439", "sto1299", armstorage.ServiceSasParameters{
		CanonicalizedResource:  to.Ptr("/blob/sto1299/music"),
		SharedAccessExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-24T11:32:48.845Z"); return t }()),
		Permissions:            to.Ptr(armstorage.PermissionsL),
		Resource:               to.Ptr(armstorage.SignedResourceC),
	}, 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.ListServiceSasResponse = armstorage.ListServiceSasResponse{
	// 	ServiceSasToken: to.Ptr("sv=2015-04-05&sr=c&se=2017-05-24T11%3A32%3A48Z&sp=l&sig=PoF8yBUGixsjzwroLmw7vG3VbGz4KB2woZC2D4C2oio%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 service SAS credentials of a specific resource.
 *
 * @summary List service SAS credentials of a specific resource.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountListServiceSAS.json
 */
async function storageAccountListServiceSas() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res7439";
  const accountName = "sto1299";
  const parameters = {
    canonicalizedResource: "/blob/sto1299/music",
    sharedAccessExpiryTime: new Date("2017-05-24T11:32:48.8457197Z"),
    permissions: "l",
    resource: "c",
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.listServiceSAS(
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountListServiceSAS.json
// this example is just showing the usage of "StorageAccounts_ListServiceSas" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this StorageAccountResource created on azure
// for more information of creating StorageAccountResource, please refer to the document of StorageAccountResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res7439";
string accountName = "sto1299";
ResourceIdentifier storageAccountResourceId = StorageAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
StorageAccountResource storageAccount = client.GetStorageAccountResource(storageAccountResourceId);

// invoke the operation
ServiceSasContent content = new ServiceSasContent("/blob/sto1299/music")
{
    Resource = ServiceSasSignedResourceType.Container,
    Permissions = StorageAccountSasPermission.L,
    SharedAccessExpiryOn = DateTimeOffset.Parse("2017-05-24T11:32:48.8457197Z"),
};
GetServiceSasResult result = await storageAccount.GetServiceSasAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

範例回覆

狀態碼:

200

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

定義

名稱	Description
HttpProtocol	允許使用帳戶 SAS 提出要求的通訊協定。
ListServiceSasResponse	列出服務 SAS 認證作業回應。
Permissions	帳戶 SAS 的已簽署許可權。 可能的值包括：Read （r）、Write （w）、Delete （d）、List （l）、Add （a）、Create （c）、Update （u） 和 Process （p）。
ServiceSasParameters	列出特定資源之服務 SAS 認證的參數。
signedResource	使用服務 SAS 存取的已簽署服務。 可能的值包括：Blob（b）、容器（c）、檔案（f）、共用（s）。

HttpProtocol

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

名稱	類型	Description
https	string
https,http	string

ListServiceSasResponse

列出服務 SAS 認證作業回應。

名稱	類型	Description
serviceSasToken	string	列出特定資源的服務 SAS 認證。

Permissions

帳戶 SAS 的已簽署許可權。 可能的值包括：Read （r）、Write （w）、Delete （d）、List （l）、Add （a）、Create （c）、Update （u） 和 Process （p）。

名稱	類型	Description
a	string
c	string
d	string
l	string
p	string
r	string
u	string
w	string

ServiceSasParameters

列出特定資源之服務 SAS 認證的參數。

名稱	類型	Description
canonicalizedResource	string	已簽署資源的正式路徑。
endPk	string	數據分割索引鍵的結尾。
endRk	string	數據列索引鍵的結尾。
keyToSign	string	用來簽署帳戶 SAS 令牌的金鑰。
rscc	string	快取控件的回應標頭覆寫。
rscd	string	內容處置的響應標頭覆寫。
rsce	string	內容編碼的響應標頭覆寫。
rscl	string	內容語言的響應標頭覆寫。
rsct	string	內容類型的響應標頭覆寫。
signedExpiry	string	共用存取簽章失效的時間。
signedIdentifier	string	長度高達 64 個字元的唯一值，與針對容器、佇列或數據表指定的存取原則相互關聯。
signedIp	string	要接受要求的IP位址或IP位址範圍。
signedPermission	Permissions	服務 SAS 的已簽署許可權。 可能的值包括：Read （r）、Write （w）、Delete （d）、List （l）、Add （a）、Create （c）、Update （u） 和 Process （p）。
signedProtocol	HttpProtocol	允許使用帳戶 SAS 提出要求的通訊協定。
signedResource	signedResource	使用服務 SAS 存取的已簽署服務。 可能的值包括：Blob（b）、容器（c）、檔案（f）、共用（s）。
signedStart	string	SAS 生效的時間。
startPk	string	數據分割索引鍵的開頭。
startRk	string	數據列索引鍵的開頭。

signedResource

使用服務 SAS 存取的已簽署服務。 可能的值包括：Blob（b）、容器（c）、檔案（f）、共用（s）。

名稱	類型	Description
b	string
c	string
f	string
s	string