Skip to content

Commit

Permalink
Added Examples and Updated Comments for SKU and Computer APIs in the …
Browse files Browse the repository at this point in the history
…swagger (#6294)

* Added diffDiskSettings property as part of Swagger changes needed for Ephemeral VM\VMSS

* updated comment

*  updated swagger specs for diffdisksettings property

*  updated swagger spec comments  for diff disk settings [property

* added example to create Diff OS disk scaleset

*  updated 2018-10-01 version specs with diffdisk property

* added example file for creating VM with diffdisksettings property

*  updated swagger changes for reimage operation in single vm

*  update examples

*  udpated examples

*  fixed validation errors

*  updated comments for reimage operation documentation

* Updated examples and documentation for APIs in swagger

*  updated examples as per review comments

*  updated swagger documentation

*  updated swagger documentation with zone details in the sku example

*  updated swagger documentation and reverted the breaking changes

*  updated examples as per swagger model

*  updated swagger to remove the model validation errors for existing examples where we are passing read only parameter in the request
  • Loading branch information
hari-bodicherla authored and praries880 committed Jun 18, 2019
1 parent 60509af commit c7373f4
Show file tree
Hide file tree
Showing 43 changed files with 521 additions and 68 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"api-version": "2017-09-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"resourceType": "virtualMachines",
"locations": [
"westus"
],
"capabilities": [
{
"name": "MaxResourceVolumeMB",
"value": "20480"
},
{
"name": "OSVhdSizeMB",
"value": "1047552"
},
{
"name": "vCPUs",
"value": "1"
},
{
"name": "HyperVGenerations",
"value": "V1"
},
{
"name": "MemoryGB",
"value": "0.75"
},
{
"name": "MaxDataDiskCount",
"value": "1"
},
{
"name": "LowPriorityCapable",
"value": "False"
},
{
"name": "PremiumIO",
"value": "False"
},
{
"name": "vCPUsAvailable",
"value": "1"
},
{
"name": "ACUs",
"value": "50"
},
{
"name": "vCPUsPerCore",
"value": "1"
},
{
"name": "EphemeralOSDiskSupported",
"value": "False"
},
{
"name": "AcceleratedNetworkingEnabled",
"value": "False"
},
{
"name": "RdmaEnabled",
"value": "False"
},
{
"name": "MaxNetworkInterfaces",
"value": "2"
}
],
"locationInfo": [
{
"location": "westus",
"zones": [
"westus-AZ01"
]
}
],
"name": "Standard_A0",
"tier": "Standard",
"size": "A0",
"family": "standardA0_A7Family"
},
{
"resourceType": "virtualMachines",
"locations": [
"westus"
],
"capabilities": [
{
"name": "MaxResourceVolumeMB",
"value": "71680"
},
{
"name": "OSVhdSizeMB",
"value": "1047552"
},
{
"name": "vCPUs",
"value": "1"
},
{
"name": "HyperVGenerations",
"value": "V1"
},
{
"name": "MemoryGB",
"value": "1.75"
},
{
"name": "MaxDataDiskCount",
"value": "2"
},
{
"name": "LowPriorityCapable",
"value": "True"
},
{
"name": "PremiumIO",
"value": "False"
},
{
"name": "vCPUsAvailable",
"value": "1"
},
{
"name": "ACUs",
"value": "100"
},
{
"name": "vCPUsPerCore",
"value": "1"
},
{
"name": "EphemeralOSDiskSupported",
"value": "False"
},
{
"name": "AcceleratedNetworkingEnabled",
"value": "False"
},
{
"name": "RdmaEnabled",
"value": "False"
},
{
"name": "MaxNetworkInterfaces",
"value": "2"
}
],
"locationInfo": [
{
"location": "westus",
"zones": [
"westus-AZ02",
"westus-AZ01"
]
}
],
"name": "Standard_A1",
"tier": "Standard",
"size": "A1",
"family": "standardA0_A7Family"
}
],
"nextLink": null
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"Lists all available Resource SKUs": {
"$ref": "./examples/ListAvailableResourceSkus.json"
}
}
}
}
Expand Down Expand Up @@ -318,13 +323,13 @@
},
"nextLink": {
"type": "string",
"description": "The uri to fetch the next page of Compute Skus. Call ListNext() with this to fetch the next page of VMSS Skus."
"description": "The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus"
}
},
"required": [
"value"
],
"description": "The Compute List Skus operation response."
"description": "The List Resource Skus operation response."
}
},
"parameters": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2238,6 +2238,11 @@
},
"x-ms-pageable": {
"nextLinkName": null
},
"x-ms-examples": {
"Lists all available virtual machine sizes to which the specified virtual machine can be resized": {
"$ref": "./examples/ListAvailableVmSizes_VirtualMachines.json"
}
}
}
},
Expand Down Expand Up @@ -5269,10 +5274,10 @@
"properties": {
"tempDisk": {
"type": "boolean",
"description": "Specifies whether to reimage temp disk. Default value: false."
"description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
}
},
"description": "Parameters for Reimaging Virtual Machine. Default value for OSDisk : true."
"description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged"
},
"VirtualMachineCaptureParameters": {
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@
}
]
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@
}
]
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@
}
]
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@
"availabilitySet": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}"
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"product": "windows-data-science-vm",
"name": "windows2016"
},
"name": "myVM",
"properties": {
"hardwareProfile": {
"vmSize": "Standard_DS1_v2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"product": "windows-data-science-vm",
"name": "windows2016"
},
"name": "myVM",
"properties": {
"hardwareProfile": {
"vmSize": "Standard_D1_v2"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@
"enabled": true
}
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@
}
]
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
}
]
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
}
]
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@
}
]
}
},
"name": "myVM"
}
}
},
"responses": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"vmName": "myVmName",
"api-version": "2018-06-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "Standard_A1_V2",
"numberOfCores": 1,
"osDiskSizeInMB": 1047552,
"resourceDiskSizeInMB": 10240,
"memoryInMB": 2048,
"maxDataDiskCount": 2
},
{
"name": "Standard_A2_V2",
"numberOfCores": 2,
"osDiskSizeInMB": 1047552,
"resourceDiskSizeInMB": 20480,
"memoryInMB": 4096,
"maxDataDiskCount": 4
}
]
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2238,6 +2238,11 @@
},
"x-ms-pageable": {
"nextLinkName": null
},
"x-ms-examples": {
"Lists all available virtual machine sizes to which the specified virtual machine can be resized": {
"$ref": "./examples/ListAvailableVmSizes_VirtualMachines.json"
}
}
}
},
Expand Down Expand Up @@ -5284,7 +5289,7 @@
"properties": {
"tempDisk": {
"type": "boolean",
"description": "Specifies whether to reimage temp disk. Default value: false."
"description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
}
},
"description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged"
Expand Down
Loading

0 comments on commit c7373f4

Please sign in to comment.