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

Jump to bottom

Improve documentation of sql database & elastic pool skus #5756

Merged
merged 11 commits into from
Apr 29, 2019
Merged

Improve documentation of sql database & elastic pool skus #5756

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
896f588
Improve documentation of db and pool skus
jaredmoo Apr 25, 2019
d1f970c
Update documentation for database 2017-10-01-preview
jaredmoo Apr 25, 2019
f9318d2
Update documentation for elastic pool 2017-10-01-preview
jaredmoo Apr 25, 2019
a5b9092
Fixed syntax error in databases 2017-10-01
jaredmoo Apr 25, 2019
e9cd7ab
Fixed syntax error in elasticPools 2017-10-01
jaredmoo Apr 25, 2019
a9fe4f0
Remove CreateVCoreDatabase example that is no longer referenced
jaredmoo Apr 25, 2019
ab50c9b
Remove DW DTU capacity example due to feedback
jaredmoo Apr 25, 2019
6690d07
Fixed broken Sku reference
jaredmoo Apr 28, 2019
9578efe
Fixed model validation issues
jaredmoo Apr 29, 2019
09a4f88
Fixed another model validation error
jaredmoo Apr 29, 2019
20ffeb2
Additional doc tweaks
jaredmoo Apr 29, 2019
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
39 changes: 25 additions & 14 deletions specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,29 +200,38 @@
},
"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"
NelsonDaniel marked this conversation as resolved.
Show resolved Hide resolved
"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 DTU capacity.": {
jaredmoo marked this conversation as resolved.
Show resolved Hide resolved
"$ref": "./examples/CreateDwDatabaseByDtuCapacity.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 +645,9 @@
"Pausing",
"Paused",
"Resuming",
"Scaling"
"Scaling",
"OfflineChangingDwPerformanceTiers",
"OnlineChangingDwPerformanceTiers"
],
"type": "string",
"readOnly": true,
Expand Down Expand Up @@ -796,13 +807,13 @@
"type": "object",
"allOf": [
{
"$ref": "../../../common/v1/types.json#/definitions/TrackedResource"
"$ref": "../../../common/v1/types.json#/definitions/TrackedResource",
}
],
"properties": {
"sku": {
"$ref": "../../../common/v1/types.json#/definitions/Sku",
"description": "The name and tier of the SKU."
"$ref": "#/definitions/Sku",
NelsonDaniel marked this conversation as resolved.
Show resolved Hide resolved
"description": "The database SKU.\r\n\r\nTo determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure location, use the `Capabilities_ListByLocation` REST API or one of the following interfaces:\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
83 changes: 83 additions & 0 deletions ...ager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateDwDatabaseByDtuCapacity.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{
"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": "DataWarehouse",
"capacity": 9000
jaredmoo marked this conversation as resolved.
Show resolved Hide resolved
}
}
},
"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",
"readReplicaCount": 0,
"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",
"readReplicaCount": 0,
"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": {}
}
}
82 changes: 82 additions & 0 deletions ...Microsoft.Sql/preview/2017-10-01-preview/examples/CreateDwDatabaseByServiceObjective.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
{
"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",
"readReplicaCount": 0,
"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",
"readReplicaCount": 0,
"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": {}
}
}
76 changes: 76 additions & 0 deletions ...rosoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json
View file
Open in desktop
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": {}
}
}
73 changes: 73 additions & 0 deletions ...crosoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json
View file
Open in desktop
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