Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Mencantumkan kredensial SAS layanan dari sumber daya tertentu.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun penyimpanan dalam grup sumber daya yang ditentukan. Nama akun penyimpanan harus sepanjang antara 3 dan 24 karakter dan hanya menggunakan angka dan huruf kecil. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan pengguna. Nama tidak peka huruf besar/kecil. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
canonicalizedResource	True	string	Jalur kanonis ke sumber daya yang ditandatangani.
endPk		string	Akhir kunci partisi.
endRk		string	Akhir kunci baris.
keyToSign		string	Kunci untuk menandatangani token SAS akun.
rscc		string	Header respons mengambil alih kontrol cache.
rscd		string	Header respons mengambil alih disposisi konten.
rsce		string	Header respons mengambil alih pengodean konten.
rscl		string	Header respons mengambil alih bahasa konten.
rsct		string	Header respons mengambil alih jenis konten.
signedExpiry		string	Waktu tanda tangan akses bersama menjadi tidak valid.
signedIdentifier		string	Panjang nilai unik hingga 64 karakter yang berkorelasi dengan kebijakan akses yang ditentukan untuk kontainer, antrean, atau tabel.
signedIp		string	Alamat IP atau rentang alamat IP tempat menerima permintaan.
signedPermission		Permissions	Izin yang ditandatangani untuk layanan SAS. Nilai yang mungkin termasuk: Baca (r), Tulis (w), Hapus (d), Daftar (l), Tambahkan (a), Buat (c), Perbarui (u) dan Proses (p).
signedProtocol		HttpProtocol	Protokol yang diizinkan untuk permintaan yang dibuat dengan akun SAS.
signedResource		signedResource	Layanan yang ditandatangani dapat diakses dengan layanan SAS. Nilai yang mungkin termasuk: Blob (b), Kontainer (c), File (f), Berbagi (s).
signedStart		string	Waktu di mana SAS menjadi valid.
startPk		string	Awal kunci partisi.
startRk		string	Awal kunci baris.

Respons

Nama	Jenis	Deskripsi
200 OK	ListServiceSasResponse	OK -- mengembalikan layanan SAS yang dibuat untuk layanan penyimpanan yang diminta.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

StorageAccountListServiceSAS

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7439/providers/Microsoft.Storage/storageAccounts/sto1299/ListServiceSas?api-version=2023-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/2023-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/2023-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/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-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");

/**
 * 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-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

Sample Response

Status code:

200

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

Definisi

Nama	Deskripsi
HttpProtocol	Protokol yang diizinkan untuk permintaan yang dibuat dengan akun SAS.
ListServiceSasResponse	Respons operasi kredensial SAS layanan Daftar.
Permissions	Izin yang ditandatangani untuk akun SAS. Nilai yang mungkin termasuk: Baca (r), Tulis (w), Hapus (d), Daftar (l), Tambahkan (a), Buat (c), Perbarui (u) dan Proses (p).
ServiceSasParameters	Parameter untuk mencantumkan kredensial SAS layanan dari sumber daya tertentu.
signedResource	Layanan yang ditandatangani dapat diakses dengan layanan SAS. Nilai yang mungkin termasuk: Blob (b), Kontainer (c), File (f), Berbagi (s).

HttpProtocol

Protokol yang diizinkan untuk permintaan yang dibuat dengan akun SAS.

Nama	Jenis	Deskripsi
https	string
https,http	string

ListServiceSasResponse

Respons operasi kredensial SAS layanan Daftar.

Nama	Jenis	Deskripsi
serviceSasToken	string	Mencantumkan kredensial SAS layanan dari sumber daya tertentu.

Permissions

Izin yang ditandatangani untuk akun SAS. Nilai yang mungkin termasuk: Baca (r), Tulis (w), Hapus (d), Daftar (l), Tambahkan (a), Buat (c), Perbarui (u) dan Proses (p).

Nama	Jenis	Deskripsi
a	string
c	string
d	string
l	string
p	string
r	string
u	string
w	string

ServiceSasParameters

Parameter untuk mencantumkan kredensial SAS layanan dari sumber daya tertentu.

Nama	Jenis	Deskripsi
canonicalizedResource	string	Jalur kanonis ke sumber daya yang ditandatangani.
endPk	string	Akhir kunci partisi.
endRk	string	Akhir kunci baris.
keyToSign	string	Kunci untuk menandatangani token SAS akun.
rscc	string	Header respons mengambil alih kontrol cache.
rscd	string	Header respons mengambil alih disposisi konten.
rsce	string	Header respons mengambil alih pengodean konten.
rscl	string	Header respons mengambil alih bahasa konten.
rsct	string	Header respons mengambil alih jenis konten.
signedExpiry	string	Waktu tanda tangan akses bersama menjadi tidak valid.
signedIdentifier	string	Panjang nilai unik hingga 64 karakter yang berkorelasi dengan kebijakan akses yang ditentukan untuk kontainer, antrean, atau tabel.
signedIp	string	Alamat IP atau rentang alamat IP tempat menerima permintaan.
signedPermission	Permissions	Izin yang ditandatangani untuk layanan SAS. Nilai yang mungkin termasuk: Baca (r), Tulis (w), Hapus (d), Daftar (l), Tambahkan (a), Buat (c), Perbarui (u) dan Proses (p).
signedProtocol	HttpProtocol	Protokol yang diizinkan untuk permintaan yang dibuat dengan akun SAS.
signedResource	signedResource	Layanan yang ditandatangani dapat diakses dengan layanan SAS. Nilai yang mungkin termasuk: Blob (b), Kontainer (c), File (f), Berbagi (s).
signedStart	string	Waktu di mana SAS menjadi valid.
startPk	string	Awal kunci partisi.
startRk	string	Awal kunci baris.

signedResource

Layanan yang ditandatangani dapat diakses dengan layanan SAS. Nilai yang mungkin termasuk: Blob (b), Kontainer (c), File (f), Berbagi (s).

Nama	Jenis	Deskripsi
b	string
c	string
f	string
s	string