Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Auflisten der SAS-Anmeldeinformationen einer bestimmten Ressource.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Speicherkontos innerhalb der angegebenen Ressourcengruppe. Speicherkontonamen müssen zwischen 3 und 24 Zeichen lang sein und dürfen nur Zahlen und Kleinbuchstaben enthalten. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Der Name der Ressourcengruppe im Abonnement des Benutzers. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
canonicalizedResource	True	string	Der kanonische Pfad zur signierten Ressource.
endPk		string	Das Ende des Partitionsschlüssels.
endRk		string	Das Ende der Zeilentaste.
keyToSign		string	Der Schlüssel, mit dem das SAS-Kontotoken signiert werden soll.
rscc		string	Die Antwortheaderüberschreibung für die Cachesteuerung.
rscd		string	Der Antwortheader überschreibt die Inhaltsdisposition.
rsce		string	Der Antwortheader überschreibt die Inhaltscodierung.
rscl		string	Die Antwortheaderüberschreibung für die Inhaltssprache.
rsct		string	Die Antwortheaderüberschreibung für den Inhaltstyp.
signedExpiry		string	Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird.
signedIdentifier		string	Ein eindeutiger, maximal 64 Zeichen langer Wert, der mit einer Zugriffsrichtlinie korreliert, die für den Container, die Warteschlange oder die Tabelle angegeben wurde.
signedIp		string	Eine IP-Adresse oder ein IP-Adressbereich, aus dem Anforderungen akzeptiert werden sollen.
signedPermission		Permissions	Die signierten Berechtigungen für die Dienst-SAS. Mögliche Werte sind: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) und Process (p).
signedProtocol		HttpProtocol	Das Protokoll, das für eine Anforderung zulässig ist, die mit der Konto-SAS durchgeführt wird.
signedResource		signedResource	Die signierten Dienste, auf die mit der Dienst-SAS zugegriffen werden kann. Mögliche Werte sind: Blob (b), Container (c), File (f), Share (s).
signedStart		string	Der Zeitpunkt, zu dem die SAS gültig wird.
startPk		string	Der Anfang des Partitionsschlüssels.
startRk		string	Der Anfang der Zeilentaste.

Antworten

Name	Typ	Beschreibung
200 OK	ListServiceSasResponse	OK: Die Dienst-SAS, die für den angeforderten Speicherdienst erstellt wurde, wurde zurückgegeben.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
HttpProtocol	Das Protokoll, das für eine Anforderung zulässig ist, die mit der Konto-SAS durchgeführt wird.
ListServiceSasResponse	Die Antwort des Vorgangs Auflisten von SAS-Anmeldeinformationen für den Dienst.
Permissions	Die signierten Berechtigungen für die Konto-SAS. Mögliche Werte sind: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) und Process (p).
ServiceSasParameters	Die Parameter zum Auflisten von Dienst-SAS-Anmeldeinformationen einer bestimmten Ressource.
signedResource	Die signierten Dienste, auf die mit der Dienst-SAS zugegriffen werden kann. Mögliche Werte sind: Blob (b), Container (c), File (f), Share (s).

HttpProtocol

Das Protokoll, das für eine Anforderung zulässig ist, die mit der Konto-SAS durchgeführt wird.

Name	Typ	Beschreibung
https	string
https,http	string

ListServiceSasResponse

Die Antwort des Vorgangs Auflisten von SAS-Anmeldeinformationen für den Dienst.

Name	Typ	Beschreibung
serviceSasToken	string	Auflisten der SAS-Anmeldeinformationen für den Dienst einer bestimmten Ressource.

Permissions

Die signierten Berechtigungen für die Konto-SAS. Mögliche Werte sind: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) und Process (p).

Name	Typ	Beschreibung
a	string
c	string
d	string
l	string
p	string
r	string
u	string
w	string

ServiceSasParameters

Die Parameter zum Auflisten von Dienst-SAS-Anmeldeinformationen einer bestimmten Ressource.

Name	Typ	Beschreibung
canonicalizedResource	string	Der kanonische Pfad zur signierten Ressource.
endPk	string	Das Ende des Partitionsschlüssels.
endRk	string	Das Ende der Zeilentaste.
keyToSign	string	Der Schlüssel, mit dem das SAS-Kontotoken signiert werden soll.
rscc	string	Die Antwortheaderüberschreibung für die Cachesteuerung.
rscd	string	Der Antwortheader überschreibt die Inhaltsdisposition.
rsce	string	Der Antwortheader überschreibt die Inhaltscodierung.
rscl	string	Die Antwortheaderüberschreibung für die Inhaltssprache.
rsct	string	Die Antwortheaderüberschreibung für den Inhaltstyp.
signedExpiry	string	Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird.
signedIdentifier	string	Ein eindeutiger, maximal 64 Zeichen langer Wert, der mit einer Zugriffsrichtlinie korreliert, die für den Container, die Warteschlange oder die Tabelle angegeben wurde.
signedIp	string	Eine IP-Adresse oder ein IP-Adressbereich, aus dem Anforderungen akzeptiert werden sollen.
signedPermission	Permissions	Die signierten Berechtigungen für die Dienst-SAS. Mögliche Werte sind: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) und Process (p).
signedProtocol	HttpProtocol	Das Protokoll, das für eine Anforderung zulässig ist, die mit der Konto-SAS durchgeführt wird.
signedResource	signedResource	Die signierten Dienste, auf die mit der Dienst-SAS zugegriffen werden kann. Mögliche Werte sind: Blob (b), Container (c), File (f), Share (s).
signedStart	string	Der Zeitpunkt, zu dem die SAS gültig wird.
startPk	string	Der Anfang des Partitionsschlüssels.
startRk	string	Der Anfang der Zeilentaste.

signedResource

Die signierten Dienste, auf die mit der Dienst-SAS zugegriffen werden kann. Mögliche Werte sind: Blob (b), Container (c), File (f), Share (s).

Name	Typ	Beschreibung
b	string
c	string
f	string
s	string