Jobs interface

Interface representing a Jobs.

Methods

beginCreate(string, string, JobResource, JobsCreateOptionalParams)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

beginDelete(string, string, JobsDeleteOptionalParams)

Deletes a job.

beginDeleteAndWait(string, string, JobsDeleteOptionalParams)

Deletes a job.

beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Updates the properties of an existing job.

beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Updates the properties of an existing job.

bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)

Book shipment pick up.

cancel(string, string, CancellationReason, JobsCancelOptionalParams)

CancelJob.

get(string, string, JobsGetOptionalParams)

Gets information about the specified job.

list(JobsListOptionalParams)

Lists all the jobs available under the subscription.

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Lists all the jobs available under the given resource group.

listCredentials(string, string, JobsListCredentialsOptionalParams)

This method gets the unencrypted secrets related to the job.

markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)

Request to mark devices for a given job as shipped

Method Details

beginCreate(string, string, JobResource, JobsCreateOptionalParams)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

function beginCreate(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

jobResource
JobResource

Job details from request body.

options
JobsCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<JobResource>, JobResource>>

beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)

Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.

function beginCreateAndWait(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<JobResource>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

jobResource
JobResource

Job details from request body.

options
JobsCreateOptionalParams

The options parameters.

Returns

Promise<JobResource>

beginDelete(string, string, JobsDeleteOptionalParams)

Deletes a job.

function beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

options
JobsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, JobsDeleteOptionalParams)

Deletes a job.

function beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

options
JobsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Updates the properties of an existing job.

function beginUpdate(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

jobResourceUpdateParameter
JobResourceUpdateParameter

Job update parameters from request body.

options
JobsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<JobResource>, JobResource>>

beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Updates the properties of an existing job.

function beginUpdateAndWait(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<JobResource>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

jobResourceUpdateParameter
JobResourceUpdateParameter

Job update parameters from request body.

options
JobsUpdateOptionalParams

The options parameters.

Returns

Promise<JobResource>

bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)

Book shipment pick up.

function bookShipmentPickUp(resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams): Promise<ShipmentPickUpResponse>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

shipmentPickUpRequest
ShipmentPickUpRequest

Details of shipment pick up request.

options
JobsBookShipmentPickUpOptionalParams

The options parameters.

Returns

cancel(string, string, CancellationReason, JobsCancelOptionalParams)

CancelJob.

function cancel(resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

cancellationReason
CancellationReason

Reason for cancellation.

options
JobsCancelOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, JobsGetOptionalParams)

Gets information about the specified job.

function get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<JobResource>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

options
JobsGetOptionalParams

The options parameters.

Returns

Promise<JobResource>

list(JobsListOptionalParams)

Lists all the jobs available under the subscription.

function list(options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

Parameters

options
JobsListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Lists all the jobs available under the given resource group.

function listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

Parameters

resourceGroupName

string

The Resource Group Name

options
JobsListByResourceGroupOptionalParams

The options parameters.

Returns

listCredentials(string, string, JobsListCredentialsOptionalParams)

This method gets the unencrypted secrets related to the job.

function listCredentials(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams): PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

Parameters

resourceGroupName

string

The Resource Group Name

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

options
JobsListCredentialsOptionalParams

The options parameters.

Returns

markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)

Request to mark devices for a given job as shipped

function markDevicesShipped(jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams): Promise<void>

Parameters

jobName

string

The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only

resourceGroupName

string

The Resource Group Name

markDevicesShippedRequest
MarkDevicesShippedRequest

Mark Devices Shipped Request

options
JobsMarkDevicesShippedOptionalParams

The options parameters.

Returns

Promise<void>