Jobs interface

Paquet:

@azure/arm-databox

Interface représentant un travail.

Méthodes

beginCreate(string, string, JobResource, JobsCreateOptionalParams)	Crée un travail avec les paramètres spécifiés. Le travail existant ne peut pas être mis à jour avec cette API et doit plutôt être mis à jour avec l’API de travail Update.
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)	Crée un travail avec les paramètres spécifiés. Le travail existant ne peut pas être mis à jour avec cette API et doit plutôt être mis à jour avec l’API de travail Update.
beginDelete(string, string, JobsDeleteOptionalParams)	Supprime un travail.
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)	Supprime un travail.
beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Met à jour les propriétés d’un travail existant.
beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Met à jour les propriétés d’un travail existant.
bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)	Livrez la livraison en récupérant.
cancel(string, string, CancellationReason, JobsCancelOptionalParams)	CancelJob.
get(string, string, JobsGetOptionalParams)	Obtient des informations sur le travail spécifié.
list(JobsListOptionalParams)	Répertorie tous les travaux disponibles sous l’abonnement.
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)	Répertorie tous les travaux disponibles sous le groupe de ressources donné.
listCredentials(string, string, JobsListCredentialsOptionalParams)	Cette méthode obtient les secrets non chiffrés liés au travail.
markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)	Demander de marquer des appareils pour un travail donné comme étant expédié

Détails de la méthode

beginCreate(string, string, JobResource, JobsCreateOptionalParams)

Crée un travail avec les paramètres spécifiés. Le travail existant ne peut pas être mis à jour avec cette API et doit plutôt être mis à jour avec l’API de travail Update.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

jobResource

JobResource

Détails du travail à partir du corps de la demande.

options

JobsCreateOptionalParams

Paramètres d’options.

Retours

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

beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)

Crée un travail avec les paramètres spécifiés. Le travail existant ne peut pas être mis à jour avec cette API et doit plutôt être mis à jour avec l’API de travail Update.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

jobResource

JobResource

Détails du travail à partir du corps de la demande.

options

JobsCreateOptionalParams

Paramètres d’options.

Retours

Promise<JobResource>

beginDelete(string, string, JobsDeleteOptionalParams)

Supprime un travail.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

options

JobsDeleteOptionalParams

Paramètres d’options.

Retours

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

beginDeleteAndWait(string, string, JobsDeleteOptionalParams)

Supprime un travail.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

options

JobsDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Met à jour les propriétés d’un travail existant.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

jobResourceUpdateParameter

JobResourceUpdateParameter

Paramètres de mise à jour du travail à partir du corps de la demande.

options

JobsUpdateOptionalParams

Paramètres d’options.

Retours

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

beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Met à jour les propriétés d’un travail existant.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

jobResourceUpdateParameter

JobResourceUpdateParameter

Paramètres de mise à jour du travail à partir du corps de la demande.

options

JobsUpdateOptionalParams

Paramètres d’options.

Retours

Promise<JobResource>

bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)

Livrez la livraison en récupérant.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

shipmentPickUpRequest

ShipmentPickUpRequest

Détails de la demande de prise en charge de l’expédition.

options

JobsBookShipmentPickUpOptionalParams

Paramètres d’options.

Retours

Promise<ShipmentPickUpResponse>

cancel(string, string, CancellationReason, JobsCancelOptionalParams)

CancelJob.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

cancellationReason

CancellationReason

Motif de l’annulation.

options

JobsCancelOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, JobsGetOptionalParams)

Obtient des informations sur le travail spécifié.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

options

JobsGetOptionalParams

Paramètres d’options.

Retours

Promise<JobResource>

list(JobsListOptionalParams)

Répertorie tous les travaux disponibles sous l’abonnement.

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

Paramètres

options

JobsListOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Répertorie tous les travaux disponibles sous le groupe de ressources donné.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

options

JobsListByResourceGroupOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listCredentials(string, string, JobsListCredentialsOptionalParams)

Cette méthode obtient les secrets non chiffrés liés au travail.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

options

JobsListCredentialsOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)

Demander de marquer des appareils pour un travail donné comme étant expédié

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

Paramètres

jobName

string

Nom de la ressource de travail dans le groupe de ressources spécifié. Les noms des travaux doivent être compris entre 3 et 24 caractères et utiliser n’importe quel caractère alphanumérique et trait de soulignement uniquement

resourceGroupName

string

Nom du groupe de ressources

markDevicesShippedRequest

MarkDevicesShippedRequest

Marquer la demande envoyée par les appareils

options

JobsMarkDevicesShippedOptionalParams

Paramètres d’options.

Retours

Promise<void>