Skip to content

Commit

Permalink
Swagger changes for PremiumV2 in DiskRP (#18786)
Browse files Browse the repository at this point in the history
* Swagger changes for PremiumV2 in DiskRP

* Added new property copyCompletionError

* Updated description for new property copyCompletionError

* Added the type as object for CopyCompletionError

* Addressed comment to update the description for CopySourceNotFound

Co-authored-by: akashpargat <akashpargat@microsoft.com>
  • Loading branch information
akashpargat and akashpargat authored Apr 29, 2022
1 parent 3ccee3b commit ad5a64a
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@
"Create a managed disk with ssd zrs account type.": {
"$ref": "./examples/diskExamples/Disk_Create_WithSSDZRSAccountType.json"
},
"Create a managed disk with premium v2 account type.": {
"$ref": "./examples/diskExamples/Disk_Create_WithPremiumV2_LRSAccountType.json"
},
"Create a managed disk with security profile": {
"$ref": "./examples/diskExamples/Disk_Create_WithSecurityProfile.json"
},
Expand Down Expand Up @@ -532,7 +535,8 @@
"StandardSSD_LRS",
"UltraSSD_LRS",
"Premium_ZRS",
"StandardSSD_ZRS"
"StandardSSD_ZRS",
"PremiumV2_LRS"
],
"x-ms-enum": {
"name": "DiskStorageAccountTypes",
Expand Down Expand Up @@ -561,6 +565,10 @@
{
"value": "StandardSSD_ZRS",
"description": "Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures."
},
{
"value": "PremiumV2_LRS",
"description": "Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput."
}
]
},
Expand All @@ -572,7 +580,7 @@
"description": "The sku tier."
}
},
"description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, or StandardSSD_ZRS."
"description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS."
},
"DiskProperties": {
"properties": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,37 @@
],
"description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace."
},
"CopyCompletionError": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "Indicates the error code if the background copy of a resource created via the CopyStart operation fails.",
"enum": [
"CopySourceNotFound"
],
"x-ms-enum": {
"name": "CopyCompletionError",
"modelAsString": true,
"values": [
{
"value": "CopySourceNotFound",
"description": "Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress."
}
]
}
},
"errorMessage": {
"type": "string",
"description": "Indicates the error message if the background copy of a resource created via the CopyStart operation fails."
}
},
"required": [
"errorCode",
"errorMessage"
],
"description": "Indicates the error details if the background copy of a resource created via the CopyStart operation fails."
},
"SupportedCapabilities": {
"type": "object",
"properties": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"api-version": "2022-03-02",
"diskName": "myPremiumV2Disk",
"disk": {
"location": "West US",
"sku": {
"name": "PremiumV2_LRS"
},
"properties": {
"creationData": {
"createOption": "Empty"
},
"diskSizeGB": 200,
"diskIOPSReadWrite": 125,
"diskMBpsReadWrite": 3000
}
}
},
"responses": {
"202": {
"body": {
"properties": {
"creationData": {
"createOption": "Empty"
},
"diskSizeGB": 200,
"provisioningState": "Updating"
},
"location": "West US",
"name": "myPremiumV2Disk",
"sku": {
"name": "PremiumV2_LRS",
"tier": "Premium"
}
}
},
"200": {
"body": {
"properties": {
"creationData": {
"createOption": "Empty"
},
"diskSizeGB": 200,
"provisioningState": "Updating"
},
"location": "West US",
"name": "myPremiumV2Disk",
"sku": {
"name": "PremiumV2_LRS",
"tier": "Premium"
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,10 @@
"type": "number",
"description": "Percentage complete for the background copy when a resource is created via the CopyStart operation."
},
"copyCompletionError": {
"$ref": "./diskRPCommon.json#/definitions/CopyCompletionError",
"description": "Indicates the error details if the background copy of a resource created via the CopyStart operation fails."
},
"dataAccessAuthMode": {
"$ref": "./diskRPCommon.json#/definitions/DataAccessAuthMode"
}
Expand Down

0 comments on commit ad5a64a

Please sign in to comment.