Storage Accounts - List Service SAS

Serviço:

Storage Resource Provider

Versão da API:

2023-05-01

Listar credenciais SAS de serviço de um recurso específico.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas. Padrão Regex: ^[a-z0-9]+$
resourceGroupName	path	True	string	O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas. Padrão Regex: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
canonicalizedResource	True	string	O caminho canônico para o recurso assinado.
endPk		string	O fim da chave de partição.
endRk		string	A chave de fim de linha.
keyToSign		string	A chave para assinar o token SAS da conta.
rscc		string	A substituição do cabeçalho de resposta para controle de cache.
rscd		string	A substituição do cabeçalho de resposta para disposição de conteúdo.
rsce		string	A substituição do cabeçalho de resposta para codificação de conteúdo.
rscl		string	A substituição do cabeçalho de resposta para o idioma do conteúdo.
rsct		string	A substituição do cabeçalho de resposta para o tipo de conteúdo.
signedExpiry		string	O momento em que a assinatura de acesso compartilhado se torna inválida.
signedIdentifier		string	Um valor exclusivo de até 64 caracteres que se correlaciona a uma política de acesso especificada para o contêiner, fila ou tabela.
signedIp		string	Um endereço IP ou um intervalo de endereços IP a partir dos quais aceitar pedidos.
signedPermission		Permissions	As permissões assinadas para o serviço SAS. Os valores possíveis incluem: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) e Process (p).
signedProtocol		HttpProtocol	O protocolo permitido para uma solicitação feita com a conta SAS.
signedResource		signedResource	Os serviços assinados acessíveis com o serviço SAS. Os valores possíveis incluem: Blob (b), Container (c), File (f), Share (s).
signedStart		string	O momento em que o SAS se torna válido.
startPk		string	O início da chave de partição.
startRk		string	O início da chave de linha.

Respostas

Name	Tipo	Description
200 OK	ListServiceSasResponse	OK -- retornou a SAS de serviço criada para o serviço de armazenamento solicitado.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

StorageAccountListServiceSAS

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res7439/providers/Microsoft.Storage/storageAccounts/sto1299/ListServiceSas?api-version=2023-05-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-05-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 typing import Any, IO, Union

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-05-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/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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-05-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.Resources;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
HttpProtocol	O protocolo permitido para uma solicitação feita com a conta SAS.
ListServiceSasResponse	A resposta da operação de credenciais SAS do serviço List.
Permissions	As permissões assinadas para a conta SAS. Os valores possíveis incluem: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) e Process (p).
ServiceSasParameters	Os parâmetros para listar credenciais SAS de serviço de um recurso específico.
signedResource	Os serviços assinados acessíveis com o serviço SAS. Os valores possíveis incluem: Blob (b), Container (c), File (f), Share (s).

HttpProtocol

O protocolo permitido para uma solicitação feita com a conta SAS.

Name	Tipo	Description
https	string
https,http	string

ListServiceSasResponse

A resposta da operação de credenciais SAS do serviço List.

Name	Tipo	Description
serviceSasToken	string	Listar credenciais SAS de serviço de recurso específico.

Permissions

As permissões assinadas para a conta SAS. Os valores possíveis incluem: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) e Process (p).

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

ServiceSasParameters

Os parâmetros para listar credenciais SAS de serviço de um recurso específico.

Name	Tipo	Description
canonicalizedResource	string	O caminho canônico para o recurso assinado.
endPk	string	O fim da chave de partição.
endRk	string	A chave de fim de linha.
keyToSign	string	A chave para assinar o token SAS da conta.
rscc	string	A substituição do cabeçalho de resposta para controle de cache.
rscd	string	A substituição do cabeçalho de resposta para disposição de conteúdo.
rsce	string	A substituição do cabeçalho de resposta para codificação de conteúdo.
rscl	string	A substituição do cabeçalho de resposta para o idioma do conteúdo.
rsct	string	A substituição do cabeçalho de resposta para o tipo de conteúdo.
signedExpiry	string	O momento em que a assinatura de acesso compartilhado se torna inválida.
signedIdentifier	string	Um valor exclusivo de até 64 caracteres que se correlaciona a uma política de acesso especificada para o contêiner, fila ou tabela.
signedIp	string	Um endereço IP ou um intervalo de endereços IP a partir dos quais aceitar pedidos.
signedPermission	Permissions	As permissões assinadas para o serviço SAS. Os valores possíveis incluem: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) e Process (p).
signedProtocol	HttpProtocol	O protocolo permitido para uma solicitação feita com a conta SAS.
signedResource	signedResource	Os serviços assinados acessíveis com o serviço SAS. Os valores possíveis incluem: Blob (b), Container (c), File (f), Share (s).
signedStart	string	O momento em que o SAS se torna válido.
startPk	string	O início da chave de partição.
startRk	string	O início da chave de linha.

signedResource

Os serviços assinados acessíveis com o serviço SAS. Os valores possíveis incluem: Blob (b), Container (c), File (f), Share (s).

Name	Tipo	Description
b	string
c	string
f	string
s	string