Storage Accounts - List Service SAS

Service:

Storage Resource Provider

API Version:

2023-01-01

Service-SAS-referenties van een specifieke resource weergeven.

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string	De naam van het opslagaccount in de opgegeven resourcegroep. Opslagaccountnamen moeten tussen 3 en 24 tekens lang zijn en mogen alleen getallen en kleine letters bevatten. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	De naam van de resourcegroep in het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
canonicalizedResource	True	string	Het canonieke pad naar de ondertekende resource.
endPk		string	Het einde van de partitiesleutel.
endRk		string	Het einde van de rijtoets.
keyToSign		string	De sleutel waarmee het SAS-token van het account moet worden ondertekend.
rscc		string	De reactieheader overschrijven voor cachebeheer.
rscd		string	De reactieheader overschrijft voor het verwijderen van inhoud.
rsce		string	De overschrijving van de antwoordheader voor inhoudscodering.
rscl		string	De overschrijving van de antwoordheader voor de inhoudstaal.
rsct		string	De overschrijving van de antwoordheader voor het inhoudstype.
signedExpiry		string	Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt.
signedIdentifier		string	Een unieke waarde van maximaal 64 tekens die overeenkomt met een toegangsbeleid dat is opgegeven voor de container, wachtrij of tabel.
signedIp		string	Een IP-adres of een reeks IP-adressen van waaruit aanvragen kunnen worden geaccepteerd.
signedPermission		Permissions	De ondertekende machtigingen voor de service-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).
signedProtocol		HttpProtocol	Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.
signedResource		signedResource	De ondertekende services die toegankelijk zijn met de service-SAS. Mogelijke waarden zijn: Blob (b), Container (c), Bestand (f), Share (s).
signedStart		string	Het tijdstip waarop de SAS geldig wordt.
startPk		string	Het begin van de partitiesleutel.
startRk		string	Het begin van de rijtoets.

Antwoorden

Name	Type	Description
200 OK	ListServiceSasResponse	OK:- de service-SAS geretourneerd die is gemaakt voor de aangevraagde opslagservice.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name	Description
HttpProtocol	Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.
ListServiceSasResponse	Het bewerkingsantwoord van de LIST-service SAS-referenties.
Permissions	De ondertekende machtigingen voor de account-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).
ServiceSasParameters	De parameters voor het weergeven van service-SAS-referenties van een specifieke resource.
signedResource	De ondertekende services die toegankelijk zijn met de service-SAS. Mogelijke waarden zijn: Blob (b), Container (c), Bestand (f), Share (s).

HttpProtocol

Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.

Name	Type	Description
https	string
https,http	string

ListServiceSasResponse

Het bewerkingsantwoord van de LIST-service SAS-referenties.

Name	Type	Description
serviceSasToken	string	Service-SAS-referenties van specifieke resource weergeven.

Permissions

De ondertekende machtigingen voor de account-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).

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

ServiceSasParameters

De parameters voor het weergeven van service-SAS-referenties van een specifieke resource.

Name	Type	Description
canonicalizedResource	string	Het canonieke pad naar de ondertekende resource.
endPk	string	Het einde van de partitiesleutel.
endRk	string	Het einde van de rijtoets.
keyToSign	string	De sleutel waarmee het SAS-token van het account moet worden ondertekend.
rscc	string	De reactieheader overschrijven voor cachebeheer.
rscd	string	De reactieheader overschrijft voor het verwijderen van inhoud.
rsce	string	De overschrijving van de antwoordheader voor inhoudscodering.
rscl	string	De overschrijving van de antwoordheader voor de inhoudstaal.
rsct	string	De overschrijving van de antwoordheader voor het inhoudstype.
signedExpiry	string	Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt.
signedIdentifier	string	Een unieke waarde van maximaal 64 tekens die overeenkomt met een toegangsbeleid dat is opgegeven voor de container, wachtrij of tabel.
signedIp	string	Een IP-adres of een reeks IP-adressen van waaruit aanvragen kunnen worden geaccepteerd.
signedPermission	Permissions	De ondertekende machtigingen voor de service-SAS. Mogelijke waarden zijn: Lezen (r), Schrijven (w), Verwijderen (d), Lijst (l), Toevoegen (a), Maken (c), Bijwerken (u) en Proces (p).
signedProtocol	HttpProtocol	Het protocol dat is toegestaan voor een aanvraag die is gedaan met de account-SAS.
signedResource	signedResource	De ondertekende services die toegankelijk zijn met de service-SAS. Mogelijke waarden zijn: Blob (b), Container (c), Bestand (f), Share (s).
signedStart	string	Het tijdstip waarop de SAS geldig wordt.
startPk	string	Het begin van de partitiesleutel.
startRk	string	Het begin van de rijtoets.

signedResource

De ondertekende services die toegankelijk zijn met de service-SAS. Mogelijke waarden zijn: Blob (b), Container (c), Bestand (f), Share (s).

Name	Type	Description
b	string
c	string
f	string
s	string