Snapshots - Grant Access

Dienst:

Compute

API-Version:

2024-03-02

Gewährt Zugriff auf eine Momentaufnahme.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess?api-version=2024-03-02

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
snapshotName	path	True	string	Der Name der momentaufnahme, die erstellt wird. Der Name kann nicht geändert werden, nachdem die Momentaufnahme erstellt wurde. Unterstützte Zeichen für den Namen sind a-z, A-Z, 0-9, _ und -. Die maximale Länge des Namens beträgt 80 Zeichen.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
access	True	AccessLevel
durationInSeconds	True	integer	Zeitdauer in Sekunden, bis der SAS-Zugriff abläuft.
fileFormat		FileFormat	Wird verwendet, um das Dateiformat beim Anfordern von SAS in einer VHDX-Dateiformatmomentaufnahme anzugeben.
getSecureVMGuestStateSAS		boolean	Legen Sie dieses Kennzeichen auf "true" fest, um zusätzliche SAS für vm-Gaststatus abzurufen.

Antworten

Name	Typ	Beschreibung
200 OK	AccessUri	OKAY
202 Accepted		Angenommen

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a sas on a snapshot.

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot/beginGetAccess?api-version=2024-03-02

{
  "access": "Read",
  "durationInSeconds": 300,
  "fileFormat": "VHDX"
}

Java

import com.azure.resourcemanager.compute.models.AccessLevel;
import com.azure.resourcemanager.compute.models.FileFormat;
import com.azure.resourcemanager.compute.models.GrantAccessData;

/**
 * Samples for Snapshots GrantAccess.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/
     * Snapshot_BeginGetAccess.json
     */
    /**
     * Sample code: Get a sas on a snapshot.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getASasOnASnapshot(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getSnapshots().grantAccess("myResourceGroup", "mySnapshot",
            new GrantAccessData().withAccess(AccessLevel.READ).withDurationInSeconds(300)
                .withFileFormat(FileFormat.VHDX),
            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.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python snapshot_begin_get_access.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 = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.snapshots.begin_grant_access(
        resource_group_name="myResourceGroup",
        snapshot_name="mySnapshot",
        grant_access_data={"access": "Read", "durationInSeconds": 300, "fileFormat": "VHDX"},
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_BeginGetAccess.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 armcompute_test

import (
	"context"
	"log"

	"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/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d6d0798c6f5eb196fba7bd1924db2b145a94f58c/specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json
func ExampleSnapshotsClient_BeginGrantAccess() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSnapshotsClient().BeginGrantAccess(ctx, "myResourceGroup", "mySnapshot", armcompute.GrantAccessData{
		Access:            to.Ptr(armcompute.AccessLevelRead),
		DurationInSeconds: to.Ptr[int32](300),
		FileFormat:        to.Ptr(armcompute.FileFormatVHDX),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.AccessURI = armcompute.AccessURI{
	// 	AccessSAS: to.Ptr("https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r"),
	// }
}

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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Grants access to a snapshot.
 *
 * @summary Grants access to a snapshot.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json
 */
async function getASasOnASnapshot() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const snapshotName = "mySnapshot";
  const grantAccessData = {
    access: "Read",
    durationInSeconds: 300,
    fileFormat: "VHDX",
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.snapshots.beginGrantAccessAndWait(
    resourceGroupName,
    snapshotName,
    grantAccessData,
  );
  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.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/DiskRP/stable/2024-03-02/examples/snapshotExamples/Snapshot_BeginGetAccess.json
// this example is just showing the usage of "Snapshots_GrantAccess" 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 SnapshotResource created on azure
// for more information of creating SnapshotResource, please refer to the document of SnapshotResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string snapshotName = "mySnapshot";
ResourceIdentifier snapshotResourceId = SnapshotResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, snapshotName);
SnapshotResource snapshot = client.GetSnapshotResource(snapshotResourceId);

// invoke the operation
GrantAccessData data = new GrantAccessData(AccessLevel.Read, 300)
{
    FileFormat = DiskImageFileFormat.Vhdx,
};
ArmOperation<AccessUri> lro = await snapshot.GrantAccessAsync(WaitUntil.Completed, data);
AccessUri result = lro.Value;

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

Beispiel für eine Antwort

Statuscode:

200

{
  "accessSAS": "https://md-gpvmcxzlzxgd.partition.blob.storage.azure.net/xx3cqcx53f0v/abcd?sv=2014-02-14&sr=b&sk=key1&sig=XXX&st=2021-05-24T18:02:34Z&se=2021-05-24T18:19:14Z&sp=r"
}

Statuscode:

202

Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/operations/{operationId}&monitor=true&api-version=2024-03-02

Definitionen

Name	Beschreibung
AccessLevel
AccessUri	Ein SAS-URI für den Datenträgerzugriff.
FileFormat	Wird verwendet, um das Dateiformat beim Anfordern von SAS in einer VHDX-Dateiformatmomentaufnahme anzugeben.
GrantAccessData	Daten, die zum Anfordern einer SAS verwendet werden.

AccessLevel

Name	Typ	Beschreibung
None	string
Read	string
Write	string

AccessUri

Ein SAS-URI für den Datenträgerzugriff.

Name	Typ	Beschreibung
accessSAS	string	Ein SAS-URI für den Zugriff auf einen Datenträger.
securityDataAccessSAS	string	Ein SAS-URI für den Zugriff auf einen VM-Gaststatus.

FileFormat

Wird verwendet, um das Dateiformat beim Anfordern von SAS in einer VHDX-Dateiformatmomentaufnahme anzugeben.

Name	Typ	Beschreibung
VHD	string	Eine VHD-Datei ist eine Datenträgerimagedatei im Dateiformat der virtuellen Festplatte.
VHDX	string	Eine VHDX-Datei ist eine Datenträgerimagedatei im Dateiformat virtual Hard Disk v2.

GrantAccessData

Daten, die zum Anfordern einer SAS verwendet werden.

Name	Typ	Beschreibung
access	AccessLevel
durationInSeconds	integer	Zeitdauer in Sekunden, bis der SAS-Zugriff abläuft.
fileFormat	FileFormat	Wird verwendet, um das Dateiformat beim Anfordern von SAS in einer VHDX-Dateiformatmomentaufnahme anzugeben.
getSecureVMGuestStateSAS	boolean	Legen Sie dieses Kennzeichen auf "true" fest, um zusätzliche SAS für vm-Gaststatus abzurufen.