• Article

HttpProtocol.AuthenticationRealm Property

Gets or sets an authentication realm hint used in the HTTP authentication challenge.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property AuthenticationRealm As String
    Get
    Set
'Usage
Dim instance As HttpProtocol
Dim value As String

value = instance.AuthenticationRealm

instance.AuthenticationRealm = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public string AuthenticationRealm { get; set; }

[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property String^ AuthenticationRealm {
    String^ get ();
    void set (String^ value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member AuthenticationRealm : string with get, set

function get AuthenticationRealm () : String
function set AuthenticationRealm (value : String)

Property Value

Type: System.String
A String value that contains the authentication realm hint used in the HTTP authentication challenge.

Remarks

The client sends a SOAP request to the HTTP endpoint. The AuthenticationRealm property value is included in the HTTP authentication challenge that is returned to the client.

The AuthenticationRealm property is required only when the HttpAuthenticationModes property is set to the value Digest.