Share via

KestrelServerOptionsHttpsExtensions.UseHttps Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Hosting
Assembly:
Microsoft.AspNetCore.Server.Kestrel.Https.dll
Package:
Microsoft.AspNetCore.Server.Kestrel.Https v1.0.0
Package:
Microsoft.AspNetCore.Server.Kestrel.Https v1.1.0

Overloads

UseHttps(KestrelServerOptions, HttpsConnectionFilterOptions)

Configure Kestrel to use HTTPS.
UseHttps(KestrelServerOptions, X509Certificate2)

Configure Kestrel to use HTTPS.
UseHttps(KestrelServerOptions, String)

Configure Kestrel to use HTTPS.
UseHttps(KestrelServerOptions, String, String)

Configure Kestrel to use HTTPS.

UseHttps(KestrelServerOptions, HttpsConnectionFilterOptions)

Configure Kestrel to use HTTPS.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ UseHttps(Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ options, Microsoft::AspNetCore::Server::Kestrel::Https::HttpsConnectionFilterOptions ^ httpsOptions);
public static Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions UseHttps (this Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions options, Microsoft.AspNetCore.Server.Kestrel.Https.HttpsConnectionFilterOptions httpsOptions);
static member UseHttps : Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions * Microsoft.AspNetCore.Server.Kestrel.Https.HttpsConnectionFilterOptions -> Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions
<Extension()>
Public Function UseHttps (options As KestrelServerOptions, httpsOptions As HttpsConnectionFilterOptions) As KestrelServerOptions

Parameters

options
KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions to configure.

httpsOptions
HttpsConnectionFilterOptions

Options to configure HTTPS.

Returns

KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions.

Applies to

UseHttps(KestrelServerOptions, X509Certificate2)

Configure Kestrel to use HTTPS.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ UseHttps(Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ options, System::Security::Cryptography::X509Certificates::X509Certificate2 ^ serverCertificate);
public static Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions UseHttps (this Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions options, System.Security.Cryptography.X509Certificates.X509Certificate2 serverCertificate);
static member UseHttps : Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions * System.Security.Cryptography.X509Certificates.X509Certificate2 -> Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions
<Extension()>
Public Function UseHttps (options As KestrelServerOptions, serverCertificate As X509Certificate2) As KestrelServerOptions

Parameters

options
KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions to configure.

serverCertificate
X509Certificate2

The X.509 certificate.

Returns

KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions.

Applies to

UseHttps(KestrelServerOptions, String)

Configure Kestrel to use HTTPS.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ UseHttps(Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ options, System::String ^ fileName);
public static Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions UseHttps (this Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions options, string fileName);
static member UseHttps : Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions * string -> Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions
<Extension()>
Public Function UseHttps (options As KestrelServerOptions, fileName As String) As KestrelServerOptions

Parameters

options
KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions to configure.

fileName
String

The name of a certificate file, relative to the directory that contains the application content files.

Returns

KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions.

Applies to

UseHttps(KestrelServerOptions, String, String)

Configure Kestrel to use HTTPS.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ UseHttps(Microsoft::AspNetCore::Server::Kestrel::KestrelServerOptions ^ options, System::String ^ fileName, System::String ^ password);
public static Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions UseHttps (this Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions options, string fileName, string password);
static member UseHttps : Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions * string * string -> Microsoft.AspNetCore.Server.Kestrel.KestrelServerOptions
<Extension()>
Public Function UseHttps (options As KestrelServerOptions, fileName As String, password As String) As KestrelServerOptions

Parameters

options
KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions to configure.

fileName
String

The name of a certificate file, relative to the directory that contains the application content files.

password
String

The password required to access the X.509 certificate data.

Returns

KestrelServerOptions

The Microsoft.AspNetCore.Server.KestrelServerOptions.

Applies to