Storage Accounts - List Service SAS

Servicio:

Storage Resource Provider

Versión de la API:

2024-01-01

Enumerar las credenciales de SAS de servicio de un recurso específico.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Nombre de la cuenta de almacenamiento dentro del grupo de recursos especificado. Los nombres de cuenta de almacenamiento deben tener entre 3 y 24 caracteres de longitud y usar solo números y letras minúsculas.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nombre del grupo de recursos dentro de la suscripción del usuario. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
canonicalizedResource	True	string	Ruta de acceso canónica al recurso firmado.
endPk		string	Final de la clave de partición.
endRk		string	Final de la clave de fila.
keyToSign		string	Clave para firmar el token de SAS de cuenta con.
rscc		string	Invalidación del encabezado de respuesta para el control de caché.
rscd		string	Invalidación del encabezado de respuesta para eliminación de contenido.
rsce		string	Invalidación del encabezado de respuesta para la codificación de contenido.
rscl		string	Invalidación del encabezado de respuesta para el idioma de contenido.
rsct		string	Invalidación del encabezado de respuesta para el tipo de contenido.
signedExpiry		string (date-time)	Hora en la que la firma de acceso compartido deja de ser válida.
signedIdentifier		string maxLength: 64	Valor único de hasta 64 caracteres de longitud que se correlaciona con una directiva de acceso especificada para el contenedor, la cola o la tabla.
signedIp		string	Una dirección IP o un intervalo de direcciones IP desde las que aceptar solicitudes.
signedPermission		Permissions	Permisos firmados para la SAS del servicio. Los valores posibles son: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) y Process (p).
signedProtocol		HttpProtocol	El protocolo permitido para una solicitud realizada con la SAS de la cuenta.
signedResource		signedResource	Los servicios firmados accesibles con la SAS del servicio. Entre los valores posibles se incluyen: Blob (b), Contenedor (c), Archivo (f), Recurso compartido (s).
signedStart		string (date-time)	Hora a la que la SAS se vuelve válida.
startPk		string	Inicio de la clave de partición.
startRk		string	Inicio de la clave de fila.

Respuestas

Nombre	Tipo	Description
200 OK	ListServiceSasResponse	Correcto: devolvió la SAS de servicio creada para el servicio de almacenamiento solicitado.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

StorageAccountListServiceSAS

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7439/providers/Microsoft.Storage/storageAccounts/sto1299/ListServiceSas?api-version=2024-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/2024-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/2024-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/97ee23a6db6078abcbec7b75bf9af8c503e9bb8b/specification/storage/resource-manager/Microsoft.Storage/stable/2024-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");
require("dotenv/config");

/**
 * 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/2024-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountListServiceSAS.json
// this example is just showing the usage of "StorageAccounts_ListServiceSas" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this StorageAccountResource created on azure
// for more information of creating StorageAccountResource, please refer to the document of StorageAccountResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res7439";
string accountName = "sto1299";
ResourceIdentifier storageAccountResourceId = StorageAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
StorageAccountResource storageAccount = client.GetStorageAccountResource(storageAccountResourceId);

// invoke the operation
ServiceSasContent content = new ServiceSasContent("/blob/sto1299/music")
{
    Resource = ServiceSasSignedResourceType.Container,
    Permissions = StorageAccountSasPermission.L,
    SharedAccessExpiryOn = DateTimeOffset.Parse("2017-05-24T11:32:48.8457197Z"),
};
GetServiceSasResult result = await storageAccount.GetServiceSasAsync(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "serviceSasToken": "sv=2015-04-05&sr=c&se=2017-05-24T11%3A32%3A48Z&sp=l&sig=PoF8yBUGixsjzwroLmw7vG3VbGz4KB2woZC2D4C2oio%3D"
}

Definiciones

Nombre	Description
HttpProtocol	El protocolo permitido para una solicitud realizada con la SAS de la cuenta.
ListServiceSasResponse	Respuesta de la operación de operaciones de credenciales de SAS de list service.
Permissions	Permisos firmados para la SAS de la cuenta. Los valores posibles son: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) y Process (p).
ServiceSasParameters	Parámetros para enumerar las credenciales de SAS de servicio de un recurso específico.
signedResource	Los servicios firmados accesibles con la SAS del servicio. Entre los valores posibles se incluyen: Blob (b), Contenedor (c), Archivo (f), Recurso compartido (s).

HttpProtocol

Enumeración

El protocolo permitido para una solicitud realizada con la SAS de la cuenta.

Valor	Description
https
https,http

ListServiceSasResponse

Object

Respuesta de la operación de operaciones de credenciales de SAS de list service.

Nombre	Tipo	Description
serviceSasToken	string	Enumerar las credenciales de SAS del servicio de recursos específicos.

Permissions

Enumeración

Permisos firmados para la SAS de la cuenta. Los valores posibles son: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) y Process (p).

Valor	Description
a
c
d
l
p
r
u
w

ServiceSasParameters

Object

Parámetros para enumerar las credenciales de SAS de servicio de un recurso específico.

Nombre	Tipo	Description
canonicalizedResource	string	Ruta de acceso canónica al recurso firmado.
endPk	string	Final de la clave de partición.
endRk	string	Final de la clave de fila.
keyToSign	string	Clave para firmar el token de SAS de cuenta con.
rscc	string	Invalidación del encabezado de respuesta para el control de caché.
rscd	string	Invalidación del encabezado de respuesta para eliminación de contenido.
rsce	string	Invalidación del encabezado de respuesta para la codificación de contenido.
rscl	string	Invalidación del encabezado de respuesta para el idioma de contenido.
rsct	string	Invalidación del encabezado de respuesta para el tipo de contenido.
signedExpiry	string (date-time)	Hora en la que la firma de acceso compartido deja de ser válida.
signedIdentifier	string maxLength: 64	Valor único de hasta 64 caracteres de longitud que se correlaciona con una directiva de acceso especificada para el contenedor, la cola o la tabla.
signedIp	string	Una dirección IP o un intervalo de direcciones IP desde las que aceptar solicitudes.
signedPermission	Permissions	Permisos firmados para la SAS del servicio. Los valores posibles son: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) y Process (p).
signedProtocol	HttpProtocol	El protocolo permitido para una solicitud realizada con la SAS de la cuenta.
signedResource	signedResource	Los servicios firmados accesibles con la SAS del servicio. Entre los valores posibles se incluyen: Blob (b), Contenedor (c), Archivo (f), Recurso compartido (s).
signedStart	string (date-time)	Hora a la que la SAS se vuelve válida.
startPk	string	Inicio de la clave de partición.
startRk	string	Inicio de la clave de fila.

signedResource

Enumeración

Los servicios firmados accesibles con la SAS del servicio. Entre los valores posibles se incluyen: Blob (b), Contenedor (c), Archivo (f), Recurso compartido (s).

Valor	Description
b
c
f
s