Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-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-01-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string	O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Regex pattern: ^[-\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 da solicitação

Nome	Obrigató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	O fim da chave de linha.
keyToSign		string	A chave com a qual assinar o token SAS da conta.
rscc		string	A substituição do cabeçalho de resposta para o 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	A hora em que a assinatura de acesso compartilhado se torna inválida.
signedIdentifier		string	Um valor exclusivo até 64 caracteres de comprimento que se relaciona 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 dos quais aceitar solicitações.
signedPermission		Permissions	As permissões assinadas para a SAS de serviço. Os valores possíveis incluem: Leitura (r), Gravação (w), Exclusão (d), Lista (l), Adicionar (a), Criar (c), Atualizar (u) e Processo (p).
signedProtocol		HttpProtocol	O protocolo permitido para uma solicitação feita com a SAS da conta.
signedResource		signedResource	Os serviços assinados acessíveis com a SAS de serviço. Os valores possíveis incluem: Blob (b), Contêiner (c), Arquivo (f), Compartilhamento (s).
signedStart		string	A hora em que a SAS se torna válida.
startPk		string	O início da chave de partição.
startRk		string	O início da chave de linha.

Respostas

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
HttpProtocol	O protocolo permitido para uma solicitação feita com a SAS da conta.
ListServiceSasResponse	A resposta da operação Listar credenciais SAS do serviço.
Permissions	As permissões assinadas para a SAS da conta. Os valores possíveis incluem: Leitura (r), Gravação (w), Exclusão (d), Lista (l), Adicionar (a), Criar (c), Atualizar (u) e Processo (p).
ServiceSasParameters	Os parâmetros para listar as credenciais SAS de serviço de um recurso específico.
signedResource	Os serviços assinados acessíveis com a SAS de serviço. Os valores possíveis incluem: Blob (b), Contêiner (c), Arquivo (f), Compartilhamento (s).

HttpProtocol

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

Nome	Tipo	Description
https	string
https,http	string

ListServiceSasResponse

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

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

Permissions

As permissões assinadas para a SAS da conta. Os valores possíveis incluem: Leitura (r), Gravação (w), Exclusão (d), Lista (l), Adicionar (a), Criar (c), Atualizar (u) e Processo (p).

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

ServiceSasParameters

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

Nome	Tipo	Description
canonicalizedResource	string	O caminho canônico para o recurso assinado.
endPk	string	O fim da chave de partição.
endRk	string	O fim da chave de linha.
keyToSign	string	A chave com a qual assinar o token SAS da conta.
rscc	string	A substituição do cabeçalho de resposta para o 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	A hora em que a assinatura de acesso compartilhado se torna inválida.
signedIdentifier	string	Um valor exclusivo até 64 caracteres de comprimento que se relaciona 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 dos quais aceitar solicitações.
signedPermission	Permissions	As permissões assinadas para a SAS de serviço. Os valores possíveis incluem: Leitura (r), Gravação (w), Exclusão (d), Lista (l), Adicionar (a), Criar (c), Atualizar (u) e Processo (p).
signedProtocol	HttpProtocol	O protocolo permitido para uma solicitação feita com a SAS da conta.
signedResource	signedResource	Os serviços assinados acessíveis com a SAS de serviço. Os valores possíveis incluem: Blob (b), Contêiner (c), Arquivo (f), Compartilhamento (s).
signedStart	string	A hora em que a SAS se torna válida.
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 a SAS de serviço. Os valores possíveis incluem: Blob (b), Contêiner (c), Arquivo (f), Compartilhamento (s).

Nome	Tipo	Description
b	string
c	string
f	string
s	string