-
Notifications
You must be signed in to change notification settings - Fork 256
/
SearchCredentials.xml
103 lines (103 loc) · 6.13 KB
/
SearchCredentials.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
<Type Name="SearchCredentials" FullName="Microsoft.Azure.Search.SearchCredentials">
<TypeSignature Language="C#" Value="public class SearchCredentials : Microsoft.Rest.ServiceClientCredentials" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SearchCredentials extends Microsoft.Rest.ServiceClientCredentials" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.SearchCredentials" />
<TypeSignature Language="VB.NET" Value="Public Class SearchCredentials
Inherits ServiceClientCredentials" />
<TypeSignature Language="F#" Value="type SearchCredentials = class
 inherit ServiceClientCredentials" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Rest.ServiceClientCredentials</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Credentials used to authenticate to a search service.
<see href="https://docs.microsoft.com/rest/api/searchservice/" /></summary>
<remarks>
See <see href="https://docs.microsoft.com/azure/search/search-security-api-keys" /> for more information about API keys in Azure Cognitive Search.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchCredentials (string apiKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string apiKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.SearchCredentials.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (apiKey As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.SearchCredentials : string -> Microsoft.Azure.Search.SearchCredentials" Usage="new Microsoft.Azure.Search.SearchCredentials apiKey" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="apiKey" Type="System.String" />
</Parameters>
<Docs>
<param name="apiKey">api-key used to authenticate to the search service.</param>
<summary>
Initializes a new instance of the SearchCredentials class with a query key or an admin key. Use a query
key if your application does not require write access to the Search Service or index.
</summary>
<remarks>
If your application performs only query operations on an index, we recommend passing a query key for the
<paramref name="apiKey" /> parameter. This ensures that you have read-only access to the index, which is
consistent with the principle of least privilege.
</remarks>
</Docs>
</Member>
<Member MemberName="ApiKey">
<MemberSignature Language="C#" Value="public string ApiKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ApiKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.SearchCredentials.ApiKey" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ApiKey As String" />
<MemberSignature Language="F#" Value="member this.ApiKey : string" Usage="Microsoft.Azure.Search.SearchCredentials.ApiKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
api-key used to authenticate to a search service. Can be either a query key for querying only, or
an admin key that enables index and document management as well.
</summary>
<value>To be added.</value>
<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.Search.SearchCredentials.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="searchCredentials.ProcessHttpRequestAsync (request, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.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">HTTP request</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Adds the credentials to the given HTTP request.
</summary>
<returns>A Task to track the progress of the async operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>