Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Вывод списка учетных данных SAS службы для определенного ресурса.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string	Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
canonicalizedResource	True	string	Канонический путь к подписанному ресурсу.
endPk		string	Конец ключа секции.
endRk		string	Конец ключа строки.
keyToSign		string	Ключ для подписи маркера SAS учетной записи.
rscc		string	Переопределение заголовка ответа для элемента управления кэшем.
rscd		string	Переопределение заголовка ответа для ликвидации содержимого.
rsce		string	Переопределение заголовка ответа для кодирования содержимого.
rscl		string	Переопределение заголовка ответа для языка содержимого.
rsct		string	Переопределение заголовка ответа для типа контента.
signedExpiry		string	Время, когда подписанный URL-адрес становится недействительным.
signedIdentifier		string	Уникальное значение длиной до 64 символов, которое связано с политикой доступа, заданной для контейнера, очереди или таблицы.
signedIp		string	IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы.
signedPermission		Permissions	Подписанные разрешения для SAS службы. Возможные значения: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) и Process (p).
signedProtocol		HttpProtocol	Протокол, разрешенный для запроса, выполненного с помощью SAS учетной записи.
signedResource		signedResource	Подписанные службы, доступные с помощью SAS службы. Возможные значения: Blob (b), Container (c), File (f), Share (s).
signedStart		string	Время, когда SAS становится действительным.
startPk		string	Начало ключа секции.
startRk		string	Начало ключа строки.

Ответы

Имя	Тип	Описание
200 OK	ListServiceSasResponse	ОК — вернул sas службы, созданный для запрошенной службы хранилища.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
HttpProtocol	Протокол, разрешенный для запроса, выполненного с помощью SAS учетной записи.
ListServiceSasResponse	Ответ операции с учетными данными SAS службы list.
Permissions	Подписанные разрешения для SAS учетной записи. Возможные значения: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) и Process (p).
ServiceSasParameters	Параметры для перечисления учетных данных SAS службы для определенного ресурса.
signedResource	Подписанные службы, доступные с помощью SAS службы. Возможные значения: Blob (b), Container (c), File (f), Share (s).

HttpProtocol

Протокол, разрешенный для запроса, выполненного с помощью SAS учетной записи.

Имя	Тип	Описание
https	string
https,http	string

ListServiceSasResponse

Ответ операции с учетными данными SAS службы list.

Имя	Тип	Описание
serviceSasToken	string	Вывод списка учетных данных SAS службы для определенного ресурса.

Permissions

Подписанные разрешения для SAS учетной записи. Возможные значения: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) и Process (p).

Имя	Тип	Описание
a	string
c	string
d	string
l	string
p	string
r	string
u	string
w	string

ServiceSasParameters

Параметры для перечисления учетных данных SAS службы для определенного ресурса.

Имя	Тип	Описание
canonicalizedResource	string	Канонический путь к подписанному ресурсу.
endPk	string	Конец ключа секции.
endRk	string	Конец ключа строки.
keyToSign	string	Ключ для подписи маркера SAS учетной записи.
rscc	string	Переопределение заголовка ответа для элемента управления кэшем.
rscd	string	Переопределение заголовка ответа для ликвидации содержимого.
rsce	string	Переопределение заголовка ответа для кодирования содержимого.
rscl	string	Переопределение заголовка ответа для языка содержимого.
rsct	string	Переопределение заголовка ответа для типа контента.
signedExpiry	string	Время, когда подписанный URL-адрес становится недействительным.
signedIdentifier	string	Уникальное значение длиной до 64 символов, которое связано с политикой доступа, заданной для контейнера, очереди или таблицы.
signedIp	string	IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы.
signedPermission	Permissions	Подписанные разрешения для SAS службы. Возможные значения: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) и Process (p).
signedProtocol	HttpProtocol	Протокол, разрешенный для запроса, выполненного с помощью SAS учетной записи.
signedResource	signedResource	Подписанные службы, доступные с помощью SAS службы. Возможные значения: Blob (b), Container (c), File (f), Share (s).
signedStart	string	Время, когда SAS становится действительным.
startPk	string	Начало ключа секции.
startRk	string	Начало ключа строки.

signedResource

Подписанные службы, доступные с помощью SAS службы. Возможные значения: Blob (b), Container (c), File (f), Share (s).

Имя	Тип	Описание
b	string
c	string
f	string
s	string