Storage Accounts - List Service SAS

サービス:

Storage Resource Provider

API バージョン:

2024-01-01

特定のリソースのサービス SAS 資格情報を一覧表示します。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	ユーザーのサブスクリプション内のリソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
canonicalizedResource	True	string	署名されたリソースへの正規パス。
endPk		string	パーティション キーの末尾。
endRk		string	行キーの末尾。
keyToSign		string	アカウント SAS トークンに署名するキー。
rscc		string	キャッシュ制御の応答ヘッダーのオーバーライド。
rscd		string	コンテンツの処理に対する応答ヘッダーのオーバーライド。
rsce		string	コンテンツ エンコードの応答ヘッダーのオーバーライド。
rscl		string	コンテンツ言語の応答ヘッダーのオーバーライド。
rsct		string	コンテンツ タイプの応答ヘッダーのオーバーライド。
signedExpiry		string (date-time)	Shared Access Signature が無効になる時刻。
signedIdentifier		string maxLength: 64	コンテナー、キュー、またはテーブルに指定されたアクセス ポリシーに関連付けられる最大 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)、Container (c)、File (f)、Share (s) です。
signedStart		string (date-time)	SAS が有効になる時刻。
startPk		string	パーティション キーの開始。
startRk		string	行キーの先頭。

応答

名前	型	説明
200 OK	ListServiceSasResponse	OK -- 要求されたストレージ サービス用に作成されたサービス SAS が返されました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

StorageAccountListServiceSAS

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7439/providers/Microsoft.Storage/storageAccounts/sto1299/ListServiceSas?api-version=2024-01-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/2024-01-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 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/2024-01-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/97ee23a6db6078abcbec7b75bf9af8c503e9bb8b/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-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");
require("dotenv/config");

/**
 * 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/2024-01-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.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-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"
}

定義

名前	説明
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)、Container (c)、File (f)、Share (s) です。

HttpProtocol

列挙

アカウント SAS で行われた要求に対して許可されるプロトコル。

値	説明
https
https,http

ListServiceSasResponse

Object

サービス SAS 資格情報の一覧表示操作の応答。

名前	型	説明
serviceSasToken	string	特定のリソースのサービス SAS 資格情報を一覧表示します。

Permissions

列挙

アカウント SAS の署名済みアクセス許可。 指定できる値は、Read (r)、Write (w)、Delete (d)、List (l)、Add (a)、Create (c)、Update (u)、Process (p) です。

値	説明
a
c
d
l
p
r
u
w

ServiceSasParameters

Object

特定のリソースのサービス SAS 資格情報を一覧表示するパラメーター。

名前	型	説明
canonicalizedResource	string	署名されたリソースへの正規パス。
endPk	string	パーティション キーの末尾。
endRk	string	行キーの末尾。
keyToSign	string	アカウント SAS トークンに署名するキー。
rscc	string	キャッシュ制御の応答ヘッダーのオーバーライド。
rscd	string	コンテンツの処理に対する応答ヘッダーのオーバーライド。
rsce	string	コンテンツ エンコードの応答ヘッダーのオーバーライド。
rscl	string	コンテンツ言語の応答ヘッダーのオーバーライド。
rsct	string	コンテンツ タイプの応答ヘッダーのオーバーライド。
signedExpiry	string (date-time)	Shared Access Signature が無効になる時刻。
signedIdentifier	string maxLength: 64	コンテナー、キュー、またはテーブルに指定されたアクセス ポリシーに関連付けられる最大 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)、Container (c)、File (f)、Share (s) です。
signedStart	string (date-time)	SAS が有効になる時刻。
startPk	string	パーティション キーの開始。
startRk	string	行キーの先頭。

signedResource

列挙

サービス SAS でアクセス可能な署名付きサービス。 使用できる値は、Blob (b)、Container (c)、File (f)、Share (s) です。

値	説明
b
c
f
s