-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SqlCommandColumnEncryptionSetting.xml
114 lines (110 loc) · 6.94 KB
/
SqlCommandColumnEncryptionSetting.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<Type Name="SqlCommandColumnEncryptionSetting" FullName="System.Data.SqlClient.SqlCommandColumnEncryptionSetting">
<TypeSignature Language="C#" Value="public enum SqlCommandColumnEncryptionSetting" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SqlCommandColumnEncryptionSetting extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.Data.SqlClient.SqlCommandColumnEncryptionSetting" />
<TypeSignature Language="VB.NET" Value="Public Enum SqlCommandColumnEncryptionSetting" />
<TypeSignature Language="F#" Value="type SqlCommandColumnEncryptionSetting = " />
<TypeSignature Language="C++ CLI" Value="public enum class SqlCommandColumnEncryptionSetting" />
<AssemblyInfo>
<AssemblyName>System.Data</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Specifies how data will be sent and received when reading and writing encrypted columns. Depending on your specific query, performance impact may be reduced by bypassing the Always Encrypted driver's processing when non-encrypted columns are being used. Note that these settings cannot be used to bypass encryption and gain access to plaintext data. For details, see <see href="https://learn.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted (Database Engine)</see>.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
- If Always Encrypted is disabled for a query and the query has parameters that need to be encrypted (parameters that correspond to encrypted columns), the query will fail.
- If Always Encrypted is disabled for a query and the query returns results from encrypted columns, the query will return encrypted values. The encrypted values will have the varbinary datatype.
]]></format>
</remarks>
<related type="ExternalDocumentation" href="https://blogs.msdn.microsoft.com/sqlsecurity/2015/06/04/getting-started-with-always-encrypted/">Getting Started with Always Encrypted (blog post)</related>
<related type="ExternalDocumentation" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Always Encrypted (client development)</related>
</Docs>
<Members>
<Member MemberName="Disabled">
<MemberSignature Language="C#" Value="Disabled" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Data.SqlClient.SqlCommandColumnEncryptionSetting Disabled = int32(3)" />
<MemberSignature Language="DocId" Value="F:System.Data.SqlClient.SqlCommandColumnEncryptionSetting.Disabled" />
<MemberSignature Language="VB.NET" Value="Disabled" />
<MemberSignature Language="F#" Value="Disabled = 3" Usage="System.Data.SqlClient.SqlCommandColumnEncryptionSetting.Disabled" />
<MemberSignature Language="C++ CLI" Value="Disabled" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlCommandColumnEncryptionSetting</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Disables Always Encrypted for the query.</summary>
</Docs>
</Member>
<Member MemberName="Enabled">
<MemberSignature Language="C#" Value="Enabled" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Data.SqlClient.SqlCommandColumnEncryptionSetting Enabled = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.Data.SqlClient.SqlCommandColumnEncryptionSetting.Enabled" />
<MemberSignature Language="VB.NET" Value="Enabled" />
<MemberSignature Language="F#" Value="Enabled = 1" Usage="System.Data.SqlClient.SqlCommandColumnEncryptionSetting.Enabled" />
<MemberSignature Language="C++ CLI" Value="Enabled" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlCommandColumnEncryptionSetting</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Enables Always Encrypted for the query.</summary>
</Docs>
</Member>
<Member MemberName="ResultSetOnly">
<MemberSignature Language="C#" Value="ResultSetOnly" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Data.SqlClient.SqlCommandColumnEncryptionSetting ResultSetOnly = int32(2)" />
<MemberSignature Language="DocId" Value="F:System.Data.SqlClient.SqlCommandColumnEncryptionSetting.ResultSetOnly" />
<MemberSignature Language="VB.NET" Value="ResultSetOnly" />
<MemberSignature Language="F#" Value="ResultSetOnly = 2" Usage="System.Data.SqlClient.SqlCommandColumnEncryptionSetting.ResultSetOnly" />
<MemberSignature Language="C++ CLI" Value="ResultSetOnly" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlCommandColumnEncryptionSetting</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Specifies that only the results of the command should be processed by the Always Encrypted routine in the driver. Use this value when the command has no parameters that require encryption.</summary>
</Docs>
</Member>
<Member MemberName="UseConnectionSetting">
<MemberSignature Language="C#" Value="UseConnectionSetting" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Data.SqlClient.SqlCommandColumnEncryptionSetting UseConnectionSetting = int32(0)" />
<MemberSignature Language="DocId" Value="F:System.Data.SqlClient.SqlCommandColumnEncryptionSetting.UseConnectionSetting" />
<MemberSignature Language="VB.NET" Value="UseConnectionSetting" />
<MemberSignature Language="F#" Value="UseConnectionSetting = 0" Usage="System.Data.SqlClient.SqlCommandColumnEncryptionSetting.UseConnectionSetting" />
<MemberSignature Language="C++ CLI" Value="UseConnectionSetting" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.SqlClient.SqlCommandColumnEncryptionSetting</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Specifies that the command should default to the Always Encrypted setting in the connection string.</summary>
</Docs>
</Member>
</Members>
</Type>