-
Notifications
You must be signed in to change notification settings - Fork 256
/
ApiKeyServiceClientCredentials.xml
73 lines (73 loc) · 4.86 KB
/
ApiKeyServiceClientCredentials.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
<Type Name="ApiKeyServiceClientCredentials" FullName="Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials">
<TypeSignature Language="C#" Value="public class ApiKeyServiceClientCredentials : Microsoft.Rest.ServiceClientCredentials" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ApiKeyServiceClientCredentials extends Microsoft.Rest.ServiceClientCredentials" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials" />
<TypeSignature Language="VB.NET" Value="Public Class ApiKeyServiceClientCredentials
Inherits ServiceClientCredentials" />
<TypeSignature Language="F#" Value="type ApiKeyServiceClientCredentials = class
 inherit ServiceClientCredentials" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.AutoSuggest</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Rest.ServiceClientCredentials</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Allows authentication to the API using a basic apiKey mechanism
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ApiKeyServiceClientCredentials (string subscriptionKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string subscriptionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (subscriptionKey As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials : string -> Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials" Usage="new Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials subscriptionKey" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.AutoSuggest</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="subscriptionKey" Type="System.String" />
</Parameters>
<Docs>
<param name="subscriptionKey">The subscription key to authenticate and authorize as</param>
<summary>
Creates a new instance of the ApiKeyServiceClientCredentails class
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProcessHttpRequestAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task ProcessHttpRequestAsync (System.Net.Http.HttpRequestMessage request, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task ProcessHttpRequestAsync(class System.Net.Http.HttpRequestMessage request, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials.ProcessHttpRequestAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ProcessHttpRequestAsync (request As HttpRequestMessage, cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="override this.ProcessHttpRequestAsync : System.Net.Http.HttpRequestMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="apiKeyServiceClientCredentials.ProcessHttpRequestAsync (request, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.AutoSuggest</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="System.Net.Http.HttpRequestMessage" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="request">The outgoing request</param>
<param name="cancellationToken">A token to cancel the operation</param>
<summary>
Add the Basic Authentication Header to each outgoing request
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>