Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Výpis přihlašovacích údajů SAS služby pro konkrétní prostředek

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string	Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
canonicalizedResource	True	string	Kanonická cesta k podepsanému prostředku.
endPk		string	Konec klíče oddílu.
endRk		string	Konec klíče řádku.
keyToSign		string	Klíč pro podepsání tokenu SAS účtu.
rscc		string	Přepsání hlavičky odpovědi pro řízení mezipaměti.
rscd		string	Hlavička odpovědi přepisuje dispozice obsahu.
rsce		string	Přepsání hlavičky odpovědi pro kódování obsahu
rscl		string	Hlavička odpovědi přepisuje jazyk obsahu.
rsct		string	Přepsání hlavičky odpovědi pro typ obsahu.
signedExpiry		string	Čas, kdy se sdílený přístupový podpis stane neplatným.
signedIdentifier		string	Jedinečná hodnota o délce maximálně 64 znaků, která koreluje se zásadami přístupu zadanou pro kontejner, frontu nebo tabulku.
signedIp		string	IP adresa nebo rozsah IP adres, ze kterých chcete přijímat požadavky.
signedPermission		Permissions	Podepsaná oprávnění pro SAS služby. Mezi možné hodnoty patří: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
signedProtocol		HttpProtocol	Protokol povolený pro žádost provedenou se SAS účtu.
signedResource		signedResource	Podepsané služby přístupné pomocí sdíleného přístupového podpisu služby. Mezi možné hodnoty patří: Objekt blob (b), Kontejner (c), Soubor (f), Sdílená složka (s).
signedStart		string	Čas, kdy sdílený přístupový podpis začne platit.
startPk		string	Začátek klíče oddílu.
startRk		string	Začátek řádku.

Odpovědi

Name	Typ	Description
200 OK	ListServiceSasResponse	OK – vrátil SAS služby vytvořené pro požadovanou službu úložiště.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
HttpProtocol	Protokol povolený pro žádost provedenou se SAS účtu.
ListServiceSasResponse	Odpověď operace Výpis přihlašovacích údajů SAS služby
Permissions	Podepsaná oprávnění pro SAS účtu. Mezi možné hodnoty patří: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
ServiceSasParameters	Parametry pro výpis přihlašovacích údajů SAS služby pro konkrétní prostředek.
signedResource	Podepsané služby přístupné pomocí sdíleného přístupového podpisu služby. Mezi možné hodnoty patří: Objekt blob (b), Kontejner (c), Soubor (f), Sdílená složka (s).

HttpProtocol

Protokol povolený pro žádost provedenou se SAS účtu.

Name	Typ	Description
https	string
https,http	string

ListServiceSasResponse

Odpověď operace Výpis přihlašovacích údajů SAS služby

Name	Typ	Description
serviceSasToken	string	Uveďte přihlašovací údaje SAS služby pro konkrétní prostředek.

Permissions

Podepsaná oprávnění pro SAS účtu. Mezi možné hodnoty patří: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).

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

ServiceSasParameters

Parametry pro výpis přihlašovacích údajů SAS služby pro konkrétní prostředek.

Name	Typ	Description
canonicalizedResource	string	Kanonická cesta k podepsanému prostředku.
endPk	string	Konec klíče oddílu.
endRk	string	Konec klíče řádku.
keyToSign	string	Klíč pro podepsání tokenu SAS účtu.
rscc	string	Přepsání hlavičky odpovědi pro řízení mezipaměti.
rscd	string	Hlavička odpovědi přepisuje dispozice obsahu.
rsce	string	Přepsání hlavičky odpovědi pro kódování obsahu
rscl	string	Hlavička odpovědi přepisuje jazyk obsahu.
rsct	string	Přepsání hlavičky odpovědi pro typ obsahu.
signedExpiry	string	Čas, kdy se sdílený přístupový podpis stane neplatným.
signedIdentifier	string	Jedinečná hodnota o délce maximálně 64 znaků, která koreluje se zásadami přístupu zadanou pro kontejner, frontu nebo tabulku.
signedIp	string	IP adresa nebo rozsah IP adres, ze kterých chcete přijímat požadavky.
signedPermission	Permissions	Podepsaná oprávnění pro SAS služby. Mezi možné hodnoty patří: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
signedProtocol	HttpProtocol	Protokol povolený pro žádost provedenou se SAS účtu.
signedResource	signedResource	Podepsané služby přístupné pomocí sdíleného přístupového podpisu služby. Mezi možné hodnoty patří: Objekt blob (b), Kontejner (c), Soubor (f), Sdílená složka (s).
signedStart	string	Čas, kdy sdílený přístupový podpis začne platit.
startPk	string	Začátek klíče oddílu.
startRk	string	Začátek řádku.

signedResource

Podepsané služby přístupné pomocí sdíleného přístupového podpisu služby. Mezi možné hodnoty patří: Objekt blob (b), Kontejner (c), Soubor (f), Sdílená složka (s).

Name	Typ	Description
b	string
c	string
f	string
s	string