POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/beginGetAccess/?api-version=2023-10-02

Grants access to a disk.

Servers

Path parameters

Name Type Required Description
diskName String Yes

The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.

subscriptionId String Yes

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName String Yes

The name of the resource group.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
fileFormat String No

Used to specify the file format when making request for SAS on a VHDX file format snapshot

Possible values:

  • "VHD"
  • "VHDX"
durationInSeconds Integer Yes

Time duration in seconds until the SAS access expires.

getSecureVMGuestStateSAS Boolean No

Set this flag to true to get additional SAS for VM guest state

access String Yes

Possible values:

  • "Write"
  • "None"
  • "Read"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.