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

Updated comments and introduced AvailabilitySetSkuType … #3971

Merged
merged 1 commit into from
Sep 21, 2018
Merged

Updated comments and introduced AvailabilitySetSkuType … #3971

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 48 additions & 36 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1437,7 +1437,7 @@
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via":"location"
"final-state-via": "location"
}
}
},
Expand Down Expand Up @@ -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"
}
}
},
Expand Down Expand Up @@ -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"
}
}
}
Expand Down Expand Up @@ -4312,6 +4312,18 @@
},
"description": "The instance view of a resource."
},
"AvailabilitySetSkuType": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this referenced anywhere, is that expected?

Copy link
Contributor Author

@robhat1 robhat1 Sep 20, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the main idea is to provide a set of constants to the users to specify possible values for skuName while creating Availability Set.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately we had used the same SKU object at different places and it does not mean the same when used in context of an AvailabilitySet as compared to VMScaleSet or in GetSKUs APIs. Hence this is just to help customers to tell them what are the possible values when creating an Availability Set.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So these values go in the Sku.Name field? I don't think adding a new type that isn't referenced is the best way to solve this, isn't updating the description sufficient?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No it is not. We don't want users to guess the values and type anything random in there. Do you any side-effect of having it? It seems more helpful than just have comments.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I should have rephrased that, since this type isn't referenced the code generators throw it away. If you look at some of the generated PRs you'll see that AvailabilitySetSkuType isn't added to the models. So since you can't update the models the best you can do is update the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had checked the generated C# code. It shows up as a static class with 2 string variables there.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, it doesn't appear for other languages. @fearthecowboy can you comment on this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ugh nevermind I was looking at the wrong SDK PR.

"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": {
Expand All @@ -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": [
Expand Down Expand Up @@ -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",
Expand All @@ -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": [
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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."
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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": [
Expand All @@ -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."
Expand Down Expand Up @@ -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."
Expand Down Expand Up @@ -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."
}
},
Expand Down Expand Up @@ -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."
Expand Down Expand Up @@ -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."
Expand Down Expand Up @@ -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."
Expand Down Expand Up @@ -8133,4 +8145,4 @@
"description": "Client Api Version."
}
}
}
}