Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StreamingJobs

Package version

Class representing a StreamingJobs.

Hierarchy

  • StreamingJobs

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrReplace

  • beginCreateOrReplace(streamingJob: StreamingJob, resourceGroupName: string, jobName: string, options?: Models.StreamingJobsBeginCreateOrReplaceOptionalParams): Promise<msRestAzure.LROPoller>

  • Creates a streaming job or replaces an already existing streaming job.

    Parameters

    • streamingJob: StreamingJob

      The definition of the streaming job that will be used to create a new streaming job or replace the existing one.

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: Models.StreamingJobsBeginCreateOrReplaceOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes a streaming job.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginStart

  • beginStart(resourceGroupName: string, jobName: string, options?: Models.StreamingJobsBeginStartOptionalParams): Promise<msRestAzure.LROPoller>

  • Starts a streaming job. Once a job is started it will start processing input events and produce output.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: Models.StreamingJobsBeginStartOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginStop

  • beginStop(resourceGroupName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrReplace

  • createOrReplace(streamingJob: StreamingJob, resourceGroupName: string, jobName: string, options?: Models.StreamingJobsCreateOrReplaceOptionalParams): Promise<Models.StreamingJobsCreateOrReplaceResponse>

  • Creates a streaming job or replaces an already existing streaming job.

    Parameters

    • streamingJob: StreamingJob

      The definition of the streaming job that will be used to create a new streaming job or replace the existing one.

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: Models.StreamingJobsCreateOrReplaceOptionalParams

    Returns Promise<Models.StreamingJobsCreateOrReplaceResponse>

    Promise<Models.StreamingJobsCreateOrReplaceResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deletes a streaming job.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, jobName: string, options?: Models.StreamingJobsGetOptionalParams): Promise<Models.StreamingJobsGetResponse>
  • get(resourceGroupName: string, jobName: string, callback: msRest.ServiceCallback<StreamingJob>): void
  • get(resourceGroupName: string, jobName: string, options: StreamingJobsGetOptionalParams, callback: msRest.ServiceCallback<StreamingJob>): void

  • Gets details about the specified streaming job.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: Models.StreamingJobsGetOptionalParams

    Returns Promise<Models.StreamingJobsGetResponse>

    Promise<Models.StreamingJobsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • callback: msRest.ServiceCallback<StreamingJob>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • options: StreamingJobsGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<StreamingJob>

      The callback

    Returns void

list

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: Models.StreamingJobsListByResourceGroupOptionalParams): Promise<Models.StreamingJobsListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<StreamingJobListResult>): void
  • listByResourceGroup(resourceGroupName: string, options: StreamingJobsListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<StreamingJobListResult>): void

  • Lists all of the streaming jobs in the specified resource group.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • Optional options: Models.StreamingJobsListByResourceGroupOptionalParams

    Returns Promise<Models.StreamingJobsListByResourceGroupResponse>

    Promise<Models.StreamingJobsListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • callback: msRest.ServiceCallback<StreamingJobListResult>

      The callback

    Returns void

  • Parameters

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.StreamingJobsListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<StreamingJobListResult>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<StreamingJobListResult>): void

  • Lists all of the streaming jobs in the specified resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.StreamingJobsListByResourceGroupNextResponse>

    Promise<Models.StreamingJobsListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<StreamingJobListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<StreamingJobListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.StreamingJobsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<StreamingJobListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<StreamingJobListResult>): void

  • Lists all of the streaming jobs in the given subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.StreamingJobsListNextResponse>

    Promise<Models.StreamingJobsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<StreamingJobListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<StreamingJobListResult>

      The callback

    Returns void

start

  • start(resourceGroupName: string, jobName: string, options?: Models.StreamingJobsStartOptionalParams): Promise<msRest.RestResponse>

  • Starts a streaming job. Once a job is started it will start processing input events and produce output.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: Models.StreamingJobsStartOptionalParams

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

stop

  • stop(resourceGroupName: string, jobName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.

    Parameters

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

update

  • update(streamingJob: StreamingJob, resourceGroupName: string, jobName: string, options?: Models.StreamingJobsUpdateOptionalParams): Promise<Models.StreamingJobsUpdateResponse>
  • update(streamingJob: StreamingJob, resourceGroupName: string, jobName: string, callback: msRest.ServiceCallback<StreamingJob>): void
  • update(streamingJob: StreamingJob, resourceGroupName: string, jobName: string, options: StreamingJobsUpdateOptionalParams, callback: msRest.ServiceCallback<StreamingJob>): void

  • Updates an existing streaming job. This can be used to partially update (ie. update one or two properties) a streaming job without affecting the rest the job definition.

    Parameters

    • streamingJob: StreamingJob

      A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation.

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • Optional options: Models.StreamingJobsUpdateOptionalParams

    Returns Promise<Models.StreamingJobsUpdateResponse>

    Promise<Models.StreamingJobsUpdateResponse>

  • Parameters

    • streamingJob: StreamingJob

      A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation.

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • callback: msRest.ServiceCallback<StreamingJob>

      The callback

    Returns void

  • Parameters

    • streamingJob: StreamingJob

      A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation.

    • resourceGroupName: string

      The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

    • jobName: string

      The name of the streaming job.

    • options: StreamingJobsUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<StreamingJob>

      The callback

    Returns void

Generated using TypeDoc