Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding new RetrieveBootDiagnosticsData.POST API. VM/VMSS managed boot diagnostics changes with examples. #9460

Merged
merged 12 commits into from
Jun 3, 2020
Merged

Adding new RetrieveBootDiagnosticsData.POST API. VM/VMSS managed boot diagnostics changes with examples. #9460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
da8a011
Preparatory commit for compute 2020-06-01 API version
hyonholee Apr 21, 2020
b31fd02
Adding DisallowedConfiguration property to VirtualMachineImagePropert…
sirajudeens May 11, 2020
ed112b0
managed boot diagnostics changes.
avinashakka09 May 14, 2020
59f4908
Add new lines to the EOF.
avinashakka09 May 14, 2020
43d0e3e
Adding missing response schema.
avinashakka09 May 14, 2020
60ad3dc
Preparatory commit for compute 2020-06-01 API version
hyonholee May 18, 2020
278ddfa
Synced with upstream.
avinashakka09 May 18, 2020
f71f00c
Synced with upstream
avinashakka09 Jun 1, 2020
951ddb4
Adding default error response.
avinashakka09 Jun 1, 2020
b4c403e
Review comments.
avinashakka09 Jun 2, 2020
2dfe015
Merge remote-tracking branch 'upstream/compute-2020-06' into compute-…
avinashakka09 Jun 2, 2020
03afbd8
Remove extra comma
avinashakka09 Jun 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 149 additions & 3 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2659,6 +2659,9 @@
"Create a vm with boot diagnostics.": {
"$ref": "./examples/CreateAVmWithBootDiagnostics.json"
},
"Create a vm with managed boot diagnostics.": {
"$ref": "./examples/CreateAVmWithManagedBootDiagnostics.json"
},
"Create a vm with empty data disks.": {
"$ref": "./examples/CreateAVmWithEmptyDataDisks.json"
},
Expand Down Expand Up @@ -3411,6 +3414,65 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData": {
"post": {
"tags": [
"VirtualMachines"
],
"operationId": "VirtualMachines_RetrieveBootDiagnosticsData",
"description": "The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "vmName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the virtual machine."
},
{
"name": "sasUriExpirationTimeInMinutes",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
avinashakka marked this conversation as resolved.
Show resolved Hide resolved
"description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. <br><br>NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RetrieveBootDiagnosticsDataResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": false,
"x-ms-examples": {
"RetrieveBootDiagnosticsData of a virtual machine.": {
"$ref": "./examples/RetrieveBootDiagnosticsDataVirtualMachine.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": {
"post": {
"tags": [
Expand Down Expand Up @@ -3568,6 +3630,9 @@
"Create a scale set with boot diagnostics.": {
"$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json"
},
"Create a scale set with managed boot diagnostics.": {
"$ref": "./examples/CreateAScaleSetWithManagedBootDiagnostics.json"
},
"Create a scale set with a marketplace image plan.": {
"$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json"
},
Expand Down Expand Up @@ -5955,6 +6020,72 @@
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData": {
"post": {
"tags": [
"VirtualMachineScaleSetVMs"
],
"operationId": "VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData",
"description": "The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "vmScaleSetName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the VM scale set."
},
{
"name": "instanceId",
"in": "path",
"required": true,
"type": "string",
"description": "The instance ID of the virtual machine."
},
{
"name": "sasUriExpirationTimeInMinutes",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. <br><br>NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RetrieveBootDiagnosticsDataResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": false,
"x-ms-examples": {
"RetrieveBootDiagnosticsData of a virtual machine.": {
"$ref": "./examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": {
"post": {
"tags": [
Expand Down Expand Up @@ -6235,6 +6366,21 @@
},
"description": "Specifies the disallowed configuration for a virtual machine image."
},
"RetrieveBootDiagnosticsDataResult": {
avinashakka marked this conversation as resolved.
Show resolved Hide resolved
"properties": {
"consoleScreenshotBlobUri": {
"type": "string",
"readOnly": true,
"description": "The console screenshot blob URI"
},
"serialConsoleLogBlobUri": {
"type": "string",
"readOnly": true,
"description": "The serial console log blob URI."
}
},
"description": "The SAS URIs of the console screenshot and serial log blobs."
},
"HyperVGenerationType": {
"type": "string",
"description": "Specifies the HyperVGeneration Type",
Expand Down Expand Up @@ -8158,7 +8304,7 @@
},
"storageUri": {
"type": "string",
"description": "Uri of the storage account to use for placing the console output and screenshot."
"description": "Uri of the storage account to use for placing the console output and screenshot. <br><br>If storageUri is not specified while enabling boot diagnostics, managed storage will be used."
}
},
"description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor."
Expand Down Expand Up @@ -8275,12 +8421,12 @@
"consoleScreenshotBlobUri": {
"readOnly": true,
"type": "string",
"description": "The console screenshot blob URI."
"description": "The console screenshot blob URI. <br><br>NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage."
},
"serialConsoleLogBlobUri": {
"readOnly": true,
"type": "string",
"description": "The Linux serial console log blob Uri."
"description": "The serial console log blob Uri. <br><br>NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage."
},
"status": {
"readOnly": true,
Expand Down
Loading