-
Notifications
You must be signed in to change notification settings - Fork 256
/
KeyVaultKeyIdentifier.xml
295 lines (295 loc) · 17.5 KB
/
KeyVaultKeyIdentifier.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
<Type Name="KeyVaultKeyIdentifier" FullName="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier">
<TypeSignature Language="C#" Value="public readonly struct KeyVaultKeyIdentifier : IEquatable<Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier>" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit KeyVaultKeyIdentifier extends System.ValueType implements class System.IEquatable`1<valuetype Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier>" />
<TypeSignature Language="DocId" Value="T:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier" />
<TypeSignature Language="VB.NET" Value="Public Structure KeyVaultKeyIdentifier
Implements IEquatable(Of KeyVaultKeyIdentifier)" />
<TypeSignature Language="F#" Value="type KeyVaultKeyIdentifier = struct" />
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.3.0.0</AssemblyVersion>
<AssemblyVersion>4.4.0.0</AssemblyVersion>
<AssemblyVersion>4.5.0.0</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable<Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Information about a <see cref="T:Azure.Security.KeyVault.Keys.KeyVaultKey" /> parsed from a <see cref="T:System.Uri" />.
You can use this information when calling methods of a <see cref="T:Azure.Security.KeyVault.Keys.KeyClient" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public KeyVaultKeyIdentifier (Uri id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri id) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.#ctor(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As Uri)" />
<MemberSignature Language="F#" Value="new Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier : Uri -> Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier" Usage="new Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier id" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.Uri" />
</Parameters>
<Docs>
<param name="id">The <see cref="T:System.Uri" /> to a key or deleted key.</param>
<summary>
Creates a new instance of the <see cref="T:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier" /> class.
</summary>
<remarks>
Successfully parsing the given <see cref="T:System.Uri" /> does not guarantee that the <paramref name="id" /> is a valid Key Vault or Managed HSM key identifier:
only that it contains the necessary number of path parts that look like a Key Vault key identifier. If the <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.VaultUri" /> references
a valid Key Vault or Managed HSM, the service will return an error if the <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Name" /> and <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Version" /> do not specify a valid key.
</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="id" /> is not a valid Key Vault or Managed HSM key ID.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="id" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier other) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Equals(Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier)" />
<MemberSignature Language="VB.NET" Value="Public Function Equals (other As KeyVaultKeyIdentifier) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier -> bool" Usage="keyVaultKeyIdentifier.Equals other" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier" />
</Parameters>
<Docs>
<param name="other">An object to compare with this object.</param>
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="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:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.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="keyVaultKeyIdentifier.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The object to compare with the current instance.</param>
<summary>Indicates whether this instance and a specified object are equal.</summary>
<returns>
<see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</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:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="keyVaultKeyIdentifier.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the hash code for this instance.</summary>
<returns>A 32-bit signed integer that is the hash code for this instance.</returns>
<remarks>To be added.</remarks>
</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:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the key.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SourceId">
<MemberSignature Language="C#" Value="public Uri SourceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri SourceId" />
<MemberSignature Language="DocId" Value="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.SourceId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SourceId As Uri" />
<MemberSignature Language="F#" Value="member this.SourceId : Uri" Usage="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.SourceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the source <see cref="T:System.Uri" /> passed to <see cref="M:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.#ctor(System.Uri)" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="keyVaultKeyIdentifier.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the fully qualified type name of this instance.</summary>
<returns>The fully qualified type name.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryCreate">
<MemberSignature Language="C#" Value="public static bool TryCreate (Uri id, out Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier identifier);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryCreate(class System.Uri id, [out] valuetype Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier& identifier) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.TryCreate(System.Uri,Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier@)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryCreate (id As Uri, ByRef identifier As KeyVaultKeyIdentifier) As Boolean" />
<MemberSignature Language="F#" Value="static member TryCreate : Uri * KeyVaultKeyIdentifier -> bool" Usage="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.TryCreate (id, identifier)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Uri" />
<Parameter Name="identifier" Type="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier" RefType="out" />
</Parameters>
<Docs>
<param name="id">A <see cref="T:System.Uri" /> to a Key Vault or Managed HSM key with or without a version.</param>
<param name="identifier">A <see cref="T:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier" /> from the given <paramref name="id" /> if valid; otherwise, an empty structure if invalid.</param>
<summary>
Tries to create a new instance of the <see cref="T:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier" /> from the given <paramref name="id" />.
</summary>
<returns>True if the <see cref="T:System.Uri" /> contains a <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.VaultUri" />, <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Name" />, and optional <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Version" />; otherwise, false.</returns>
<remarks>
Successfully parsing the given <see cref="T:System.Uri" /> does not guarantee that the <paramref name="id" /> is a valid Key Vault or Managed HSM key identifier:
only that it contains the necessary number of path parts that look like a Key Vault key identifier. If the <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.VaultUri" /> references
a valid Key Vault or Managed HSM, the service will return an error if the <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Name" /> and <see cref="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Version" /> do not specify a valid key.
</remarks>
</Docs>
</Member>
<Member MemberName="VaultUri">
<MemberSignature Language="C#" Value="public Uri VaultUri { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri VaultUri" />
<MemberSignature Language="DocId" Value="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.VaultUri" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property VaultUri As Uri" />
<MemberSignature Language="F#" Value="member this.VaultUri : Uri" Usage="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.VaultUri" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:System.Uri" /> of the Key Vault or Managed HSM.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public string Version { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Version" />
<MemberSignature Language="DocId" Value="P:Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Version" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Version As String" />
<MemberSignature Language="F#" Value="member this.Version : string" Usage="Azure.Security.KeyVault.Keys.KeyVaultKeyIdentifier.Version" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Security.KeyVault.Keys</AssemblyName>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the optional version of the key.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>