Skip to content

Commit 1d13d52

Browse files
gewarrengewarren
authored
Fix up see also links (#10860)
1 parent 1c1c32d commit 1d13d52

File tree

44 files changed

+3046
-3057
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+3046
-3057
lines changed

‎xml/System.Data.SqlClient/SqlColumnEncryptionCertificateStoreProvider.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<summary>The implementation of the key store provider for Windows Certificate Store. This class enables using certificates stored in the Windows Certificate Store as column master keys. For details, see <see href="https://learn.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted</see>.</summary>
2222
<remarks>To be added.</remarks>
2323
<related type="ExternalDocumentation" href="https://techcommunity.microsoft.com/t5/sql-server/getting-started-with-always-encrypted/ba-p/384397">Get started with Always Encrypted (blog post)</related>
24-
<related type="ExternalDocumentation" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
24+
<related type="Article" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
2525
</Docs>
2626
<Members>
2727
<Member MemberName=".ctor">
@@ -66,7 +66,7 @@
6666
<param name="encryptionAlgorithm">The encryption algorithm. Currently, the only valid value is: <c>RSA_OAEP</c>.</param>
6767
<param name="encryptedColumnEncryptionKey">The encrypted column encryption key.</param>
6868
<summary>Decrypts the specified encrypted value of a column encryption key. The encrypted value is expected to be encrypted using the certificate with the specified key path and using the specified algorithm. The format of the key path should be "Local Machine/My/&lt;certificate_thumbprint&gt;" or "Current User/My/&lt;certificate_thumbprint&gt;".</summary>
69-
<returns>Returns <see cref="T:System.Byte" />.
69+
<returns>Returns <see cref="T:System.Byte" />.
7070
The decrypted column encryption key.</returns>
7171
<remarks>To be added.</remarks>
7272
</Docs>
@@ -96,7 +96,7 @@ The decrypted column encryption key.</returns>
9696
<param name="encryptionAlgorithm">The encryption algorithm. Currently, the only valid value is: <c>RSA_OAEP</c>.</param>
9797
<param name="columnEncryptionKey">The encrypted column encryption key.</param>
9898
<summary>Encrypts a column encryption key using the certificate with the specified key path and using the specified algorithm. The format of the key path should be "Local Machine/My/&lt;certificate_thumbprint&gt;" or "Current User/My/&lt;certificate_thumbprint&gt;".</summary>
99-
<returns>Returns <see cref="T:System.Byte" />.
99+
<returns>Returns <see cref="T:System.Byte" />.
100100
The encrypted column encryption key.</returns>
101101
<remarks>To be added.</remarks>
102102
</Docs>

‎xml/System.Data.SqlClient/SqlColumnEncryptionCngProvider.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616
<Docs>
1717
<summary>The CMK Store provider implementation for using the Microsoft Cryptography API: Next Generation (CNG) with <see href="https://learn.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted</see>.</summary>
1818
<remarks>
19-
<format type="text/markdown"><![CDATA[
20-
21-
## Remarks
22-
Enables storing Always Encrypted column master key keys in a store, such as a hardware security module (HSM), that supports the Microsoft Cryptography API: Next Generation (CNG).
23-
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
Enables storing Always Encrypted column master key keys in a store, such as a hardware security module (HSM), that supports the Microsoft Cryptography API: Next Generation (CNG).
23+
2424
]]></format>
2525
</remarks>
2626
<related type="ExternalDocumentation" href="https://techcommunity.microsoft.com/t5/sql-server/getting-started-with-always-encrypted/ba-p/384397">Get started with Always Encrypted (blog post)</related>
27-
<related type="ExternalDocumentation" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
27+
<related type="Article" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
2828
</Docs>
2929
<Members>
3030
<Member MemberName=".ctor">
@@ -148,11 +148,11 @@
148148
<summary>Throws a <see cref="T:System.NotSupportedException" /> exception in all cases.</summary>
149149
<returns>The signature of the column master key metadata.</returns>
150150
<remarks>
151-
<format type="text/markdown"><![CDATA[
152-
153-
## Remarks
154-
The <xref:System.Data.SqlClient.SqlColumnEncryptionCngProvider.SignColumnMasterKeyMetadata%2A> method must be implemented by the corresponding key store providers. <xref:System.Data.SqlClient.SqlColumnEncryptionCngProvider.SignColumnMasterKeyMetadata%2A> should use an asymmetric key identified by a key path and sign the masterkey metadata consisting of `masterKeyPath`, `allowEnclaveComputations`, and providerName.
155-
151+
<format type="text/markdown"><![CDATA[
152+
153+
## Remarks
154+
The <xref:System.Data.SqlClient.SqlColumnEncryptionCngProvider.SignColumnMasterKeyMetadata%2A> method must be implemented by the corresponding key store providers. <xref:System.Data.SqlClient.SqlColumnEncryptionCngProvider.SignColumnMasterKeyMetadata%2A> should use an asymmetric key identified by a key path and sign the masterkey metadata consisting of `masterKeyPath`, `allowEnclaveComputations`, and providerName.
155+
156156
]]></format>
157157
</remarks>
158158
<exception cref="T:System.NotSupportedException">In all cases.</exception>

‎xml/System.Data.SqlClient/SqlColumnEncryptionCspProvider.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@
1616
<Docs>
1717
<summary>The CMK Store provider implementation for using Microsoft CAPI based Cryptographic Service Providers (CSP) with <see href="https://learn.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted</see>.</summary>
1818
<remarks>
19-
<format type="text/markdown"><![CDATA[
20-
21-
## Remarks
22-
Enables storing Always Encrypted column master key keys in a store, such as a hardware security module (HSM), that supports the Microsoft CAPI based Cryptographic Service Providers (CSP).
23-
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
Enables storing Always Encrypted column master key keys in a store, such as a hardware security module (HSM), that supports the Microsoft CAPI based Cryptographic Service Providers (CSP).
23+
2424
]]></format>
2525
</remarks>
2626
<related type="ExternalDocumentation" href="https://techcommunity.microsoft.com/t5/sql-server/getting-started-with-always-encrypted/ba-p/384397">Get started with Always Encrypted (blog post)</related>
27-
<related type="ExternalDocumentation" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
27+
<related type="Article" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
2828
</Docs>
2929
<Members>
3030
<Member MemberName=".ctor">
@@ -148,11 +148,11 @@
148148
<summary>Throws a <see cref="T:System.NotSupportedException" /> exception in all cases.</summary>
149149
<returns>The signature of the column master key metadata.</returns>
150150
<remarks>
151-
<format type="text/markdown"><![CDATA[
152-
153-
## Remarks
154-
The <xref:System.Data.SqlClient.SqlColumnEncryptionCspProvider.SignColumnMasterKeyMetadata%2A> method must be implemented by the corresponding key store providers. <xref:System.Data.SqlClient.SqlColumnEncryptionCspProvider.SignColumnMasterKeyMetadata%2A> should use an asymmetric key identified by a key path and sign the masterkey metadata consisting of `masterKeyPath`, `allowEnclaveComputations`, and providerName.
155-
151+
<format type="text/markdown"><![CDATA[
152+
153+
## Remarks
154+
The <xref:System.Data.SqlClient.SqlColumnEncryptionCspProvider.SignColumnMasterKeyMetadata%2A> method must be implemented by the corresponding key store providers. <xref:System.Data.SqlClient.SqlColumnEncryptionCspProvider.SignColumnMasterKeyMetadata%2A> should use an asymmetric key identified by a key path and sign the masterkey metadata consisting of `masterKeyPath`, `allowEnclaveComputations`, and providerName.
155+
156156
]]></format>
157157
</remarks>
158158
<exception cref="T:System.NotSupportedException">In all cases.</exception>

‎xml/System.Data.SqlClient/SqlColumnEncryptionKeyStoreProvider.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<summary>Base class for all key store providers. A custom provider must derive from this class and override its member functions and then register it using SqlConnection.RegisterColumnEncryptionKeyStoreProviders(). For details see, <see href="https://learn.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted</see>.</summary>
1818
<remarks>To be added.</remarks>
1919
<related type="ExternalDocumentation" href="https://techcommunity.microsoft.com/t5/sql-server/getting-started-with-always-encrypted/ba-p/384397">Get started with Always Encrypted (blog post)</related>
20-
<related type="ExternalDocumentation" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
20+
<related type="Article" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Develop apps using Always Encrypted</related>
2121
</Docs>
2222
<Members>
2323
<Member MemberName=".ctor">
@@ -62,7 +62,7 @@
6262
<param name="encryptionAlgorithm">The encryption algorithm.</param>
6363
<param name="encryptedColumnEncryptionKey">The encrypted column encryption key.</param>
6464
<summary>Decrypts the specified encrypted value of a column encryption key. The encrypted value is expected to be encrypted using the column master key with the specified key path and using the specified algorithm.</summary>
65-
<returns>Returns <see cref="T:System.Byte" />.
65+
<returns>Returns <see cref="T:System.Byte" />.
6666
The decrypted column encryption key.</returns>
6767
<remarks>To be added.</remarks>
6868
</Docs>
@@ -92,7 +92,7 @@ The decrypted column encryption key.</returns>
9292
<param name="encryptionAlgorithm">The encryption algorithm.</param>
9393
<param name="columnEncryptionKey">The encrypted column encryption key.</param>
9494
<summary>Encrypts a column encryption key using the column master key with the specified key path and using the specified algorithm.</summary>
95-
<returns>Returns <see cref="T:System.Byte" />.
95+
<returns>Returns <see cref="T:System.Byte" />.
9696
The encrypted column encryption key.</returns>
9797
<remarks>To be added.</remarks>
9898
</Docs>
@@ -123,13 +123,13 @@ The encrypted column encryption key.</returns>
123123
<summary>When implemented in a derived class, digitally signs the column master key metadata with the column master key referenced by the <paramref name="masterKeyPath" /> parameter. The input values used to generate the signature should be the specified values of the <paramref name="masterKeyPath" /> and <paramref name="allowEnclaveComputations" /> parameters.</summary>
124124
<returns>The signature of the column master key metadata.</returns>
125125
<remarks>
126-
<format type="text/markdown"><![CDATA[
127-
128-
## Remarks
129-
To ensure that the <xref:System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider.SignColumnMasterKeyMetadata%2A> method doesn't break applications that rely on an old API, it throws a <xref:System.NotImplementedException> exception by default.
130-
131-
The <xref:System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider.SignColumnMasterKeyMetadata%2A> method will be used by client tools that generate Column Master Keys (CMK) for customers. <xref:System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider.SignColumnMasterKeyMetadata%2A> must be implemented by the corresponding key store providers that wish to use enclaves with [Always Encrypted](https://learn.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine).
132-
126+
<format type="text/markdown"><![CDATA[
127+
128+
## Remarks
129+
To ensure that the <xref:System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider.SignColumnMasterKeyMetadata%2A> method doesn't break applications that rely on an old API, it throws a <xref:System.NotImplementedException> exception by default.
130+
131+
The <xref:System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider.SignColumnMasterKeyMetadata%2A> method will be used by client tools that generate Column Master Keys (CMK) for customers. <xref:System.Data.SqlClient.SqlColumnEncryptionKeyStoreProvider.SignColumnMasterKeyMetadata%2A> must be implemented by the corresponding key store providers that wish to use enclaves with [Always Encrypted](https://learn.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine).
132+
133133
]]></format>
134134
</remarks>
135135
<exception cref="T:System.NotImplementedException">In all cases.</exception>

‎xml/System.Data.SqlClient/SqlCommandColumnEncryptionSetting.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@
1616
<Docs>
1717
<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>
1818
<remarks>
19-
<format type="text/markdown"><![CDATA[
20-
21-
## Remarks
22-
23-
- 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.
24-
25-
- 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.
26-
19+
<format type="text/markdown"><![CDATA[
20+
21+
## Remarks
22+
23+
- 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.
24+
25+
- 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.
26+
2727
]]></format>
2828
</remarks>
2929
<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>
30-
<related type="ExternalDocumentation" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Always Encrypted (client development)</related>
30+
<related type="Article" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Always Encrypted (client development)</related>
3131
</Docs>
3232
<Members>
3333
<Member MemberName="Disabled">

‎xml/System.Data.SqlClient/SqlConnectionColumnEncryptionSetting.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<summary>Specifies that Always Encrypted functionality is enabled in a connection. 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>
1818
<remarks>To be added.</remarks>
1919
<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>
20-
<related type="ExternalDocumentation" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Always Encrypted (client development)</related>
20+
<related type="Article" href="/sql/relational-databases/security/encryption/always-encrypted-client-development">Always Encrypted (client development)</related>
2121
</Docs>
2222
<Members>
2323
<Member MemberName="Disabled">

‎xml/System.Data/DataTable.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6046,7 +6046,7 @@ public class A {
60466046
</remarks>
60476047
<altmember cref="P:System.Data.DataTable.CaseSensitive" />
60486048
<related type="Article" href="/dotnet/framework/data/adonet/dataset-datatable-dataview/datatables">DataTables</related>
6049-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=191549">Null Values</related>
6049+
<related type="Article" href="https://learn.microsoft.com/previous-versions/sql/sql-server-2008-r2/ms191504(v=sql.105)">Null Values</related>
60506050
</Docs>
60516051
</Member>
60526052
<Member MemberName="Select">
@@ -6124,7 +6124,7 @@ To ensure the proper sort order, specify sort criteria with <xref:System.Data.Da
61246124
</remarks>
61256125
<altmember cref="P:System.Data.DataTable.CaseSensitive" />
61266126
<related type="Article" href="/dotnet/framework/data/adonet/dataset-datatable-dataview/datatables">DataTables</related>
6127-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=191549">Null Values</related>
6127+
<related type="Article" href="https://learn.microsoft.com/previous-versions/sql/sql-server-2008-r2/ms191504(v=sql.105)">Null Values</related>
61286128
</Docs>
61296129
</Member>
61306130
<Member MemberName="Select">
@@ -6195,7 +6195,7 @@ To ensure the proper sort order, specify sort criteria with <xref:System.Data.Da
61956195
</remarks>
61966196
<altmember cref="P:System.Data.DataTable.CaseSensitive" />
61976197
<related type="Article" href="/dotnet/framework/data/adonet/dataset-datatable-dataview/datatables">DataTables</related>
6198-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=191549">Null Values</related>
6198+
<related type="Article" href="https://learn.microsoft.com/previous-versions/sql/sql-server-2008-r2/ms191504(v=sql.105)">Null Values</related>
61996199
</Docs>
62006200
</Member>
62016201
<Member MemberName="Select">
@@ -6267,7 +6267,7 @@ To ensure the proper sort order, specify sort criteria with <xref:System.Data.Da
62676267
]]></format>
62686268
</remarks>
62696269
<related type="Article" href="/dotnet/framework/data/adonet/dataset-datatable-dataview/datatables">DataTables</related>
6270-
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=191549">Null Values</related>
6270+
<related type="Article" href="https://learn.microsoft.com/previous-versions/sql/sql-server-2008-r2/ms191504(v=sql.105)">Null Values</related>
62716271
</Docs>
62726272
</Member>
62736273
<Member MemberName="Site">

‎xml/System.Diagnostics.Eventing.Reader/EventLogSession.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -592,8 +592,8 @@
592592
593593
]]></format>
594594
</remarks>
595-
<related type="ExternalDocumentation" href="https://msdn.microsoft.com/library/bb671205.aspx">Technology Summary for Reading and Managing Event Logs</related>
596-
<related type="ExternalDocumentation" href="https://msdn.microsoft.com/library/bb671204.aspx">Event Log Scenarios</related>
595+
<related type="Article" href="https://learn.microsoft.com/previous-versions/bb671205(v=vs.90)">Technology Summary for Reading and Managing Event Logs</related>
596+
<related type="Article" href="https://learn.microsoft.com/previous-versions/bb671204(v=vs.90)">Event Log Scenarios</related>
597597
</Docs>
598598
</Member>
599599
<Member MemberName="ExportLogAndMessages">
@@ -647,8 +647,8 @@
647647
648648
]]></format>
649649
</remarks>
650-
<related type="ExternalDocumentation" href="https://msdn.microsoft.com/library/bb671205.aspx">Technology Summary for Reading and Managing Event Logs</related>
651-
<related type="ExternalDocumentation" href="https://msdn.microsoft.com/library/bb671204.aspx">Event Log Scenarios</related>
650+
<related type="Article" href="https://learn.microsoft.com/previous-versions/bb671205(v=vs.90)">Technology Summary for Reading and Managing Event Logs</related>
651+
<related type="Article" href="https://learn.microsoft.com/previous-versions/bb671204(v=vs.90)">Event Log Scenarios</related>
652652
</Docs>
653653
</Member>
654654
<Member MemberName="GetLogInformation">

0 commit comments

Comments
 (0)