Skip to content

Commit 49d4df7

Browse files
Update docs for release (#806)
1 parent cde615e commit 49d4df7

File tree

3 files changed

+23
-20
lines changed

3 files changed

+23
-20
lines changed

doc/snippets/Microsoft.Data.SqlClient/ActiveDirectoryAuthenticationProvider.xml

+19-16
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,18 @@
4747
<SetDeviceCodeFlowCallback>
4848
<param name="deviceCodeFlowCallbackMethod">The callback method to be used with 'Active Directory Device Code Flow' authentication.</param>
4949
<summary>Sets the callback method, overriding the default implementation that processes the result for 'Active Directory Device Code Flow' authentication.</summary>
50+
<remarks>
51+
<format type="text/markdown">
52+
<![CDATA[
53+
54+
## Examples
55+
The following example demonstrates providing a custom device flow callback to SqlClient for the Device Code Flow authentication method:
56+
57+
[!code-csharp[ActiveDirectory_DeviceCodeFlowCallback Example#1](~/../sqlclient/doc/samples/AADAuthenticationCustomDeviceFlowCallback.cs#1)]
58+
59+
]]>
60+
</format>
61+
</remarks>
5062
</SetDeviceCodeFlowCallback>
5163
<SetParentActivityOrWindowFunc>
5264
<param name="parentActivityOrWindowFunc">The parent as an object, in order to be used from shared .NET Standard assemblies.</param>
@@ -83,23 +95,14 @@
8395
<![CDATA[
8496
8597
## Remarks
86-
The supported authentication methods are:
87-
88-
|Authentication Method|
89-
|----------------|
90-
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryPassword%2A>|
91-
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryIntegrated%2A>|
92-
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryInteractive%2A>|
93-
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryServicePrincipal%2A>|
94-
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryDeviceCodeFlow%2A>|
95-
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryManagedIdentity%2A>|
96-
|<xref:Microsoft.Data.SqlClient.SqlAuthenticationMethod.ActiveDirectoryMSI%2A>|
98+
The supported authentication modes with <see cref="T:Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider" /> are:
99+
100+
- Active Directory Password
101+
- Active Directory Integrated
102+
- Active Directory Interactive
103+
- Active Directory Service Principal
104+
- Active Directory Device Code Flow
97105
98-
## Examples
99-
The following example demonstrates providing a custom device flow callback to SqlClient for the Device Code Flow authentication method:
100-
101-
[!code-csharp[ActiveDirectory_DeviceCodeFlowCallback Example#1](~/../sqlclient/doc/samples/AADAuthenticationCustomDeviceFlowCallback.cs#1)]
102-
103106
]]>
104107
</format>
105108
</remarks>

doc/snippets/Microsoft.Data.SqlClient/SqlParameter.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ If you do not perform this conversion, the compiler assumes that you are trying
115115
<param name="parameterName">The name of the parameter to map.</param>
116116
<param name="dbType">One of the <see cref="T:System.Data.SqlDbType" /> values.</param>
117117
<param name="size">The length of the parameter.</param>
118-
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update" />.</param>
118+
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />>.</param>
119119
<summary>Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> class that uses the parameter name, the <see cref="T:System.Data.SqlDbType" />, the size, and the source column name.</summary>
120120
<remarks>
121121
<format type="text/markdown"><![CDATA[
@@ -143,7 +143,7 @@ If you do not perform this conversion, the compiler assumes that you are trying
143143
<see langword="true" /> if the value of the field can be null; otherwise, <see langword="false" />.</param>
144144
<param name="precision">The total number of digits to the left and right of the decimal point to which <see cref="P:Microsoft.Data.SqlClient.SqlParameter.Value" /> is resolved.</param>
145145
<param name="scale">The total number of decimal places to which <see cref="P:Microsoft.Data.SqlClient.SqlParameter.Value" /> is resolved.</param>
146-
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update" />.</param>
146+
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />.</param>
147147
<param name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion" /> values.</param>
148148
<param name="value">An <see cref="T:System.Object" /> that is the value of the <see cref="T:Microsoft.Data.SqlClient.SqlParameter" />.</param>
149149
<summary>Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> class that uses the parameter name, the type of the parameter, the size of the parameter, a <see cref="T:System.Data.ParameterDirection" />, the precision of the parameter, the scale of the parameter, the source column, a <see cref="T:System.Data.DataRowVersion" /> to use, and the value of the parameter.</summary>
@@ -171,7 +171,7 @@ If you do not perform this conversion, the compiler assumes that you are trying
171171
<param name="direction">One of the <see cref="T:System.Data.ParameterDirection" /> values.</param>
172172
<param name="precision">The total number of digits to the left and right of the decimal point to which <see cref="P:Microsoft.Data.SqlClient.SqlParameter.Value" /> is resolved.</param>
173173
<param name="scale">The total number of decimal places to which <see cref="P:Microsoft.Data.SqlClient.SqlParameter.Value" /> is resolved.</param>
174-
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update" />.</param>
174+
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />>.</param>
175175
<param name="sourceVersion">One of the <see cref="T:System.Data.DataRowVersion" /> values.</param>
176176
<param name="sourceColumnNullMapping">
177177
<see langword="true" /> if the source column is nullable; <see langword="false" /> if it is not.</param>

doc/snippets/Microsoft.Data.SqlClient/SqlParameterCollection.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ This overload is useful when you are adding a parameter of a variable-length dat
108108
<param name="parameterName">The name of the parameter.</param>
109109
<param name="sqlDbType">One of the <see cref="T:System.Data.SqlDbType" /> values.</param>
110110
<param name="size">The column length.</param>
111-
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update" />.</param>
111+
<param name="sourceColumn">The name of the source column (<see cref="P:Microsoft.Data.SqlClient.SqlParameter.SourceColumn" />) if this <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> is used in a call to <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />.</param>
112112
<summary>Adds a <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> to the <see cref="T:Microsoft.Data.SqlClient.SqlParameterCollection" /> with the parameter name, the data type, and the column length.</summary>
113113
<returns>A new <see cref="T:Microsoft.Data.SqlClient.SqlParameter" /> object.</returns>
114114
<remarks>

0 commit comments

Comments
 (0)