-
Notifications
You must be signed in to change notification settings - Fork 255
/
AzureKeyCredential.xml
140 lines (140 loc) · 6.49 KB
/
AzureKeyCredential.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
<Type Name="AzureKeyCredential" FullName="Azure.AzureKeyCredential">
<TypeSignature Language="C#" Value="public class AzureKeyCredential" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AzureKeyCredential extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AzureKeyCredential" />
<TypeSignature Language="VB.NET" Value="Public Class AzureKeyCredential" />
<TypeSignature Language="F#" Value="type AzureKeyCredential = class" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Key credential used to authenticate to an Azure Service.
It provides the ability to update the key without creating a new client.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AzureKeyCredential (string key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string key) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AzureKeyCredential.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (key As String)" />
<MemberSignature Language="F#" Value="new Azure.AzureKeyCredential : string -> Azure.AzureKeyCredential" Usage="new Azure.AzureKeyCredential key" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">Key to use to authenticate with the Azure service.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AzureKeyCredential" /> class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="key" /> is null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="key" /> is empty.
</exception>
</Docs>
</Member>
<Member MemberName="Key">
<MemberSignature Language="C#" Value="public string Key { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Key" />
<MemberSignature Language="DocId" Value="P:Azure.AzureKeyCredential.Key" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Key As String" />
<MemberSignature Language="F#" Value="member this.Key : string" Usage="Azure.AzureKeyCredential.Key" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.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>
<Docs>
<summary>
Key used to authenticate to an Azure service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Update">
<MemberSignature Language="C#" Value="public void Update (string key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Update(string key) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AzureKeyCredential.Update(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Update (key As String)" />
<MemberSignature Language="F#" Value="member this.Update : string -> unit" Usage="azureKeyCredential.Update key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">Key to authenticate the service against.</param>
<summary>
Updates the service key.
This is intended to be used when you've regenerated your service key
and want to update long lived clients.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="key" /> is null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="key" /> is empty.
</exception>
</Docs>
</Member>
</Members>
</Type>