Azure SQL (MSSQL) Database Reference

This topic provides reference information about the Azure SQL (MSSQL) Database service (csb-azure-mssql-db). It details the plans, configuration parameters, and binding credentials.

The csb-azure-mssql-db service manages Azure SQL databases on pre-configured database servers on Azure SQL. For more information about Azure SQL, see the Microsoft documentation.

Configuring the Service

To configure the service:

Provide the pre-configured database servers in the following format when configuring Cloud Service Broker for Azure:

{
   "SERVER1":{
      "server_name": "SERVER1_FQDN",
      "server_resource_group": "SERVER1_RESOURCE_GROUP",
      "admin_username": "SERVER1_ADMIN_USERNAME",
      "admin_password": "SERVER1_ADMIN_PASSWORD"
   },
   "SERVER2":{
      "server_name": "SERVER2_FQDN",
      "server_resource_group": "SERVER2_RESOURCE_GROUP",
      "admin_username": "SERVER2_ADMIN_USERNAME",
      "admin_password": "SERVER2_ADMIN_PASSWORD"
   }
}

For more information about configuring services, see Configure Services with Cloud Service Broker for Azure.

Plans

The table below lists the plans available for the csb-azure-mssql-db service:

Plan	CPUs	Maximum Storage Size
mini	2	5 GB
small	2	5 GB
medium	8	200 GB
large	32	500 GB
extra-large	80	1 TB
subsume*	n/a	n/a

^* The subsume plan is used to import existing Azure MSSQL databases to bring them under the control of Cloud Service Broker for Azure. For more information, see Subsuming a Microsoft Azure Service Broker MSSQL Database Instance.

Plan Configuration Parameters

When configuring Cloud Service Broker for Azure you can add additional plans. For how to configure plans, see Configure Services with Cloud Service Broker for Azure.

The following table lists parameters which can only be configured for additional plans:

Parameter Name	Values	Default
`name`*	The plan name	n/a
`id`*	A unique GUID	n/a
`description`*	Description of the new plan	n/a
`display_name`	Name to use when displaying plan in marketplace	n/a

^* Required

You can also add any of the configuration parameters listed in the parameters section to your plan. To create plans with specific size limits we recommend setting sku_name or cores and max_storage_gb properties.

Note: If you set a parameter at plan level, developers cannot change the value when creating or updating service instances.

Configuration Parameters

You can provision a service by running:

cf create-service csb-azure-mssql-db PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

For example:

$ cf create-service csb-azure-mssql-db small mssql-dev -c '{"server":"server1"}'

You can update the plan or configuration parameters for a service instance by running:

cf update-service SERVICE-INSTANCE-NAME [-p NEW-PLAN] -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

The table below lists the parameters that you can configure, using the -c flag, when provisioning or updating a csb-azure-mssql-db service:

Parameter Name	Type	Description	Default	Operation
`db_name`	string	The name of the database.	`csb-db-INSTANCE-ID`	provision and update
`server`	string	(Required) The name of the server on which to create the database. This must match one of the `SERVER` parameters in one of the servers configured when configuring the service.	n/a	provision and update
`azure_tenant_id`	string	The ID of the Azure tenant for the service instance.	The value the operator entered for Tenant ID in Ops Manager.	provision and update
`azure_subscription_id`	string	The ID of the Azure subscription for the service instance.	The value the operator entered for Subscription ID in Ops Manager.	provision and update
`azure_client_id`	string	The ID of the Azure service principal to authenticate for service instance creation.	The value the operator entered for Client ID in Ops Manager.	provision and update
`azure_client_secret`	string	The secret (password) for the Azure service principal to authenticate for service instance creation.	The value the operator entered for Client Secret in Ops Manager.	provision and update
`cores`	number	Number vCores for the instance (up to the maximum allowed for the service tier). 1–80, multiples of 2	2	provision and update
`max_storage_gb`	number	Maximum storage allocated to the database instance in GB.	5	provision and update
`sku_name`	string	The Azure stock-keeping unit (SKU). For more information about configuring this parameter, see the SKUs section.	n/a	provision and update
`skip_provider_registration`	boolean	Set to `true` to skip automatic Azure provider registration. Set if the service principal being used does not have the rights to register providers.	`false`	provision and update
`short_term_retention_days`	number	Retention period in days for short-term retention (Point in Time Restore) policy. The maximum period is 35 days.	`7`	provision and update

SKUs

SKUs are usually formatted as TIER_FAMILY_NUMBER-OF-CORES. Where:

Examples of TIER are GP\_S, GP, and HS
Examples of FAMILY are Gen4 and Gen5

Example SKUs are GP\_S\_Gen4\_1 and GP\_Gen5\_8.

If you do not define a SKU using the sku_name parameter, the SKU is computed from the number of cores in your plan. See Plans above.

The table below shows the mapping of the number of cores to the corresponding Azure SKU:

Cores	SKU
1	GP_Gen5_1
2	GP_Gen5_2
4	GP_Gen5_4
8	GP_Gen5_8
16	GP_Gen5_16
32	GP_Gen5_32
80	GP_Gen5_80

For a list of all valid SKUs, run:

az sql db list-editions -l LOCATION -o table

For information about the vCore purchasing model, see this Microsoft documentation.
For information about the DTU purchasing model, see this Microsoft documentation.

Note: Azure SQL service instances use the vCore model and the Gen5 hardware generation unless you override this default using the sku_name parameter. For more information about the vCore model, see the Microsoft documentation.

Note: When updating a service instance, the SKU for the updated service instance must remain in the same tier (GP_S, GP, or HS). If you update to a different tier, Azure refuses the update request.

Binding Credentials

The format for binding credentials for an Azure SQL database is as follows:

{
    "name" : "DATABASE-NAME",
    "hostname" : "DATABASE-SERVER-HOST",
    "port" : "DATABASE-SERVER-PORT",
    "username" : "AUTHENTICATION-USERNAME",
    "password" : "AUTHENTICATION-PASSWORD",
    "server" : "SERVER-NAME",
    "uri" : "DATABASE-CONNECTION-URI",
    "jdbcUrl" : "JDBC-FORMAT-CONNECTION-URI",
    "jdbcUrlForAuditingEnabled" : "JDBC-FORMAT-CONNECTION-URI",
    "sqldbName" : "DATABASE-NAME",
    "sqlServerName" : "SERVER-NAME",
    "sqlServerFullyQualifiedDomainName" : "SERVER-FQDN",
    "databaseLogin" : "AUTHENTICATION-USERNAME",
    "databaseLoginPassword" : "AUTHENTICATION-PASSWORD"
}