Skip to content

Commit

Permalink
Improve documentation of sql database & elastic pool skus (#5756)
Browse files Browse the repository at this point in the history
* Improve documentation of db and pool skus

* Update documentation for database 2017-10-01-preview

* Update documentation for elastic pool 2017-10-01-preview

* Fixed syntax error in databases 2017-10-01

* Fixed syntax error in elasticPools 2017-10-01

* Remove CreateVCoreDatabase example that is no longer referenced

* Remove DW DTU capacity example due to feedback

* Fixed broken Sku reference

* Fixed model validation issues

* Fixed another model validation error

* Additional doc tweaks
  • Loading branch information
jaredmoo authored and fearthecowboy committed Apr 30, 2019
1 parent 050ddad commit e82167e
Show file tree
Hide file tree
Showing 14 changed files with 272 additions and 107 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -200,29 +200,35 @@
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Creates a database with minimum number of parameters.": {
"$ref": "./examples/CreateDatabaseMin.json"
"Creates a VCore database by specifying service objective name.": {
"$ref": "./examples/CreateVCoreDatabaseByServiceObjective.json"
},
"Creates a VCore database with minimum number of parameters.": {
"$ref": "./examples/CreateVCoreDatabase.json"
"Creates a VCore database by specifying sku name and capacity.": {
"$ref": "./examples/CreateVCoreDatabaseBySkuNameCapacity.json"
},
"Creates a database from restore with database deletion time.": {
"$ref": "./examples/CreateDatabaseRestoreMode.json"
"Creates a data warehouse by specifying service objective name.": {
"$ref": "./examples/CreateDwDatabaseByServiceObjective.json"
},
"Creates a database with minimum number of parameters.": {
"$ref": "./examples/CreateDatabaseMin.json"
},
"Creates a database with default mode.": {
"$ref": "./examples/CreateDatabaseDefaultMode.json"
},
"Creates a database as a copy.": {
"$ref": "./examples/CreateDatabaseCopyMode.json"
},
"Creates a database from restore with restorableDroppedDatabaseId.": {
"$ref": "./examples/CreateDatabaseRestoreMode2.json"
"Creates a database as an on-line secondary.": {
"$ref": "./examples/CreateDatabaseSecondaryMode.json"
},
"Creates a database from PointInTimeRestore.": {
"$ref": "./examples/CreateDatabasePITRMode.json"
},
"Creates a database as an on-line secondary.": {
"$ref": "./examples/CreateDatabaseSecondaryMode.json"
"Creates a database from restore with database deletion time.": {
"$ref": "./examples/CreateDatabaseRestoreMode.json"
},
"Creates a database from restore with restorableDroppedDatabaseId.": {
"$ref": "./examples/CreateDatabaseRestoreMode2.json"
},
"Creates a database from recoverableDatabaseId.": {
"$ref": "./examples/CreateDatabaseRecoveryMode.json"
Expand Down Expand Up @@ -636,7 +642,9 @@
"Pausing",
"Paused",
"Resuming",
"Scaling"
"Scaling",
"OfflineChangingDwPerformanceTiers",
"OnlineChangingDwPerformanceTiers"
],
"type": "string",
"readOnly": true,
Expand Down Expand Up @@ -812,7 +820,7 @@
"properties": {
"sku": {
"$ref": "../../../common/v1/types.json#/definitions/Sku",
"description": "The name and tier of the SKU."
"description": "The database SKU.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:\r\n\r\n```azurecli\r\naz sql db list-editions -l <location> -o table\r\n````\r\n\r\n```powershell\r\nGet-AzSqlServerServiceObjective -Location <location>\r\n````\r\n"
},
"kind": {
"description": "Kind of database. This is metadata used for the Azure portal experience.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,8 @@
],
"properties": {
"sku": {
"$ref": "../../../common/v1/types.json#/definitions/Sku"
"$ref": "../../../common/v1/types.json#/definitions/Sku",
"description": "The elastic pool SKU.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command:\r\n\r\n```azurecli\r\naz sql elastic-pool list-editions -l <location> -o table\r\n````\r\n"
},
"kind": {
"description": "Kind of elastic pool. This is metadata used for the Azure portal experience.",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "Default-SQL-SouthEastAsia",
"serverName": "testsvr",
"databaseName": "testdw",
"api-version": "2017-03-01-preview",
"parameters": {
"location": "westus",
"sku": {
"name": "DW1000c"
}
}
},
"responses": {
"200": {
"body": {
"sku": {
"name": "DataWarehouse",
"tier": "DataWarehouse",
"capacity": 9000
},
"kind": "v12.0,user,datawarehouse,gen2",
"properties": {
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 263882790666240,
"status": "Online",
"databaseId": "188784c9-d602-4684-86cf-e67b6f03551a",
"creationDate": "2019-04-24T06:46:14.99Z",
"currentServiceObjectiveName": "DW1000c",
"requestedServiceObjectiveName": "DW1000c",
"defaultSecondaryLocation": "eastus",
"catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
"readScale": "Disabled",
"currentSku": {
"name": "DataWarehouse",
"tier": "DataWarehouse",
"capacity": 9000
}
},
"location": "westus",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdw",
"name": "testdw",
"type": "Microsoft.Sql/servers/databases"
}
},
"201": {
"body": {
"sku": {
"name": "DataWarehouse",
"tier": "DataWarehouse",
"capacity": 9000
},
"kind": "v12.0,user,datawarehouse,gen2",
"properties": {
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 263882790666240,
"status": "Online",
"databaseId": "188784c9-d602-4684-86cf-e67b6f03551a",
"creationDate": "2019-04-24T06:46:14.99Z",
"currentServiceObjectiveName": "DW1000c",
"requestedServiceObjectiveName": "DW1000c",
"defaultSecondaryLocation": "eastus",
"catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
"readScale": "Disabled",
"currentSku": {
"name": "DataWarehouse",
"tier": "DataWarehouse",
"capacity": 9000
}
},
"location": "westus",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdw",
"name": "testdw",
"type": "Microsoft.Sql/servers/databases"
}
},
"202": {}
}
}

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "Default-SQL-SouthEastAsia",
"serverName": "testsvr",
"databaseName": "testdb",
"api-version": "2017-03-01-preview",
"parameters": {
"location": "southeastasia",
"sku": {
"name": "BC",
"family": "Gen4",
"capacity": 2
}
}
},
"responses": {
"200": {
"body": {
"sku": {
"name": "BC_Gen4",
"tier": "BusinessCritical",
"family": "Gen4",
"capacity": 2
},
"kind": "v12.0,user",
"properties": {
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 1073741824,
"status": "Online",
"databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
"creationDate": "2017-06-07T04:41:33.937Z",
"currentServiceObjectiveName": "BC_Gen4_2",
"defaultSecondaryLocation": "North Europe",
"catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
"licenseType": "LicenseIncluded",
"maxLogSizeBytes": 104857600
},
"location": "southeastasia",
"id":
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
"name": "testdb",
"type": "Microsoft.Sql/servers/databases"
}
},
"201": {
"body": {
"sku": {
"name": "BC_Gen4",
"tier": "BusinessCritical",
"family": "Gen4",
"capacity": 2
},
"kind": "v12.0,user",
"properties": {
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 1073741824,
"status": "Online",
"databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
"creationDate": "2017-06-07T04:41:33.937Z",
"currentServiceObjectiveName": "BC_Gen4_2",
"defaultSecondaryLocation": "North Europe",
"catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
"licenseType": "LicenseIncluded",
"maxLogSizeBytes": 104857600
},
"location": "southeastasia",
"id":
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
"name": "testdb",
"type": "Microsoft.Sql/servers/databases"
}
},
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"parameters": {
"subscriptionId": "00000000-1111-2222-3333-444444444444",
"resourceGroupName": "Default-SQL-SouthEastAsia",
"serverName": "testsvr",
"databaseName": "testdb",
"api-version": "2017-03-01-preview",
"parameters": {
"location": "southeastasia",
"sku": {
"name": "BC_Gen4",
"capacity": 2
}
}
},
"responses": {
"200": {
"body": {
"sku": {
"name": "BC_Gen4",
"tier": "BusinessCritical",
"family": "Gen4",
"capacity": 2
},
"kind": "v12.0,user",
"properties": {
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 1073741824,
"status": "Online",
"databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
"creationDate": "2017-06-07T04:41:33.937Z",
"currentServiceObjectiveName": "BC_Gen4_2",
"defaultSecondaryLocation": "North Europe",
"catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
"licenseType": "LicenseIncluded",
"maxLogSizeBytes": 104857600
},
"location": "southeastasia",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
"name": "testdb",
"type": "Microsoft.Sql/servers/databases"
}
},
"201": {
"body": {
"sku": {
"name": "BC_Gen4",
"tier": "BusinessCritical",
"family": "Gen4",
"capacity": 2
},
"kind": "v12.0,user",
"properties": {
"collation": "SQL_Latin1_General_CP1_CI_AS",
"maxSizeBytes": 1073741824,
"status": "Online",
"databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3",
"creationDate": "2017-06-07T04:41:33.937Z",
"currentServiceObjectiveName": "BC_Gen4_2",
"defaultSecondaryLocation": "North Europe",
"catalogCollation": "SQL_Latin1_General_CP1_CI_AS",
"licenseType": "LicenseIncluded",
"maxLogSizeBytes": 104857600
},
"location": "southeastasia",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb",
"name": "testdb",
"type": "Microsoft.Sql/servers/databases"
}
},
"202": {}
}
}
Loading

0 comments on commit e82167e

Please sign in to comment.