-
Notifications
You must be signed in to change notification settings - Fork 257
/
IKeyEncryptionKey.xml
190 lines (190 loc) · 12.3 KB
/
IKeyEncryptionKey.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
<Type Name="IKeyEncryptionKey" FullName="Azure.Core.Cryptography.IKeyEncryptionKey">
<TypeSignature Language="C#" Value="public interface IKeyEncryptionKey" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IKeyEncryptionKey" />
<TypeSignature Language="DocId" Value="T:Azure.Core.Cryptography.IKeyEncryptionKey" />
<TypeSignature Language="VB.NET" Value="Public Interface IKeyEncryptionKey" />
<TypeSignature Language="F#" Value="type IKeyEncryptionKey = interface" />
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.15.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.20.0.0</AssemblyVersion>
<AssemblyVersion>1.21.0.0</AssemblyVersion>
<AssemblyVersion>1.22.0.0</AssemblyVersion>
<AssemblyVersion>1.23.0.0</AssemblyVersion>
<AssemblyVersion>1.24.0.0</AssemblyVersion>
<AssemblyVersion>1.25.0.0</AssemblyVersion>
<AssemblyVersion>1.26.0.0</AssemblyVersion>
<AssemblyVersion>1.27.0.0</AssemblyVersion>
<AssemblyVersion>1.28.0.0</AssemblyVersion>
<AssemblyVersion>1.29.0.0</AssemblyVersion>
<AssemblyVersion>1.30.0.0</AssemblyVersion>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
A key which is used to encrypt, or wrap, another key.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="KeyId">
<MemberSignature Language="C#" Value="public string KeyId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string KeyId" />
<MemberSignature Language="DocId" Value="P:Azure.Core.Cryptography.IKeyEncryptionKey.KeyId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property KeyId As String" />
<MemberSignature Language="F#" Value="member this.KeyId : string" Usage="Azure.Core.Cryptography.IKeyEncryptionKey.KeyId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The Id of the key used to perform cryptographic operations for the client.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnwrapKey">
<MemberSignature Language="C#" Value="public byte[] UnwrapKey (string algorithm, ReadOnlyMemory<byte> encryptedKey, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance unsigned int8[] UnwrapKey(string algorithm, valuetype System.ReadOnlyMemory`1<unsigned int8> encryptedKey, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Cryptography.IKeyEncryptionKey.UnwrapKey(System.String,System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function UnwrapKey (algorithm As String, encryptedKey As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As Byte()" />
<MemberSignature Language="F#" Value="abstract member UnwrapKey : string * ReadOnlyMemory<byte> * System.Threading.CancellationToken -> byte[]" Usage="iKeyEncryptionKey.UnwrapKey (algorithm, encryptedKey, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="algorithm" Type="System.String" />
<Parameter Name="encryptedKey" Type="System.ReadOnlyMemory<System.Byte>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="algorithm">The key wrap algorithm which was used to encrypt the specified encrypted key.</param>
<param name="encryptedKey">The encrypted key to be decrypted.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Decrypts the specified encrypted key using the specified algorithm.
</summary>
<returns>The decrypted key bytes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnwrapKeyAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<byte[]> UnwrapKeyAsync (string algorithm, ReadOnlyMemory<byte> encryptedKey, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<unsigned int8[]> UnwrapKeyAsync(string algorithm, valuetype System.ReadOnlyMemory`1<unsigned int8> encryptedKey, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Cryptography.IKeyEncryptionKey.UnwrapKeyAsync(System.String,System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function UnwrapKeyAsync (algorithm As String, encryptedKey As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Byte())" />
<MemberSignature Language="F#" Value="abstract member UnwrapKeyAsync : string * ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>" Usage="iKeyEncryptionKey.UnwrapKeyAsync (algorithm, encryptedKey, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Byte[]></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="algorithm" Type="System.String" />
<Parameter Name="encryptedKey" Type="System.ReadOnlyMemory<System.Byte>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="algorithm">The key wrap algorithm which was used to encrypt the specified encrypted key.</param>
<param name="encryptedKey">The encrypted key to be decrypted.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Decrypts the specified encrypted key using the specified algorithm.
</summary>
<returns>The decrypted key bytes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WrapKey">
<MemberSignature Language="C#" Value="public byte[] WrapKey (string algorithm, ReadOnlyMemory<byte> key, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance unsigned int8[] WrapKey(string algorithm, valuetype System.ReadOnlyMemory`1<unsigned int8> key, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Cryptography.IKeyEncryptionKey.WrapKey(System.String,System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function WrapKey (algorithm As String, key As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As Byte()" />
<MemberSignature Language="F#" Value="abstract member WrapKey : string * ReadOnlyMemory<byte> * System.Threading.CancellationToken -> byte[]" Usage="iKeyEncryptionKey.WrapKey (algorithm, key, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="algorithm" Type="System.String" />
<Parameter Name="key" Type="System.ReadOnlyMemory<System.Byte>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="algorithm">The key wrap algorithm used to encrypt the specified key.</param>
<param name="key">The key to be encrypted.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Encrypts the specified key using the specified algorithm.
</summary>
<returns>The encrypted key bytes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WrapKeyAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<byte[]> WrapKeyAsync (string algorithm, ReadOnlyMemory<byte> key, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<unsigned int8[]> WrapKeyAsync(string algorithm, valuetype System.ReadOnlyMemory`1<unsigned int8> key, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Cryptography.IKeyEncryptionKey.WrapKeyAsync(System.String,System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function WrapKeyAsync (algorithm As String, key As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Byte())" />
<MemberSignature Language="F#" Value="abstract member WrapKeyAsync : string * ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>" Usage="iKeyEncryptionKey.WrapKeyAsync (algorithm, key, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Byte[]></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="algorithm" Type="System.String" />
<Parameter Name="key" Type="System.ReadOnlyMemory<System.Byte>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="algorithm">The key wrap algorithm used to encrypt the specified key.</param>
<param name="key">The key to be encrypted.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Encrypts the specified key using the specified algorithm.
</summary>
<returns>The encrypted key bytes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>