你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

StreamingJob interface

一个流式处理作业对象,包含与命名流式处理作业关联的所有信息。

扩展

属性

cluster

将运行流式处理作业的群集。

compatibilityLevel

控制流式处理作业的某些运行时行为。

contentStoragePolicy

有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则要求用户同时指定 jobStorageAccount 属性。 .

createdDate

值是 ISO-8601 格式的 UTC 时间戳,指示创建流式处理作业的时间。 注意:此属性不会被序列化。 它只能由服务器填充。

dataLocale

流分析作业的数据区域设置。 值应为集 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支持的 .NET 区域性的名称。 如果未指定,则默认为“en-US”。

etag

流式处理作业的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行写入操作,实现乐观并发。 注意:此属性不会被序列化。 它只能由服务器填充。

eventsLateArrivalMaxDelayInSeconds

可容忍的最大延迟(以秒为单位),其中可能包括迟到事件。 支持的范围为 -1 到 1814399(20.23:59:59 天),-1 用于指定无限期等待。 如果该属性不存在,则将其解释为具有值 -1。

eventsOutOfOrderMaxDelayInSeconds

可容许的最大延迟(以秒为单位),其中无序事件可重新调整为有序事件。

eventsOutOfOrderPolicy

指示要应用于输入事件流中未按顺序到达的事件的策略。

functions

流式处理作业的一个或多个函数的列表。 在 PUT 请求中指定此属性时,需要每个函数的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。

identity

介绍分配给此作业的系统分配托管标识,该标识可用于通过输入和输出进行身份验证。

inputs

流式处理作业的一个或多个输入的列表。 在 PUT 请求中指定此属性时,需要每个输入的名称属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输入的 PATCH API。

jobId

唯一标识流式处理作业的 GUID。 此 GUID 是在创建流式处理作业时生成的。 注意:此属性不会被序列化。 它只能由服务器填充。

jobState

描述流式处理作业的状态。 注意:此属性不会被序列化。 它只能由服务器填充。

jobStorageAccount

与具有 MSI 的 Azure 存储帐户关联的属性

jobType

描述作业的类型。 有效模式为 Cloud 和 “Edge”。

lastOutputEventTime

值为 ISO-8601 格式的时间戳,指示流式处理作业的最后一个输出事件时间,或 null,表示尚未生成输出。 如果有多个输出或多个流,则显示该集中的最新值。 注意:此属性不会被序列化。 它只能由服务器填充。

outputErrorPolicy

指示要应用于到达输出但由于格式错误(缺少列值、列值类型或大小错误)而无法写入外部存储的事件的策略。

outputs

流式处理作业的一个或多个输出的列表。 在 PUT 请求中指定此属性时,需要每个输出的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输出的 PATCH API。

outputStartMode

仅当需要作业在创建时立即启动时才应使用此属性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指示输出事件流的起点应在作业每次启动时启动、从通过 outputStartTime 属性指定的自定义用户时间戳开始,还是从上次事件输出时间开始。

outputStartTime

值为采用 ISO-8601 格式的时间戳(指示输出事件流的起点),或者为 null(指示输出事件流将在每次启动流式处理作业时开始)。 如果 outputStartMode 设置为 CustomTime,则此属性必须具有值。

provisioningState

描述流式处理作业的预配状态。 注意:此属性不会被序列化。 它只能由服务器填充。

sku

描述流式处理作业的 SKU。 在 PUT (CreateOrReplace) 请求上是必需的。

transformation

指示用于流式处理作业的查询和流单元数。 在 PUT 请求中指定此属性时,需要转换的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。

继承属性

id

资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此属性不会被序列化。 它只能由服务器填充。

location

资源所在的地理位置

name

资源的名称 注意:此属性不会被序列化。 它只能由服务器填充。

tags

资源标记。

type

资源类型。 Ex-Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。 注意:此属性不会被序列化。 它只能由服务器填充。

属性详细信息

cluster

将运行流式处理作业的群集。

cluster?: ClusterInfo

属性值

compatibilityLevel

控制流式处理作业的某些运行时行为。

compatibilityLevel?: string

属性值

string

contentStoragePolicy

有效值为 JobStorageAccount 和 SystemAccount。 如果设置为 JobStorageAccount,则要求用户同时指定 jobStorageAccount 属性。 .

contentStoragePolicy?: string

属性值

string

createdDate

值是 ISO-8601 格式的 UTC 时间戳,指示创建流式处理作业的时间。 注意:此属性不会被序列化。 它只能由服务器填充。

createdDate?: Date

属性值

Date

dataLocale

流分析作业的数据区域设置。 值应为集 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支持的 .NET 区域性的名称。 如果未指定,则默认为“en-US”。

dataLocale?: string

属性值

string

etag

流式处理作业的当前实体标记。 这是一个不透明的字符串。 可以使用它来检测资源是否在请求之间发生了更改。 还可以在 If-Match 或 If-None-Match 标头中使用它进行写入操作,实现乐观并发。 注意:此属性不会被序列化。 它只能由服务器填充。

etag?: string

属性值

string

eventsLateArrivalMaxDelayInSeconds

可容忍的最大延迟(以秒为单位),其中可能包括迟到事件。 支持的范围为 -1 到 1814399(20.23:59:59 天),-1 用于指定无限期等待。 如果该属性不存在,则将其解释为具有值 -1。

eventsLateArrivalMaxDelayInSeconds?: number

属性值

number

eventsOutOfOrderMaxDelayInSeconds

可容许的最大延迟(以秒为单位),其中无序事件可重新调整为有序事件。

eventsOutOfOrderMaxDelayInSeconds?: number

属性值

number

eventsOutOfOrderPolicy

指示要应用于输入事件流中未按顺序到达的事件的策略。

eventsOutOfOrderPolicy?: string

属性值

string

functions

流式处理作业的一个或多个函数的列表。 在 PUT 请求中指定此属性时,需要每个函数的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。

functions?: FunctionModel[]

属性值

identity

介绍分配给此作业的系统分配托管标识,该标识可用于通过输入和输出进行身份验证。

identity?: Identity

属性值

inputs

流式处理作业的一个或多个输入的列表。 在 PUT 请求中指定此属性时,需要每个输入的名称属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输入的 PATCH API。

inputs?: Input[]

属性值

Input[]

jobId

唯一标识流式处理作业的 GUID。 此 GUID 是在创建流式处理作业时生成的。 注意:此属性不会被序列化。 它只能由服务器填充。

jobId?: string

属性值

string

jobState

描述流式处理作业的状态。 注意:此属性不会被序列化。 它只能由服务器填充。

jobState?: string

属性值

string

jobStorageAccount

与具有 MSI 的 Azure 存储帐户关联的属性

jobStorageAccount?: JobStorageAccount

属性值

jobType

描述作业的类型。 有效模式为 Cloud 和 “Edge”。

jobType?: string

属性值

string

lastOutputEventTime

值为 ISO-8601 格式的时间戳,指示流式处理作业的最后一个输出事件时间,或 null,表示尚未生成输出。 如果有多个输出或多个流,则显示该集中的最新值。 注意:此属性不会被序列化。 它只能由服务器填充。

lastOutputEventTime?: Date

属性值

Date

outputErrorPolicy

指示要应用于到达输出但由于格式错误(缺少列值、列值类型或大小错误)而无法写入外部存储的事件的策略。

outputErrorPolicy?: string

属性值

string

outputs

流式处理作业的一个或多个输出的列表。 在 PUT 请求中指定此属性时,需要每个输出的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个输出的 PATCH API。

outputs?: Output[]

属性值

Output[]

outputStartMode

仅当需要作业在创建时立即启动时才应使用此属性。 值可以是 JobStartTime、CustomTime 或 LastOutputEventTime,以指示输出事件流的起点应在作业每次启动时启动、从通过 outputStartTime 属性指定的自定义用户时间戳开始,还是从上次事件输出时间开始。

outputStartMode?: string

属性值

string

outputStartTime

值为采用 ISO-8601 格式的时间戳(指示输出事件流的起点),或者为 null(指示输出事件流将在每次启动流式处理作业时开始)。 如果 outputStartMode 设置为 CustomTime,则此属性必须具有值。

outputStartTime?: Date

属性值

Date

provisioningState

描述流式处理作业的预配状态。 注意:此属性不会被序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

sku

描述流式处理作业的 SKU。 在 PUT (CreateOrReplace) 请求上是必需的。

sku?: Sku

属性值

Sku

transformation

指示用于流式处理作业的查询和流单元数。 在 PUT 请求中指定此属性时,需要转换的 name 属性。 无法通过 PATCH 操作修改此属性。 必须使用可用于单个转换的 PATCH API。

transformation?: Transformation

属性值

继承属性详细信息

id

资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自TrackedResource.id

location

资源所在的地理位置

location?: string

属性值

string

继承自TrackedResource.location

name

资源的名称 注意:此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自TrackedResource.name

tags

资源标记。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自TrackedResource.tags

type

资源类型。 Ex-Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。 注意:此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自TrackedResource.type