SqlConnection.RegisteredApplication 属性

定义

命名空间:

Microsoft.Data.SqlClient

程序集:

Microsoft.Data.SqlClient.dll

程序包:

Microsoft.Data.SqlClient v7.1.0

重要

此 API 不符合 CLS。

获取或设置向服务器报告用于此连接的中间件应用程序标识。

public:
 property Microsoft::Data::SqlClient::RegisteredApplication RegisteredApplication { Microsoft::Data::SqlClient::RegisteredApplication get(); void set(Microsoft::Data::SqlClient::RegisteredApplication value); };

[System.CLSCompliant(false)]
public Microsoft.Data.SqlClient.RegisteredApplication RegisteredApplication { get; set; }

[<System.CLSCompliant(false)>]
member this.RegisteredApplication : Microsoft.Data.SqlClient.RegisteredApplication with get, set

Public Property RegisteredApplication As RegisteredApplication

属性值

RegisteredApplication

一个RegisteredApplication值。 默认值为 Unknown。

属性

CLSCompliantAttribute

例外

InvalidOperationException

连接正在打开或打开。 标识在登录期间报告，因此必须事先设置该标识。

示例

在打开连接之前设置标识：

using Microsoft.Data.SqlClient;

using SqlConnection connection = new(connectionString)
{
    RegisteredApplication = RegisteredApplication.EntityFrameworkCore
};
connection.Open();

注解

此 API 适用于在 中 RegisteredApplication保留标识符的已注册应用程序。 可以通过将值强制转换为该类型来报告未注册的标识符。

此值是遥测数据。 它完全由客户端提供，它可以报告范围中的任何标识符，因此它不是经过身份验证的标识，不得用于授权或任何其他安全决策。

标识在登录期间发送一次，因此必须在连接打开之前设置该标识。

启用池时，仅在建立新的物理连接时报告值，并且不是池密钥的一部分。 因此，池中提供的连接报告导致创建物理连接的标识，并在后台打开物理连接以满足 Min Pool Size 报告 Unknown。 将标识与一个连接字符串混合的应用程序应将此遥测视为指示性的，而不是确切的，或者禁用需要确切属性的池。