-
Notifications
You must be signed in to change notification settings - Fork 240
/
azure.eventgrid.yml
49 lines (41 loc) · 1.4 KB
/
azure.eventgrid.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
### YamlMime:PythonPackage
uid: azure.eventgrid
name: eventgrid
fullName: azure.eventgrid
type: rootImport
functions:
- uid: azure.eventgrid.generate_sas
name: generate_sas
summary: 'Helper method to generate shared access signature given hostname, key,
and expiration date.
:param str endpoint: The topic endpoint to send the events to.
Similar to <YOUR-TOPIC-NAME>.<YOUR-REGION-NAME>-1.eventgrid.azure.net
:param str shared_access_key: The shared access key to be used for generating
the token
:param datetime.datetime expiration_date_utc: The expiration datetime in UTC for
the signature.
:keyword str api_version: The API Version to include in the signature.
If not provided, the default API version will be used.
:return: A shared access signature string.
:rtype: str'
signature: 'generate_sas(endpoint: str, shared_access_key: str, expiration_date_utc:
datetime, *, api_version: str = ''2018-01-01'') -> str'
parameters:
- name: endpoint
isRequired: true
- name: shared_access_key
isRequired: true
- name: expiration_date_utc
isRequired: true
keywordOnlyParameters:
- name: api_version
defaultValue: '2018-01-01'
classes:
- azure.eventgrid.EventGridConsumerClient
- azure.eventgrid.EventGridEvent
- azure.eventgrid.EventGridPublisherClient
packages:
- azure.eventgrid.aio
- azure.eventgrid.models
enums:
- azure.eventgrid.SystemEventNames