Skip to content

Commit f412dbd

Browse files
avinashakkahyonholeesirajudeensavinashakka09
authored
Adding new RetrieveBootDiagnosticsData.POST API. VM/VMSS managed boot diagnostics changes with examples. (#9460)
* Preparatory commit for compute 2020-06-01 API version * Adding DisallowedConfiguration property to VirtualMachineImageProperties (#9065) * managed boot diagnostics changes. * Add new lines to the EOF. * Adding missing response schema. * Preparatory commit for compute 2020-06-01 API version * Adding default error response. * Review comments. * Remove extra comma Co-authored-by: Hyonho Lee <[email protected]> Co-authored-by: Sirajudeen Sahul Hameed <[email protected]> Co-authored-by: Avinash Akka <[email protected]>
1 parent ecbd428 commit f412dbd

File tree

5 files changed

+582
-3
lines changed

5 files changed

+582
-3
lines changed

‎specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json‎

Lines changed: 149 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2659,6 +2659,9 @@
26592659
"Create a vm with boot diagnostics.": {
26602660
"$ref": "./examples/CreateAVmWithBootDiagnostics.json"
26612661
},
2662+
"Create a vm with managed boot diagnostics.": {
2663+
"$ref": "./examples/CreateAVmWithManagedBootDiagnostics.json"
2664+
},
26622665
"Create a vm with empty data disks.": {
26632666
"$ref": "./examples/CreateAVmWithEmptyDataDisks.json"
26642667
},
@@ -3411,6 +3414,65 @@
34113414
}
34123415
}
34133416
},
3417+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData": {
3418+
"post": {
3419+
"tags": [
3420+
"VirtualMachines"
3421+
],
3422+
"operationId": "VirtualMachines_RetrieveBootDiagnosticsData",
3423+
"description": "The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.",
3424+
"parameters": [
3425+
{
3426+
"name": "resourceGroupName",
3427+
"in": "path",
3428+
"required": true,
3429+
"type": "string",
3430+
"description": "The name of the resource group."
3431+
},
3432+
{
3433+
"name": "vmName",
3434+
"in": "path",
3435+
"required": true,
3436+
"type": "string",
3437+
"description": "The name of the virtual machine."
3438+
},
3439+
{
3440+
"name": "sasUriExpirationTimeInMinutes",
3441+
"in": "query",
3442+
"required": false,
3443+
"type": "integer",
3444+
"format": "int32",
3445+
"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."
3446+
},
3447+
{
3448+
"$ref": "#/parameters/ApiVersionParameter"
3449+
},
3450+
{
3451+
"$ref": "#/parameters/SubscriptionIdParameter"
3452+
}
3453+
],
3454+
"responses": {
3455+
"200": {
3456+
"description": "OK",
3457+
"schema": {
3458+
"$ref": "#/definitions/RetrieveBootDiagnosticsDataResult"
3459+
}
3460+
},
3461+
"default": {
3462+
"description": "Error response describing why the operation failed.",
3463+
"schema": {
3464+
"$ref": "#/definitions/CloudError"
3465+
}
3466+
}
3467+
},
3468+
"x-ms-long-running-operation": false,
3469+
"x-ms-examples": {
3470+
"RetrieveBootDiagnosticsData of a virtual machine.": {
3471+
"$ref": "./examples/RetrieveBootDiagnosticsDataVirtualMachine.json"
3472+
}
3473+
}
3474+
}
3475+
},
34143476
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": {
34153477
"post": {
34163478
"tags": [
@@ -3568,6 +3630,9 @@
35683630
"Create a scale set with boot diagnostics.": {
35693631
"$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json"
35703632
},
3633+
"Create a scale set with managed boot diagnostics.": {
3634+
"$ref": "./examples/CreateAScaleSetWithManagedBootDiagnostics.json"
3635+
},
35713636
"Create a scale set with a marketplace image plan.": {
35723637
"$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json"
35733638
},
@@ -5955,6 +6020,72 @@
59556020
"x-ms-long-running-operation": true
59566021
}
59576022
},
6023+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData": {
6024+
"post": {
6025+
"tags": [
6026+
"VirtualMachineScaleSetVMs"
6027+
],
6028+
"operationId": "VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData",
6029+
"description": "The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.",
6030+
"parameters": [
6031+
{
6032+
"name": "resourceGroupName",
6033+
"in": "path",
6034+
"required": true,
6035+
"type": "string",
6036+
"description": "The name of the resource group."
6037+
},
6038+
{
6039+
"name": "vmScaleSetName",
6040+
"in": "path",
6041+
"required": true,
6042+
"type": "string",
6043+
"description": "The name of the VM scale set."
6044+
},
6045+
{
6046+
"name": "instanceId",
6047+
"in": "path",
6048+
"required": true,
6049+
"type": "string",
6050+
"description": "The instance ID of the virtual machine."
6051+
},
6052+
{
6053+
"name": "sasUriExpirationTimeInMinutes",
6054+
"in": "query",
6055+
"required": false,
6056+
"type": "integer",
6057+
"format": "int32",
6058+
"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."
6059+
},
6060+
{
6061+
"$ref": "#/parameters/ApiVersionParameter"
6062+
},
6063+
{
6064+
"$ref": "#/parameters/SubscriptionIdParameter"
6065+
}
6066+
],
6067+
"responses": {
6068+
"200": {
6069+
"description": "OK",
6070+
"schema": {
6071+
"$ref": "#/definitions/RetrieveBootDiagnosticsDataResult"
6072+
}
6073+
},
6074+
"default": {
6075+
"description": "Error response describing why the operation failed.",
6076+
"schema": {
6077+
"$ref": "#/definitions/CloudError"
6078+
}
6079+
}
6080+
},
6081+
"x-ms-long-running-operation": false,
6082+
"x-ms-examples": {
6083+
"RetrieveBootDiagnosticsData of a virtual machine.": {
6084+
"$ref": "./examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json"
6085+
}
6086+
}
6087+
}
6088+
},
59586089
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": {
59596090
"post": {
59606091
"tags": [
@@ -6235,6 +6366,21 @@
62356366
},
62366367
"description": "Specifies the disallowed configuration for a virtual machine image."
62376368
},
6369+
"RetrieveBootDiagnosticsDataResult": {
6370+
"properties": {
6371+
"consoleScreenshotBlobUri": {
6372+
"type": "string",
6373+
"readOnly": true,
6374+
"description": "The console screenshot blob URI"
6375+
},
6376+
"serialConsoleLogBlobUri": {
6377+
"type": "string",
6378+
"readOnly": true,
6379+
"description": "The serial console log blob URI."
6380+
}
6381+
},
6382+
"description": "The SAS URIs of the console screenshot and serial log blobs."
6383+
},
62386384
"HyperVGenerationType": {
62396385
"type": "string",
62406386
"description": "Specifies the HyperVGeneration Type",
@@ -8158,7 +8304,7 @@
81588304
},
81598305
"storageUri": {
81608306
"type": "string",
8161-
"description": "Uri of the storage account to use for placing the console output and screenshot."
8307+
"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."
81628308
}
81638309
},
81648310
"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."
@@ -8275,12 +8421,12 @@
82758421
"consoleScreenshotBlobUri": {
82768422
"readOnly": true,
82778423
"type": "string",
8278-
"description": "The console screenshot blob URI."
8424+
"description": "The console screenshot blob URI. <br><br>NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage."
82798425
},
82808426
"serialConsoleLogBlobUri": {
82818427
"readOnly": true,
82828428
"type": "string",
8283-
"description": "The Linux serial console log blob Uri."
8429+
"description": "The serial console log blob Uri. <br><br>NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage."
82848430
},
82858431
"status": {
82868432
"readOnly": true,

0 commit comments

Comments
 (0)