-
Notifications
You must be signed in to change notification settings - Fork 255
/
LivePipelineUpdate.xml
265 lines (265 loc) · 17.4 KB
/
LivePipelineUpdate.xml
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<Type Name="LivePipelineUpdate" FullName="Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate">
<TypeSignature Language="C#" Value="public class LivePipelineUpdate : Microsoft.Azure.Management.VideoAnalyzer.Models.ProxyResource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LivePipelineUpdate extends Microsoft.Azure.Management.VideoAnalyzer.Models.ProxyResource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate" />
<TypeSignature Language="VB.NET" Value="Public Class LivePipelineUpdate
Inherits ProxyResource" />
<TypeSignature Language="F#" Value="type LivePipelineUpdate = class
 inherit ProxyResource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Management.VideoAnalyzer.Models.ProxyResource</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Microsoft.Rest.Serialization.JsonTransformation]</AttributeName>
<AttributeName Language="F#">[<Microsoft.Rest.Serialization.JsonTransformation>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Live pipeline represents a unique instance of a live topology, used for
real-time ingestion, archiving and publishing of content for a unique
RTSP camera.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LivePipelineUpdate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the LivePipelineUpdate class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LivePipelineUpdate (string id = default, string name = default, string type = default, Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData systemData = default, string topologyName = default, string description = default, int? bitrateKbps = default, Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState state = default, System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> parameters = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string name, string type, class Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData systemData, string topologyName, string description, valuetype System.Nullable`1<int32> bitrateKbps, valuetype Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState state, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.#ctor(System.String,System.String,System.String,Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData,System.String,System.String,System.Nullable{System.Int32},Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState,System.Collections.Generic.IList{Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional systemData As SystemData = Nothing, Optional topologyName As String = Nothing, Optional description As String = Nothing, Optional bitrateKbps As Nullable(Of Integer) = Nothing, Optional state As LivePipelineState = Nothing, Optional parameters As IList(Of ParameterDefinition) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate : string * string * string * Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData * string * string * Nullable<int> * Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState * System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> -> Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate" Usage="new Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate (id, name, type, systemData, topologyName, description, bitrateKbps, state, parameters)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="type" Type="System.String" />
<Parameter Name="systemData" Type="Microsoft.Azure.Management.VideoAnalyzer.Models.SystemData" />
<Parameter Name="topologyName" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="bitrateKbps" Type="System.Nullable<System.Int32>" />
<Parameter Name="state" Type="Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState" />
<Parameter Name="parameters" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition>" />
</Parameters>
<Docs>
<param name="id">Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}</param>
<param name="name">The name of the resource</param>
<param name="type">The type of the resource. E.g.
"Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts"</param>
<param name="systemData">Azure Resource Manager metadata containing
createdBy and modifiedBy information.</param>
<param name="topologyName">The reference to an existing pipeline
topology defined for real-time content processing. When activated,
this live pipeline will process content according to the pipeline
topology definition.</param>
<param name="description">An optional description for the
pipeline.</param>
<param name="bitrateKbps">Maximum bitrate capacity in Kbps reserved
for the live pipeline. The allowed range is from 500 to 3000 Kbps
in increments of 100 Kbps. If the RTSP camera exceeds this
capacity, then the service will disconnect temporarily from the
camera. It will retry to re-establish connection (with exponential
backoff), checking to see if the camera bitrate is now below the
reserved capacity. Doing so will ensure that one 'noisy neighbor'
does not affect other live pipelines in your account.</param>
<param name="state">Current state of the pipeline (read-only).
Possible values include: 'Inactive', 'Activating', 'Active',
'Deactivating'</param>
<param name="parameters">List of the instance level parameter
values for the user-defined topology parameters. A pipeline can
only define or override parameters values for parameters which have
been declared in the referenced topology. Topology parameters
without a default value must be defined. Topology parameters with a
default value can be optionally be overridden.</param>
<summary>
Initializes a new instance of the LivePipelineUpdate class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BitrateKbps">
<MemberSignature Language="C#" Value="public int? BitrateKbps { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> BitrateKbps" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.BitrateKbps" />
<MemberSignature Language="VB.NET" Value="Public Property BitrateKbps As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.BitrateKbps : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.BitrateKbps" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.bitrateKbps")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.bitrateKbps")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets maximum bitrate capacity in Kbps reserved for the live
pipeline. The allowed range is from 500 to 3000 Kbps in increments
of 100 Kbps. If the RTSP camera exceeds this capacity, then the
service will disconnect temporarily from the camera. It will retry
to re-establish connection (with exponential backoff), checking to
see if the camera bitrate is now below the reserved capacity. Doing
so will ensure that one 'noisy neighbor' does not affect other live
pipelines in your account.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.Description" />
<MemberSignature Language="VB.NET" Value="Public Property Description As String" />
<MemberSignature Language="F#" Value="member this.Description : string with get, set" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.Description" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.description")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.description")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets an optional description for the pipeline.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> Parameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> Parameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.Parameters" />
<MemberSignature Language="VB.NET" Value="Public Property Parameters As IList(Of ParameterDefinition)" />
<MemberSignature Language="F#" Value="member this.Parameters : System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition> with get, set" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.Parameters" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.parameters")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.parameters")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.VideoAnalyzer.Models.ParameterDefinition></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets list of the instance level parameter values for the
user-defined topology parameters. A pipeline can only define or
override parameters values for parameters which have been declared
in the referenced topology. Topology parameters without a default
value must be defined. Topology parameters with a default value can
be optionally be overridden.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As LivePipelineState" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.state")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.state")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineState</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets current state of the pipeline (read-only). Possible values
include: 'Inactive', 'Activating', 'Active', 'Deactivating'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TopologyName">
<MemberSignature Language="C#" Value="public string TopologyName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TopologyName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.TopologyName" />
<MemberSignature Language="VB.NET" Value="Public Property TopologyName As String" />
<MemberSignature Language="F#" Value="member this.TopologyName : string with get, set" Usage="Microsoft.Azure.Management.VideoAnalyzer.Models.LivePipelineUpdate.TopologyName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.VideoAnalyzer</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="properties.topologyName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="properties.topologyName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the reference to an existing pipeline topology defined
for real-time content processing. When activated, this live
pipeline will process content according to the pipeline topology
definition.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>