Azure SQL (MSSQL) Server Reference

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

The csb-azure-mssql-server service manages stand-alone Azure SQL Server service instances on Azure. No databases are created or managed.

Plans

The table below lists the pre-configured plans for Azure SQL (MSSQL) Server:

Plan	Description
standard	Stand-alone SQL Server

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.

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-server standard SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

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

cf update-service SERVICE-INSTANCE-NAME -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 service:

Parameter Name	Type	Description	Default	Operation
instance_name	string	The name of the service instance for the server.	csb-azsql-svr-INSTANCE-ID	provision
resource_group	string	The Azure resource group in which to create the instance.	rg-INSTANCE-NAME	provision
admin_username	string	The admin username for the server.	A randomly generated string.	provision and update
admin_password	string	The admin password for the server.	A randomly generated string.	provision and update
location	string	The Azure region in which to create the server.	westus	provision
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
authorized_network	string	The Azure subnet ID, in long form, that the instance is connected to through a service endpoint. The subnet must have the Microsoft.sql service enabled.	default	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

Binding Credentials

The format for binding credentials for Azure SQL Server is as follows:

{
    "hostname" : "DATABASE-SERVER-HOST",
    "port" : "DATABASE-SERVER-PORT",
    "username" : "AUTHENTICATION-USERNAME",
    "password" : "AUTHENTICATION-PASSWORD",
    "sqlServerName" : "SERVER-NAME",
    "sqldbResourceGroup" : "RESOURCE-GROUP-FOR-SERVER",
    "sqlServerFullyQualifiedDomainName" : "SERVER-FQDN",
    "databaseLogin" : "AUTHENTICATION-USERNAME",
    "databaseLoginPassword" : "AUTHENTICATION-PASSWORD"
}