-
Notifications
You must be signed in to change notification settings - Fork 181
/
TopicCredentials.yml
46 lines (46 loc) · 1.55 KB
/
TopicCredentials.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
### YamlMime:TSType
name: TopicCredentials
uid: '@azure/ms-rest-js.TopicCredentials'
package: '@azure/ms-rest-js'
summary: Authenticates to a service using an API key.
fullName: TopicCredentials
remarks: ''
isDeprecated: false
type: class
constructors:
- name: TopicCredentials(string)
uid: '@azure/ms-rest-js.TopicCredentials.constructor'
package: '@azure/ms-rest-js'
summary: Creates a new EventGrid TopicCredentials object.
remarks: ''
isDeprecated: false
syntax:
content: 'new TopicCredentials(topicKey: string)'
parameters:
- id: topicKey
type: string
description: The EventGrid topic key
inheritedMethods:
- name: signRequest(WebResourceLike)
uid: '@azure/ms-rest-js.TopicCredentials.signRequest'
package: '@azure/ms-rest-js'
summary: >-
Signs a request with the values provided in the inHeader and inQuery
parameter.
remarks: ''
isDeprecated: false
syntax:
content: >-
function signRequest(webResource: WebResourceLike):
Promise<WebResourceLike>
parameters:
- id: webResource
type: <xref uid="@azure/ms-rest-js.WebResourceLike" />
description: The WebResource to be signed.
return:
description: The signed request object.
type: Promise<<xref uid="@azure/ms-rest-js.WebResourceLike" />>
inheritanceDescription: >-
<b>Inherited From</b>
[ApiKeyCredentials.signRequest](xref:@azure/ms-rest-js.ApiKeyCredentials.signRequest)
extends: <xref uid="@azure/ms-rest-js.ApiKeyCredentials" />