Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Wyświetl listę poświadczeń sygnatury dostępu współdzielonego usługi dla określonego zasobu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string	Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
canonicalizedResource	True	string	Ścieżka kanoniczna do podpisanego zasobu.
endPk		string	Koniec klucza partycji.
endRk		string	Koniec klucza wiersza.
keyToSign		string	Klucz do podpisania tokenu SAS konta za pomocą polecenia .
rscc		string	Nagłówek odpowiedzi zastępuje kontrolkę pamięci podręcznej.
rscd		string	Nagłówek odpowiedzi zastępuje dyspozycję zawartości.
rsce		string	Nagłówek odpowiedzi zastępuje kodowanie zawartości.
rscl		string	Nagłówek odpowiedzi zastępuje język zawartości.
rsct		string	Nagłówek odpowiedzi zastępuje typ zawartości.
signedExpiry		string	Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa.
signedIdentifier		string	Unikatowa wartość o długości do 64 znaków, która jest skorelowana z zasadami dostępu określonymi dla kontenera, kolejki lub tabeli.
signedIp		string	Adres IP lub zakres adresów IP, z których mają być akceptowane żądania.
signedPermission		Permissions	Podpisane uprawnienia sygnatury dostępu współdzielonego usługi. Możliwe wartości to: Odczyt (r), Zapis (w), Usuwanie (d), Lista (l), Dodawanie (a), Tworzenie (c), Aktualizacja (u) i Proces (p).
signedProtocol		HttpProtocol	Protokół dozwolony dla żądania złożonego z sygnaturą dostępu współdzielonego konta.
signedResource		signedResource	Podpisane usługi dostępne za pomocą sygnatury dostępu współdzielonego usługi. Możliwe wartości to: Blob (b), Container (c), File (f), Share (s).
signedStart		string	Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa.
startPk		string	Początek klucza partycji.
startRk		string	Początek klucza wiersza.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ListServiceSasResponse	OK — zwrócił sygnaturę dostępu współdzielonego usługi utworzoną dla żądanej usługi magazynu.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
HttpProtocol	Protokół dozwolony dla żądania złożonego z sygnaturą dostępu współdzielonego konta.
ListServiceSasResponse	Odpowiedź na operację Wyświetlanie poświadczeń sygnatury dostępu współdzielonego usługi.
Permissions	Podpisane uprawnienia dla sygnatury dostępu współdzielonego konta. Możliwe wartości to: Odczyt (r), Zapis (w), Usuwanie (d), Lista (l), Dodawanie (a), Tworzenie (c), Aktualizacja (u) i Proces (p).
ServiceSasParameters	Parametry umożliwiające wyświetlenie listy poświadczeń sygnatury dostępu współdzielonego usługi dla określonego zasobu.
signedResource	Podpisane usługi dostępne za pomocą sygnatury dostępu współdzielonego usługi. Możliwe wartości to: Blob (b), Container (c), File (f), Share (s).

HttpProtocol

Protokół dozwolony dla żądania złożonego z sygnaturą dostępu współdzielonego konta.

Nazwa	Typ	Opis
https	string
https,http	string

ListServiceSasResponse

Odpowiedź na operację Wyświetlanie poświadczeń sygnatury dostępu współdzielonego usługi.

Nazwa	Typ	Opis
serviceSasToken	string	Wyświetl listę poświadczeń sygnatury dostępu współdzielonego usługi dla określonego zasobu.

Permissions

Podpisane uprawnienia dla sygnatury dostępu współdzielonego konta. Możliwe wartości to: Odczyt (r), Zapis (w), Usuwanie (d), Lista (l), Dodawanie (a), Tworzenie (c), Aktualizacja (u) i Proces (p).

Nazwa	Typ	Opis
a	string
c	string
d	string
l	string
p	string
r	string
u	string
w	string

ServiceSasParameters

Parametry umożliwiające wyświetlenie listy poświadczeń sygnatury dostępu współdzielonego usługi dla określonego zasobu.

Nazwa	Typ	Opis
canonicalizedResource	string	Ścieżka kanoniczna do podpisanego zasobu.
endPk	string	Koniec klucza partycji.
endRk	string	Koniec klucza wiersza.
keyToSign	string	Klucz do podpisania tokenu SAS konta za pomocą polecenia .
rscc	string	Nagłówek odpowiedzi zastępuje kontrolkę pamięci podręcznej.
rscd	string	Nagłówek odpowiedzi zastępuje dyspozycję zawartości.
rsce	string	Nagłówek odpowiedzi zastępuje kodowanie zawartości.
rscl	string	Nagłówek odpowiedzi zastępuje język zawartości.
rsct	string	Nagłówek odpowiedzi zastępuje typ zawartości.
signedExpiry	string	Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa.
signedIdentifier	string	Unikatowa wartość o długości do 64 znaków, która jest skorelowana z zasadami dostępu określonymi dla kontenera, kolejki lub tabeli.
signedIp	string	Adres IP lub zakres adresów IP, z których mają być akceptowane żądania.
signedPermission	Permissions	Podpisane uprawnienia sygnatury dostępu współdzielonego usługi. Możliwe wartości to: Odczyt (r), Zapis (w), Usuwanie (d), Lista (l), Dodawanie (a), Tworzenie (c), Aktualizacja (u) i Proces (p).
signedProtocol	HttpProtocol	Protokół dozwolony dla żądania złożonego z sygnaturą dostępu współdzielonego konta.
signedResource	signedResource	Podpisane usługi dostępne za pomocą sygnatury dostępu współdzielonego usługi. Możliwe wartości to: Blob (b), Container (c), File (f), Share (s).
signedStart	string	Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa.
startPk	string	Początek klucza partycji.
startRk	string	Początek klucza wiersza.

signedResource

Podpisane usługi dostępne za pomocą sygnatury dostępu współdzielonego usługi. Możliwe wartości to: Blob (b), Container (c), File (f), Share (s).

Nazwa	Typ	Opis
b	string
c	string
f	string
s	string