Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Répertorier les informations d’identification SAP du service d’une ressource spécifique.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas?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
canonicalizedResource	True	string	Chemin canonique de la ressource signée.
endPk		string	Fin de la clé de partition.
endRk		string	Fin de la clé de ligne.
keyToSign		string	Clé avec laquelle signer le jeton SAP du compte.
rscc		string	Remplacement de l’en-tête de réponse pour le contrôle du cache.
rscd		string	Remplacement de l’en-tête de réponse pour la suppression du contenu.
rsce		string	Remplacement de l’en-tête de réponse pour l’encodage de contenu.
rscl		string	Remplacement de l’en-tête de réponse pour la langue de contenu.
rsct		string	Remplacement de l’en-tête de réponse pour le type de contenu.
signedExpiry		string	Heure à laquelle la signature d’accès partagé devient non valide.
signedIdentifier		string	Valeur unique composée au plus de 64 caractères, corrélée à une stratégie d'accès spécifiée pour le conteneur, la file d'attente ou la table.
signedIp		string	Adresse IP ou plage d’adresses IP à partir de laquelle accepter les demandes.
signedPermission		Permissions	Autorisations signées pour la SAP de service. 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.
signedResource		signedResource	Services signés accessibles avec la sap de service. Les valeurs possibles sont : Blob (b), Container (c), File (f), Share (s).
signedStart		string	Heure à laquelle la sap devient valide.
startPk		string	Début de la clé de partition.
startRk		string	Début de la clé de ligne.

Réponses

Nom	Type	Description
200 OK	ListServiceSasResponse	OK : a retourné la sap de service créée pour le service 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

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

Définitions

Nom	Description
HttpProtocol	Protocole autorisé pour une requête effectuée avec la sap du compte.
ListServiceSasResponse	Réponse de l’opération d’informations d’identification SAP du service List.
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).
ServiceSasParameters	Paramètres permettant de répertorier les informations d’identification SAP du service d’une ressource spécifique.
signedResource	Services signés accessibles avec la sap de service. Les valeurs possibles sont : Blob (b), Container (c), File (f), Share (s).

HttpProtocol

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

Nom	Type	Description
https	string
https,http	string

ListServiceSasResponse

Réponse de l’opération d’informations d’identification SAP du service List.

Nom	Type	Description
serviceSasToken	string	Répertoriez les informations d’identification SAP du service d’une ressource spécifique.

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

ServiceSasParameters

Paramètres permettant de répertorier les informations d’identification SAP du service d’une ressource spécifique.

Nom	Type	Description
canonicalizedResource	string	Chemin canonique de la ressource signée.
endPk	string	Fin de la clé de partition.
endRk	string	Fin de la clé de ligne.
keyToSign	string	Clé avec laquelle signer le jeton SAP du compte.
rscc	string	Remplacement de l’en-tête de réponse pour le contrôle du cache.
rscd	string	Remplacement de l’en-tête de réponse pour la suppression du contenu.
rsce	string	Remplacement de l’en-tête de réponse pour l’encodage de contenu.
rscl	string	Remplacement de l’en-tête de réponse pour la langue de contenu.
rsct	string	Remplacement de l’en-tête de réponse pour le type de contenu.
signedExpiry	string	Heure à laquelle la signature d’accès partagé devient non valide.
signedIdentifier	string	Valeur unique composée au plus de 64 caractères, corrélée à une stratégie d'accès spécifiée pour le conteneur, la file d'attente ou la table.
signedIp	string	Adresse IP ou plage d’adresses IP à partir de laquelle accepter les demandes.
signedPermission	Permissions	Autorisations signées pour la SAP de service. 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.
signedResource	signedResource	Services signés accessibles avec la sap de service. Les valeurs possibles sont : Blob (b), Container (c), File (f), Share (s).
signedStart	string	Heure à laquelle la sap devient valide.
startPk	string	Début de la clé de partition.
startRk	string	Début de la clé de ligne.

signedResource

Services signés accessibles avec la sap de service. Les valeurs possibles sont : Blob (b), Container (c), File (f), Share (s).

Nom	Type	Description
b	string
c	string
f	string
s	string