-
Notifications
You must be signed in to change notification settings - Fork 180
/
AzureKeyCredential.yml
56 lines (55 loc) · 1.59 KB
/
AzureKeyCredential.yml
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
### YamlMime:TSType
name: AzureKeyCredential
uid: '@azure/search-documents.AzureKeyCredential'
package: '@azure/search-documents'
summary: |-
A static-key-based credential that supports updating
the underlying key value.
fullName: AzureKeyCredential
remarks: ''
isDeprecated: false
type: class
constructors:
- name: AzureKeyCredential(string)
uid: '@azure/search-documents.AzureKeyCredential.constructor'
package: '@azure/search-documents'
summary: |-
Create an instance of an AzureKeyCredential for use
with a service client.
remarks: ''
isDeprecated: false
syntax:
content: 'new AzureKeyCredential(key: string)'
parameters:
- id: key
type: string
description: The initial value of the key to use in authentication
properties:
- name: key
uid: '@azure/search-documents.AzureKeyCredential.key'
package: '@azure/search-documents'
summary: The value of the key to be used in authentication
fullName: key
remarks: ''
isDeprecated: false
syntax:
content: string key
return:
description: ''
type: string
methods:
- name: update(string)
uid: '@azure/search-documents.AzureKeyCredential.update'
package: '@azure/search-documents'
summary: |-
Change the value of the key.
Updates will take effect upon the next request after
updating the key value.
remarks: ''
isDeprecated: false
syntax:
content: 'function update(newKey: string)'
parameters:
- id: newKey
type: string
description: The new key value to be used