• Article

Server.Configuration Property

Gets the configuration options for the instance of SQL Server.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)> _
Public ReadOnly Property Configuration As Configuration
    Get
'Usage
Dim instance As Server
Dim value As Configuration

value = instance.Configuration

[SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)]
public Configuration Configuration { get; }

[SfcObjectAttribute(SfcObjectRelationship::ChildObject, SfcObjectCardinality::One)]
public:
property Configuration^ Configuration {
    Configuration^ get ();
}

[<SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)>]
member Configuration : Configuration

function get Configuration () : Configuration

Property Value

Type: Microsoft.SqlServer.Management.Smo.Configuration
A Configuration object that specifies the configuration options for the instance of SQL Server.

Remarks

The Configuration property points to the Configuration object, which has a property for each configurable server setting, such as FillFactor and NestedTriggers. Each property points to a ConfigProperty object that contains the maximum value, minimum value, and run value of the server setting. It also tells you whether the server setting is advanced and whether it is dynamic. The server settings can be modified by setting the properties of the ConfigProperty object. If the server setting is not dynamic, you must also restart the system.

Examples

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Display all the configuration options.
Dim p As ConfigProperty
For Each p In srv.Configuration.Properties
    Console.WriteLine(p.DisplayName)
Next
Console.WriteLine("There are " & srv.Configuration.Properties.Count.ToString & " configuration options.")
'Display the maximum and minimum values for ShowAdvancedOptions.
Dim min As Integer
Dim max As Integer
min = srv.Configuration.ShowAdvancedOptions.Minimum
max = srv.Configuration.ShowAdvancedOptions.Maximum
Console.WriteLine("Minimum and Maximum values are " & min & " and " & max & ".")
'Modify the value of ShowAdvancedOptions and run the Alter method.
srv.Configuration.ShowAdvancedOptions.ConfigValue = 0
srv.Configuration.Alter()
'Display when the change takes place according to the IsDynamic property.
If srv.Configuration.ShowAdvancedOptions.IsDynamic = True Then
    Console.WriteLine("Configuration option has been updated.")
Else
    Console.WriteLine("Configuration option will be updated when SQL Server is restarted.")
End If