-
Notifications
You must be signed in to change notification settings - Fork 181
/
AzureIdentityCredentialAdapter.yml
60 lines (59 loc) · 2.1 KB
/
AzureIdentityCredentialAdapter.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
57
58
59
60
### YamlMime:TSType
name: AzureIdentityCredentialAdapter
uid: '@azure/ms-rest-js.AzureIdentityCredentialAdapter'
package: '@azure/ms-rest-js'
summary: >-
This class provides a simple extension to use <xref:TokenCredential> from
`@azure/identity` library to
use with legacy Azure SDKs that accept
[ServiceClientCredentials](xref:@azure/ms-rest-js.ServiceClientCredentials)
family of credentials for authentication.
fullName: AzureIdentityCredentialAdapter
remarks: ''
isDeprecated: false
type: class
constructors:
- name: AzureIdentityCredentialAdapter(TokenCredential, string | string[])
uid: '@azure/ms-rest-js.AzureIdentityCredentialAdapter.constructor'
package: '@azure/ms-rest-js'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
new AzureIdentityCredentialAdapter(azureTokenCredential:
TokenCredential, scopes?: string | string[])
parameters:
- id: azureTokenCredential
type: <xref uid="@azure/core-auth.TokenCredential" />
description: ''
- id: scopes
type: string | string[]
description: ''
methods:
- name: getToken()
uid: '@azure/ms-rest-js.AzureIdentityCredentialAdapter.getToken'
package: '@azure/ms-rest-js'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function getToken(): Promise<TokenResponse>'
return:
description: ''
type: Promise<<xref uid="@azure/ms-rest-js.TokenResponse" />>
- name: signRequest(WebResource)
uid: '@azure/ms-rest-js.AzureIdentityCredentialAdapter.signRequest'
package: '@azure/ms-rest-js'
summary: Signs a request with the Authentication header.
remarks: ''
isDeprecated: false
syntax:
content: 'function signRequest(webResource: WebResource): Promise<WebResource>'
parameters:
- id: webResource
type: <xref uid="@azure/ms-rest-js.WebResource" />
description: The WebResourceLike/request to be signed.
return:
description: The signed request object;
type: Promise<<xref uid="@azure/ms-rest-js.WebResource" />>