Storage Accounts - List Account SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Sas-referenties van een opslagaccount weergeven.

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string	De naam van het opslagaccount in de opgegeven resourcegroep. Opslagaccountnamen moeten tussen 3 en 24 tekens lang zijn en mogen alleen getallen en kleine letters bevatten. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	De naam van de resourcegroep in het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
signedExpiry	True	string	Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt.
signedPermission	True	Permissions	De ondertekende machtigingen voor de account-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).
signedResourceTypes	True	SignedResourceTypes	De ondertekende resourcetypen die toegankelijk zijn met de account-SAS. Service(s): toegang tot API's op serviceniveau; Container (c): toegang tot API's op containerniveau; Object (o): toegang tot API's op objectniveau voor blobs, wachtrijberichten, tabelentiteiten en bestanden.
signedServices	True	Services	De ondertekende services die toegankelijk zijn met de account-SAS. Mogelijke waarden zijn: Blob (b), Wachtrij (q), Tabel (t), Bestand (f).
keyToSign		string	De sleutel waarmee het SAS-token van het account moet worden ondertekend.
signedIp		string	Een IP-adres of een reeks IP-adressen van waaruit aanvragen kunnen worden geaccepteerd.
signedProtocol		HttpProtocol	Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.
signedStart		string	Het tijdstip waarop de SAS geldig wordt.

Antwoorden

Name	Type	Description
200 OK	ListAccountSasResponse	OK: de account-SAS die is gemaakt voor het aangevraagde opslagaccount is geretourneerd.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

StorageAccountListAccountSAS

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7985/providers/Microsoft.Storage/storageAccounts/sto8588/ListAccountSas?api-version=2023-01-01

{
  "signedServices": "b",
  "signedResourceTypes": "s",
  "signedPermission": "r",
  "signedProtocol": "https,http",
  "signedStart": "2017-05-24T10:42:03.1567373Z",
  "signedExpiry": "2017-05-24T11:42:03.1567373Z",
  "keyToSign": "key1"
}

Java

import com.azure.resourcemanager.storage.models.AccountSasParameters;
import com.azure.resourcemanager.storage.models.HttpProtocol;
import com.azure.resourcemanager.storage.models.Permissions;
import com.azure.resourcemanager.storage.models.Services;
import com.azure.resourcemanager.storage.models.SignedResourceTypes;
import java.time.OffsetDateTime;

/** Samples for StorageAccounts ListAccountSas. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListAccountSAS.
     * json
     */
    /**
     * Sample code: StorageAccountListAccountSAS.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountListAccountSAS(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().listAccountSasWithResponse("res7985",
            "sto8588",
            new AccountSasParameters().withServices(Services.B).withResourceTypes(SignedResourceTypes.S)
                .withPermissions(Permissions.R).withProtocols(HttpProtocol.HTTPS_HTTP)
                .withSharedAccessStartTime(OffsetDateTime.parse("2017-05-24T10:42:03.1567373Z"))
                .withSharedAccessExpiryTime(OffsetDateTime.parse("2017-05-24T11:42:03.1567373Z"))
                .withKeyToSign("fakeTokenPlaceholder"),
            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_account_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_account_sas(
        resource_group_name="res7985",
        account_name="sto8588",
        parameters={
            "keyToSign": "key1",
            "signedExpiry": "2017-05-24T11:42:03.1567373Z",
            "signedPermission": "r",
            "signedProtocol": "https,http",
            "signedResourceTypes": "s",
            "signedServices": "b",
            "signedStart": "2017-05-24T10:42:03.1567373Z",
        },
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListAccountSAS.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/StorageAccountListAccountSAS.json
func ExampleAccountsClient_ListAccountSAS() {
	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().ListAccountSAS(ctx, "res7985", "sto8588", armstorage.AccountSasParameters{
		KeyToSign:              to.Ptr("key1"),
		SharedAccessExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-24T11:42:03.156Z"); return t }()),
		Permissions:            to.Ptr(armstorage.PermissionsR),
		Protocols:              to.Ptr(armstorage.HTTPProtocolHTTPSHTTP),
		ResourceTypes:          to.Ptr(armstorage.SignedResourceTypesS),
		Services:               to.Ptr(armstorage.ServicesB),
		SharedAccessStartTime:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-24T10:42:03.156Z"); return t }()),
	}, 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.ListAccountSasResponse = armstorage.ListAccountSasResponse{
	// 	AccountSasToken: to.Ptr("sv=2015-04-05&ss=b&srt=s&sp=r&st=2017-05-24T10%3A42%3A03Z&se=2017-05-24T11%3A42%3A03Z&spr=https,http&sig=Z0I%2BEpM%2BPPlTC8ApfUf%2BcffO2aahMgZim3U0iArqsS0%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 SAS credentials of a storage account.
 *
 * @summary List SAS credentials of a storage account.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListAccountSAS.json
 */
async function storageAccountListAccountSas() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res7985";
  const accountName = "sto8588";
  const parameters = {
    keyToSign: "key1",
    sharedAccessExpiryTime: new Date("2017-05-24T11:42:03.1567373Z"),
    permissions: "r",
    protocols: "https,http",
    resourceTypes: "s",
    services: "b",
    sharedAccessStartTime: new Date("2017-05-24T10:42:03.1567373Z"),
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.listAccountSAS(
    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

{
  "accountSasToken": "sv=2015-04-05&ss=b&srt=s&sp=r&st=2017-05-24T10%3A42%3A03Z&se=2017-05-24T11%3A42%3A03Z&spr=https,http&sig=Z0I%2BEpM%2BPPlTC8ApfUf%2BcffO2aahMgZim3U0iArqsS0%3D"
}

Definities

Name	Description
AccountSasParameters	De parameters voor het weergeven van SAS-referenties van een opslagaccount.
HttpProtocol	Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.
ListAccountSasResponse	Het bewerkingsantwoord SAS-referenties vermelden.
Permissions	De ondertekende machtigingen voor de account-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).
Services	De ondertekende services die toegankelijk zijn met de account-SAS. Mogelijke waarden zijn: Blob (b), Wachtrij (q), Tabel (t), Bestand (f).
SignedResourceTypes	De ondertekende resourcetypen die toegankelijk zijn met de account-SAS. Service(s): toegang tot API's op serviceniveau; Container (c): toegang tot API's op containerniveau; Object (o): toegang tot API's op objectniveau voor blobs, wachtrijberichten, tabelentiteiten en bestanden.

AccountSasParameters

De parameters voor het weergeven van SAS-referenties van een opslagaccount.

Name	Type	Description
keyToSign	string	De sleutel waarmee het SAS-token van het account moet worden ondertekend.
signedExpiry	string	Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt.
signedIp	string	Een IP-adres of een reeks IP-adressen van waaruit aanvragen kunnen worden geaccepteerd.
signedPermission	Permissions	De ondertekende machtigingen voor de account-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).
signedProtocol	HttpProtocol	Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.
signedResourceTypes	SignedResourceTypes	De ondertekende resourcetypen die toegankelijk zijn met de account-SAS. Service(s): toegang tot API's op serviceniveau; Container (c): toegang tot API's op containerniveau; Object (o): toegang tot API's op objectniveau voor blobs, wachtrijberichten, tabelentiteiten en bestanden.
signedServices	Services	De ondertekende services die toegankelijk zijn met de account-SAS. Mogelijke waarden zijn: Blob (b), Wachtrij (q), Tabel (t), Bestand (f).
signedStart	string	Het tijdstip waarop de SAS geldig wordt.

HttpProtocol

Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.

Name	Type	Description
https	string
https,http	string

ListAccountSasResponse

Het bewerkingsantwoord SAS-referenties vermelden.

Name	Type	Description
accountSasToken	string	Sas-referenties van het opslagaccount weergeven.

Permissions

De ondertekende machtigingen voor de account-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).

Name	Type	Description
a	string
c	string
d	string
l	string
p	string
r	string
u	string
w	string

Services

De ondertekende services die toegankelijk zijn met de account-SAS. Mogelijke waarden zijn: Blob (b), Wachtrij (q), Tabel (t), Bestand (f).

Name	Type	Description
b	string
f	string
q	string
t	string

SignedResourceTypes

De ondertekende resourcetypen die toegankelijk zijn met de account-SAS. Service(s): toegang tot API's op serviceniveau; Container (c): toegang tot API's op containerniveau; Object (o): toegang tot API's op objectniveau voor blobs, wachtrijberichten, tabelentiteiten en bestanden.

Name	Type	Description
c	string
o	string
s	string