Jobs interface

Pacote:

@azure/arm-databox

Interface que representa um Jobs.

Métodos

beginCreate(string, string, JobResource, JobsCreateOptionalParams)	Cria um novo trabalho com os parâmetros especificados. O trabalho existente não pode ser atualizado com essa API e, em vez disso, deve ser atualizado com a API de trabalho de atualização.
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)	Cria um novo trabalho com os parâmetros especificados. O trabalho existente não pode ser atualizado com essa API e, em vez disso, deve ser atualizado com a API de trabalho de atualização.
beginDelete(string, string, JobsDeleteOptionalParams)	Exclui um trabalho.
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)	Exclui um trabalho.
beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Atualiza as propriedades de um trabalho existente.
beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Atualiza as propriedades de um trabalho existente.
bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)	Recolha do envio do livro.
cancel(string, string, CancellationReason, JobsCancelOptionalParams)	CancelJob.
get(string, string, JobsGetOptionalParams)	Obtém informações sobre o trabalho especificado.
list(JobsListOptionalParams)	Lista todos os trabalhos disponíveis na assinatura.
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)	Lista todos os trabalhos disponíveis no grupo de recursos fornecido.
listCredentials(string, string, JobsListCredentialsOptionalParams)	Esse método obtém os segredos não criptografados relacionados ao trabalho.
markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)	Solicitação para marcar dispositivos para um determinado trabalho como enviados

Detalhes de Método

beginCreate(string, string, JobResource, JobsCreateOptionalParams)

Cria um novo trabalho com os parâmetros especificados. O trabalho existente não pode ser atualizado com essa API e, em vez disso, deve ser atualizado com a API de trabalho de atualização.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

jobResource

JobResource

Detalhes do trabalho do corpo da solicitação.

options

JobsCreateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)

Cria um novo trabalho com os parâmetros especificados. O trabalho existente não pode ser atualizado com essa API e, em vez disso, deve ser atualizado com a API de trabalho de atualização.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

jobResource

JobResource

Detalhes do trabalho do corpo da solicitação.

options

JobsCreateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<JobResource>

beginDelete(string, string, JobsDeleteOptionalParams)

Exclui um trabalho.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

options

JobsDeleteOptionalParams

Os parâmetros de opções.

Devoluções

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

beginDeleteAndWait(string, string, JobsDeleteOptionalParams)

Exclui um trabalho.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

options

JobsDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Atualiza as propriedades de um trabalho existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

jobResourceUpdateParameter

JobResourceUpdateParameter

Parâmetros de atualização de trabalho do corpo da solicitação.

options

JobsUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Atualiza as propriedades de um trabalho existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

jobResourceUpdateParameter

JobResourceUpdateParameter

Parâmetros de atualização de trabalho do corpo da solicitação.

options

JobsUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<JobResource>

bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)

Recolha do envio do livro.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

shipmentPickUpRequest

ShipmentPickUpRequest

Detalhes do pedido de levantamento de envio.

options

JobsBookShipmentPickUpOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ShipmentPickUpResponse>

cancel(string, string, CancellationReason, JobsCancelOptionalParams)

CancelJob.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

cancellationReason

CancellationReason

Motivo do cancelamento.

options

JobsCancelOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, JobsGetOptionalParams)

Obtém informações sobre o trabalho especificado.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

options

JobsGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<JobResource>

list(JobsListOptionalParams)

Lista todos os trabalhos disponíveis na assinatura.

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

Parâmetros

options

JobsListOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Lista todos os trabalhos disponíveis no grupo de recursos fornecido.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

options

JobsListByResourceGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listCredentials(string, string, JobsListCredentialsOptionalParams)

Esse método obtém os segredos não criptografados relacionados ao trabalho.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

options

JobsListCredentialsOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)

Solicitação para marcar dispositivos para um determinado trabalho como enviados

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

Parâmetros

jobName

string

O nome do recurso de trabalho dentro do grupo de recursos especificado. Os nomes dos trabalhos devem ter entre 3 e 24 caracteres e usar apenas qualquer alfanumérico e sublinhado

resourceGroupName

string

O nome do grupo de recursos

markDevicesShippedRequest

MarkDevicesShippedRequest

Marcar Solicitação de Dispositivos Enviados

options

JobsMarkDevicesShippedOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>