-
Notifications
You must be signed in to change notification settings - Fork 256
/
EncryptionKeyWrapMetadata.xml
278 lines (278 loc) · 15.6 KB
/
EncryptionKeyWrapMetadata.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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<Type Name="EncryptionKeyWrapMetadata" FullName="Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata">
<TypeSignature Language="C#" Value="public class EncryptionKeyWrapMetadata : IEquatable<Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EncryptionKeyWrapMetadata extends System.Object implements class System.IEquatable`1<class Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata" />
<TypeSignature Language="VB.NET" Value="Public Class EncryptionKeyWrapMetadata
Implements IEquatable(Of EncryptionKeyWrapMetadata)" />
<TypeSignature Language="F#" Value="type EncryptionKeyWrapMetadata = class
 interface IEquatable<EncryptionKeyWrapMetadata>" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable<Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key.
See https://aka.ms/CosmosClientEncryption for more information on client-side encryption support in Azure Cosmos DB.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EncryptionKeyWrapMetadata (Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata source);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata source) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.#ctor(Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (source As EncryptionKeyWrapMetadata)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata : Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata -> Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata" Usage="new Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata source" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="source" Type="Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata" />
</Parameters>
<Docs>
<param name="source">Existing instance from which to initialize.</param>
<summary>
Creates a new instance of key wrap metadata based on an existing instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EncryptionKeyWrapMetadata (string type, string name, string value, string algorithm);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string type, string name, string value, string algorithm) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.#ctor(System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (type As String, name As String, value As String, algorithm As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata : string * string * string * string -> Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata" Usage="new Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata (type, name, value, algorithm)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="type" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.String" />
<Parameter Name="algorithm" Type="System.String" />
</Parameters>
<Docs>
<param name="type">Identifier for the key resolver.</param>
<param name="name">Identifier for the customer managed key.</param>
<param name="value">Path to the customer managed key.</param>
<param name="algorithm">Algorithm used in wrapping and unwrapping of the data encryption key.</param>
<summary>
Creates a new instance of key wrap metadata.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Algorithm">
<MemberSignature Language="C#" Value="public string Algorithm { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Algorithm" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Algorithm" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Algorithm As String" />
<MemberSignature Language="F#" Value="member this.Algorithm : string" Usage="Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Algorithm" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="algorithm")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="algorithm")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Serialized form of metadata.
Note: This value is saved in the Cosmos DB service.
Implementors of derived implementations should ensure that this does not have (private) key material or credential information.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Equals(Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata)" />
<MemberSignature Language="VB.NET" Value="Public Function Equals (other As EncryptionKeyWrapMetadata) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata -> bool" Usage="encryptionKeyWrapMetadata.Equals other" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata" />
</Parameters>
<Docs>
<param name="other">Key wrap metadata to be compared with current instance.</param>
<summary>
Returns whether the properties of the passed in key wrap metadata matches with those in the current instance.
</summary>
<returns>
True if the properties of the key wrap metadata passed in matches with those in the current instance, else false.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="encryptionKeyWrapMetadata.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="encryptionKeyWrapMetadata.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="name")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="name")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Serialized form of metadata.
Note: This value is saved in the Cosmos DB service.
Implementors of derived implementations should ensure that this does not have (private) key material or credential information.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public string Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Type" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Type As String" />
<MemberSignature Language="F#" Value="member this.Type : string" Usage="Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="type")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="type")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Serialized form of metadata.
Note: This value is saved in the Cosmos DB service.
Implementors of derived implementations should ensure that this does not have (private) key material or credential information.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public string Value { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Value" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Value" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Value As String" />
<MemberSignature Language="F#" Value="member this.Value : string" Usage="Microsoft.Azure.Cosmos.EncryptionKeyWrapMetadata.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="value")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="value")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Serialized form of metadata.
Note: This value is saved in the Cosmos DB service.
Implementors of derived implementations should ensure that this does not have (private) key material or credential information.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>