Virtual Machines - Retrieve Boot Diagnostics Data

The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData?api-version=2024-07-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData?sasUriExpirationTimeInMinutes={sasUriExpirationTimeInMinutes}&api-version=2024-07-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

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

vmName
path True

string

The name of the virtual machine.

api-version
query True

string

Client Api Version.

sasUriExpirationTimeInMinutes
query

integer

int32

Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. Note: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes.

Responses

Name Type Description
200 OK

RetrieveBootDiagnosticsDataResult

OK

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

RetrieveBootDiagnosticsData of a virtual machine.

Sample request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ResourceGroup/providers/Microsoft.Compute/virtualMachines/VMName/retrieveBootDiagnosticsData?sasUriExpirationTimeInMinutes=60&api-version=2024-07-01

Sample response

{
  "consoleScreenshotBlobUri": "https://storageuri/vm.screenshot.bmp?{sasKey}",
  "serialConsoleLogBlobUri": "https://storageuri/vm.serialconsole.log?{sasKey}"
}

Definitions

Name Description
ApiError

Api error.

ApiErrorBase

Api error base.

CloudError

An error response from the Compute service.

InnerError

Inner error details.

RetrieveBootDiagnosticsDataResult

The SAS URIs of the console screenshot and serial log blobs.

ApiError

Api error.

Name Type Description
code

string

The error code.

details

ApiErrorBase[]

The Api error details

innererror

InnerError

The Api inner error

message

string

The error message.

target

string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code

string

The error code.

message

string

The error message.

target

string

The target of the particular error.

CloudError

An error response from the Compute service.

Name Type Description
error

ApiError

Api error.

InnerError

Inner error details.

Name Type Description
errordetail

string

The internal error message or exception dump.

exceptiontype

string

The exception type.

RetrieveBootDiagnosticsDataResult

The SAS URIs of the console screenshot and serial log blobs.

Name Type Description
consoleScreenshotBlobUri

string

The console screenshot blob URI

serialConsoleLogBlobUri

string

The serial console log blob URI.