SQLProfile [SPFSDK][VMROLE]

Article
08/24/2015

Applies To: Windows Azure Pack

The SQLProfile object provides settings to install service instances of Microsoft SQL Server when a Windows-based virtual machine is provisioned.

Type Hierarchy

ResourceExtension [SPFSDK][VMROLE].ExtensionSettings [SPFSDK][VMROLE].ApplicationProfile.WindowsApplicationProfile [SPFSDK][VMROLE].SQLProfile

Syntax

{
    "SQLDeployments": [
        {
            "DeploymentName": "string",
            "InstanceName": "string",
            "InstanceID": "string",
            "EnableNamedPipes": boolean,
            "EnableTCP": boolean,
            "MediaSource": "string",
            "ProductKey": "string",
            "SQLAuthenticationType": "string",
            "SQLSysAdminMemberList": "string",
            "DeploymentTimeOutInSeconds": int,
            "SQLConfigurationPayloadId": "string",
            "SAPassword": "string",

            "SQLDeploymentCredential": credential string,
            "SQLAgentServiceCredential": credential string,
            "SQLServiceCredential": credential string,
            "SQLReportingServiceCredential": credential string
        }
    ]
}

Properties

Name	Type	Required	Default Value	Description
SQLDeployments	Array of SQLDeployment	No	null	The array of instances of SQL Server to deploy.

SQLDeployment

Name	Type	Required	Default Value	Description
DeploymentName	String	Yes	None	The name that identifies the deployment.
InstanceName	String	Yes	None	The name of the instance of SQL Server.
InstanceID	String	Yes	None	The identifier of the prepared instance of SQL Server.
EnableNamedPipes	Boolean	Yes	None	The setting that determines whether to enable named pipe communication on the instance of SQL Server.
EnableTCP	Boolean	Yes	None	The setting that determines whether to enable TCP communication on the instance of SQL Server.
MediaSource	String	Yes	None	This property has two different meanings, which are based on what version of SQL Server is to be installed. SQL Server 2008 R2 The location of the media to complete the SQL Server installation. SQL Server 2012 The location in %Program Files% where the SQL Server Setup.exe was installed during the prepare phase.
ProductKey	String	No	Trial product key	The product key for SQL Server.
SQLAuthenticationType	String	Yes	None	The security mode under which SQL Server is installed. Valid values are: WindowsAuthentication SQLAuthentication
SQLSysAdminMemberList	String	Yes	None	The accounts to add as SQL Server administrators. The format is domain\user name.
DeploymentTimeOutInSeconds	Int	Yes	None	The time in seconds to wait for the SQL Server installation to complete before continuing.
SAPassword	String	No	Empty String	The SA password to use for SQLAuthentication.
SQLConfigurationPayloadId	String	No	null	The identifier of an ApplicationProfile.ApplicationPayload item. This payload must point to a SQL Server Configurationfile.ini answer file.
SQLDeploymentCredential	Credential String	No	NT AUTHORITY\System	The credential for the user under which the SQL Server installation runs. The format is domain\user name:password.
SQLAgentServiceCredential	Credential String	No	NT AUTHORITY\System	The credential for the user under which the SQL Server Agent service runs. The format is domain\user name:password.
SQLServiceCredential	Credential String	No	NT AUTHORITY\System	The credential for the user under which the SQL Server service runs. The format is domain\user name:password.
SQLReportingServiceCredential	Credential String	No	None	The credential for the user under which the SQL Server Reporting Services service runs. The format is domain\user name:password.

Remarks

The following sample example provides a sample SQLProfile object.

{
    "SQLDeployments": [
        {
            "DeploymentName": "SQL Deployment 1",
            "InstanceName": "[Param.SQLInstance]",
            "InstanceID": "[Param.SQLInstance]",
            "EnableNamedPipes": false,
            "EnableTCP": true,
            "MediaSource": "c:\\SQLMediaPath\\sqlsetup.exe",
            "ProductKey": "abcdefghijklmnopqrstuvwxyz",
            "SQLAuthenticationType": "WindowsAuthentication",
            "SQLSysAdminMemberList": "domain\\user",
            "DeploymentTimeOutInSeconds": 3600,
            "SQLConfigurationPayloadId": "61A33949-46CE-4d0f-921F-A0059DA9AD1F",
            "SAPassword": "MySAPassword",

            "SQLDeploymentCredential": "domain\\user:password",
            "SQLAgentServiceCredential": "NT AUTHORITY\\System:",
            "SQLServiceCredential": "NT AUTHORITY\\NetworkService:",
            "SQLReportingServiceCredential": "domain\\user:password"
        }
    ]
}

Share via