-
Notifications
You must be signed in to change notification settings - Fork 180
/
Channel.yml
166 lines (161 loc) · 4.88 KB
/
Channel.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
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
### YamlMime:TSType
name: Channel
uid: '@azure/arm-eventgrid.Channel'
package: '@azure/arm-eventgrid'
summary: Channel info.
fullName: Channel
remarks: ''
isDeprecated: false
type: interface
properties:
- name: channelType
uid: '@azure/arm-eventgrid.Channel.channelType'
package: '@azure/arm-eventgrid'
summary: >-
The type of the event channel which represents the direction flow of
events.
fullName: channelType
remarks: ''
isDeprecated: false
syntax:
content: 'channelType?: string'
return:
description: ''
type: string
- name: expirationTimeIfNotActivatedUtc
uid: '@azure/arm-eventgrid.Channel.expirationTimeIfNotActivatedUtc'
package: '@azure/arm-eventgrid'
summary: >-
Expiration time of the channel. If this timer expires while the
corresponding partner topic is never activated,
the channel and corresponding partner topic are deleted.
fullName: expirationTimeIfNotActivatedUtc
remarks: ''
isDeprecated: false
syntax:
content: 'expirationTimeIfNotActivatedUtc?: Date'
return:
description: ''
type: Date
- name: messageForActivation
uid: '@azure/arm-eventgrid.Channel.messageForActivation'
package: '@azure/arm-eventgrid'
summary: >-
Context or helpful message that can be used during the approval process by
the subscriber.
fullName: messageForActivation
remarks: ''
isDeprecated: false
syntax:
content: 'messageForActivation?: string'
return:
description: ''
type: string
- name: partnerTopicInfo
uid: '@azure/arm-eventgrid.Channel.partnerTopicInfo'
package: '@azure/arm-eventgrid'
summary: >-
This property should be populated when channelType is PartnerTopic and
represents information about the partner topic resource corresponding to
the channel.
fullName: partnerTopicInfo
remarks: ''
isDeprecated: false
syntax:
content: 'partnerTopicInfo?: PartnerTopicInfo'
return:
description: ''
type: <xref uid="@azure/arm-eventgrid.PartnerTopicInfo" />
- name: provisioningState
uid: '@azure/arm-eventgrid.Channel.provisioningState'
package: '@azure/arm-eventgrid'
summary: Provisioning state of the channel.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: string'
return:
description: ''
type: string
- name: readinessState
uid: '@azure/arm-eventgrid.Channel.readinessState'
package: '@azure/arm-eventgrid'
summary: The readiness state of the corresponding partner topic.
fullName: readinessState
remarks: ''
isDeprecated: false
syntax:
content: 'readinessState?: string'
return:
description: ''
type: string
- name: systemData
uid: '@azure/arm-eventgrid.Channel.systemData'
package: '@azure/arm-eventgrid'
summary: >-
The system metadata relating to Channel resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: systemData
remarks: ''
isDeprecated: false
syntax:
content: 'systemData?: SystemData'
return:
description: ''
type: <xref uid="@azure/arm-eventgrid.SystemData" />
inheritedProperties:
- name: id
uid: '@azure/arm-eventgrid.Channel.id'
package: '@azure/arm-eventgrid'
summary: >-
Fully qualified identifier of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> [Resource.id](xref:@azure/arm-eventgrid.Resource.id)
- name: name
uid: '@azure/arm-eventgrid.Channel.name'
package: '@azure/arm-eventgrid'
summary: >-
Name of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.name](xref:@azure/arm-eventgrid.Resource.name)
- name: type
uid: '@azure/arm-eventgrid.Channel.type'
package: '@azure/arm-eventgrid'
summary: >-
Type of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Resource.type](xref:@azure/arm-eventgrid.Resource.type)
extends: <xref uid="@azure/arm-eventgrid.Resource" />