Jobs interface

Paquete:

@azure/arm-databox

Interfaz que representa un trabajo.

Métodos

beginCreate(string, string, JobResource, JobsCreateOptionalParams)	Crea un nuevo trabajo con los parámetros especificados. El trabajo existente no se puede actualizar con esta API y, en su lugar, debe actualizarse con la API de trabajo de actualización.
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)	Crea un nuevo trabajo con los parámetros especificados. El trabajo existente no se puede actualizar con esta API y, en su lugar, debe actualizarse con la API de trabajo de actualización.
beginDelete(string, string, JobsDeleteOptionalParams)	Elimina un trabajo.
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)	Elimina un trabajo.
beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Actualiza las propiedades de un trabajo existente.
beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Actualiza las propiedades de un trabajo existente.
bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)	Reserva la recogida del envío.
cancel(string, string, CancellationReason, JobsCancelOptionalParams)	CancelJob.
get(string, string, JobsGetOptionalParams)	Obtiene información sobre el trabajo especificado.
list(JobsListOptionalParams)	Enumera todos los trabajos disponibles en la suscripción.
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)	Enumera todos los trabajos disponibles en el grupo de recursos especificado.
listCredentials(string, string, JobsListCredentialsOptionalParams)	Este método obtiene los secretos sin cifrar relacionados con el trabajo.
markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)	Solicitud para marcar dispositivos para un trabajo determinado como enviado

Detalles del método

beginCreate(string, string, JobResource, JobsCreateOptionalParams)

Crea un nuevo trabajo con los parámetros especificados. El trabajo existente no se puede actualizar con esta API y, en su lugar, debe actualizarse con la API de trabajo de actualización.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

jobResource

JobResource

Detalles del trabajo del cuerpo de la solicitud.

options

JobsCreateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)

Crea un nuevo trabajo con los parámetros especificados. El trabajo existente no se puede actualizar con esta API y, en su lugar, debe actualizarse con la API de trabajo de actualización.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

jobResource

JobResource

Detalles del trabajo del cuerpo de la solicitud.

options

JobsCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<JobResource>

beginDelete(string, string, JobsDeleteOptionalParams)

Elimina un trabajo.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

options

JobsDeleteOptionalParams

Parámetros de opciones.

Devoluciones

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

beginDeleteAndWait(string, string, JobsDeleteOptionalParams)

Elimina un trabajo.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

options

JobsDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Actualiza las propiedades de un trabajo existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

jobResourceUpdateParameter

JobResourceUpdateParameter

Parámetros de actualización del trabajo del cuerpo de la solicitud.

options

JobsUpdateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Actualiza las propiedades de un trabajo existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

jobResourceUpdateParameter

JobResourceUpdateParameter

Parámetros de actualización del trabajo del cuerpo de la solicitud.

options

JobsUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<JobResource>

bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)

Reserva la recogida del envío.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

shipmentPickUpRequest

ShipmentPickUpRequest

Detalles de la solicitud de recogida de envío.

options

JobsBookShipmentPickUpOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ShipmentPickUpResponse>

cancel(string, string, CancellationReason, JobsCancelOptionalParams)

CancelJob.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

cancellationReason

CancellationReason

Motivo de cancelación.

options

JobsCancelOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, JobsGetOptionalParams)

Obtiene información sobre el trabajo especificado.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

options

JobsGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<JobResource>

list(JobsListOptionalParams)

Enumera todos los trabajos disponibles en la suscripción.

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

Parámetros

options

JobsListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Enumera todos los trabajos disponibles en el grupo de recursos especificado.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

options

JobsListByResourceGroupOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listCredentials(string, string, JobsListCredentialsOptionalParams)

Este método obtiene los secretos sin cifrar relacionados con el trabajo.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

options

JobsListCredentialsOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)

Solicitud para marcar dispositivos para un trabajo determinado como enviado

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

Parámetros

jobName

string

Nombre del recurso de trabajo dentro del grupo de recursos especificado. los nombres de trabajo deben tener entre 3 y 24 caracteres de longitud y usar cualquier carácter alfanumérico y de subrayado solo

resourceGroupName

string

Nombre del grupo de recursos

markDevicesShippedRequest

MarkDevicesShippedRequest

Marcar la solicitud enviada de dispositivos

options

JobsMarkDevicesShippedOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>