Storage Accounts - List Account SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Répertorier les informations d’identification SAP d’un compte de stockage.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
signedExpiry	True	string	Heure à laquelle la signature d’accès partagé devient non valide.
signedPermission	True	Permissions	Autorisations signées pour la signature d’accès partagé du compte. Les valeurs possibles sont : Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) et Process (p).
signedResourceTypes	True	SignedResourceTypes	Types de ressources signées accessibles avec la sap du compte. Service(s) : accès aux API de niveau de service ; Conteneur (c) : accès aux API au niveau du conteneur ; Objet (o) : accès aux API au niveau de l’objet pour les objets blob, les messages de file d’attente, les entités de table et les fichiers.
signedServices	True	Services	Services signés accessibles avec la sap du compte. Les valeurs possibles sont les suivantes : Blob (b), File d’attente (q), Table (t), Fichier (f).
keyToSign		string	Clé avec laquelle signer le jeton SAP du compte.
signedIp		string	Adresse IP ou plage d’adresses IP à partir de laquelle accepter les demandes.
signedProtocol		HttpProtocol	Protocole autorisé pour une requête effectuée avec la sap du compte.
signedStart		string	Heure à laquelle la sap devient valide.

Réponses

Nom	Type	Description
200 OK	ListAccountSasResponse	OK : a retourné la signature d’accès partagé du compte créée pour le compte de stockage demandé.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
AccountSasParameters	Paramètres permettant de répertorier les informations d’identification SAP d’un compte de stockage.
HttpProtocol	Protocole autorisé pour une requête effectuée avec la sap du compte.
ListAccountSasResponse	Réponse de l’opération Répertorier les informations d’identification SAS.
Permissions	Autorisations signées pour la signature d’accès partagé du compte. Les valeurs possibles sont : Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) et Process (p).
Services	Services signés accessibles avec la sap du compte. Les valeurs possibles sont les suivantes : Blob (b), File d’attente (q), Table (t), Fichier (f).
SignedResourceTypes	Types de ressources signées accessibles avec la sap du compte. Service(s) : accès aux API de niveau de service ; Conteneur (c) : accès aux API au niveau du conteneur ; Objet (o) : accès aux API au niveau de l’objet pour les objets blob, les messages de file d’attente, les entités de table et les fichiers.

AccountSasParameters

Paramètres permettant de répertorier les informations d’identification SAP d’un compte de stockage.

Nom	Type	Description
keyToSign	string	Clé avec laquelle signer le jeton SAP du compte.
signedExpiry	string	Heure à laquelle la signature d’accès partagé devient non valide.
signedIp	string	Adresse IP ou plage d’adresses IP à partir de laquelle accepter les demandes.
signedPermission	Permissions	Autorisations signées pour la signature d’accès partagé du compte. Les valeurs possibles sont : Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) et Process (p).
signedProtocol	HttpProtocol	Protocole autorisé pour une requête effectuée avec la sap du compte.
signedResourceTypes	SignedResourceTypes	Types de ressources signées accessibles avec la sap du compte. Service(s) : accès aux API de niveau de service ; Conteneur (c) : accès aux API au niveau du conteneur ; Objet (o) : accès aux API au niveau de l’objet pour les objets blob, les messages de file d’attente, les entités de table et les fichiers.
signedServices	Services	Services signés accessibles avec la sap du compte. Les valeurs possibles sont les suivantes : Blob (b), File d’attente (q), Table (t), Fichier (f).
signedStart	string	Heure à laquelle la sap devient valide.

HttpProtocol

Protocole autorisé pour une requête effectuée avec la sap du compte.

Nom	Type	Description
https	string
https,http	string

ListAccountSasResponse

Réponse de l’opération Répertorier les informations d’identification SAS.

Nom	Type	Description
accountSasToken	string	Répertoriez les informations d’identification SAP du compte de stockage.

Permissions

Autorisations signées pour la signature d’accès partagé du compte. Les valeurs possibles sont : Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) et Process (p).

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

Services

Services signés accessibles avec la sap du compte. Les valeurs possibles sont les suivantes : Blob (b), File d’attente (q), Table (t), Fichier (f).

Nom	Type	Description
b	string
f	string
q	string
t	string

SignedResourceTypes

Types de ressources signées accessibles avec la sap du compte. Service(s) : accès aux API de niveau de service ; Conteneur (c) : accès aux API au niveau du conteneur ; Objet (o) : accès aux API au niveau de l’objet pour les objets blob, les messages de file d’attente, les entités de table et les fichiers.

Nom	Type	Description
c	string
o	string
s	string