From be88f66cc94c0572a1f025443c0409d1a4ee46e4 Mon Sep 17 00:00:00 2001 From: robhat1 Date: Fri, 21 Sep 2018 08:56:17 -0700 Subject: [PATCH] Updated comments and introduced AvailabilitySetSkuType to help users use predefined constants (#3971) --- .../stable/2018-06-01/compute.json | 84 +++++++++++-------- 1 file changed, 48 insertions(+), 36 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index a58e696a1d5b..028fff2d752b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -1437,7 +1437,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via":"location" + "final-state-via": "location" } } }, @@ -4130,7 +4130,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via":"azure-async-operation" + "final-state-via": "azure-async-operation" } } }, @@ -4184,7 +4184,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via":"azure-async-operation" + "final-state-via": "azure-async-operation" } } } @@ -4312,6 +4312,18 @@ }, "description": "The instance view of a resource." }, + "AvailabilitySetSkuType": { + "type": "string", + "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.", + "enum": [ + "Classic", + "Aligned" + ], + "x-ms-enum": { + "name": "AvailabilitySetSkuTypes", + "modelAsString": true + } + }, "AvailabilitySet": { "properties": { "properties": { @@ -4320,7 +4332,7 @@ }, "sku": { "$ref": "#/definitions/Sku", - "description": "Sku of the availability set" + "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." } }, "allOf": [ @@ -5164,7 +5176,7 @@ }, "StorageAccountType": { "type": "string", - "description": "Specifies the storage account type for the managed disk. UltraSSD_LRS can only be used for data disks.", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.", "enum": [ "Standard_LRS", "Premium_LRS", @@ -5180,7 +5192,7 @@ "properties": { "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. UltraSSD_LRS can only be used for data disks." + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." } }, "allOf": [ @@ -5315,13 +5327,13 @@ "description": "Specifies the storage settings for the virtual machine disks." }, "AdditionalCapabilities": { - "properties": { - "ultraSSDEnabled": { - "type": "boolean", - "description": "Enables or disables a capability to have 1 or more managed data disks with UltraSSD_LRS storage account on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." - } - }, - "description": "Enables or disables a capability on the virtual machine or virtual machine scale set" + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." }, "AdditionalUnattendContent": { "properties": { @@ -5840,10 +5852,10 @@ "$ref": "#/definitions/StorageProfile", "description": "Specifies the storage settings for the virtual machine disks." }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the virtual machine. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." - }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + }, "osProfile": { "$ref": "#/definitions/OSProfile", "description": "Specifies the operating system settings for the virtual machine." @@ -6112,7 +6124,7 @@ }, "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + "description": "Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS Disk." } }, "required": [ @@ -6160,7 +6172,7 @@ }, "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." } }, "required": [ @@ -6183,7 +6195,7 @@ }, "zoneResilient": { "type": "boolean", - "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." } }, "description": "Describes a storage profile." @@ -6365,7 +6377,7 @@ "properties": { "storageAccountType": { "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." } }, "description": "Describes the parameters of a ScaleSet managed disk." @@ -6890,8 +6902,8 @@ }, "description": "The list of IP tags associated with the public IP address." }, - "publicIPPrefix" : { - "$ref":"#/definitions/SubResource", + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", "description": "The PublicIPPrefix from which to allocate publicIP addresses." } }, @@ -7036,10 +7048,10 @@ "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", "description": "Specifies the storage settings for the virtual machine disks." }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." - }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, "networkProfile": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." @@ -7445,20 +7457,20 @@ "description": "The Virtual Machine Scale Set List Skus operation response." }, "RollbackStatusInfo": { - "properties":{ - "successfullyRolledbackInstanceCount" : { + "properties": { + "successfullyRolledbackInstanceCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "The number of instances which have been successfully rolled back." }, - "failedRolledbackInstanceCount" : { + "failedRolledbackInstanceCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "The number of instances which failed to rollback." }, - "rollbackError" : { + "rollbackError": { "$ref": "#/definitions/ApiError", "readOnly": true, "description": "Error details if OS rollback failed." @@ -7606,10 +7618,10 @@ "$ref": "#/definitions/StorageProfile", "description": "Specifies the storage settings for the virtual machine disks." }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." - }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, "osProfile": { "$ref": "#/definitions/OSProfile", "description": "Specifies the operating system settings for the virtual machine." @@ -8133,4 +8145,4 @@ "description": "Client Api Version." } } -} +} \ No newline at end of file