Jobs interface

Paket:

@azure/arm-databox

Gränssnitt som representerar ett jobb.

Metoder

beginCreate(string, string, JobResource, JobsCreateOptionalParams)	Skapar ett nytt jobb med de angivna parametrarna. Det går inte att uppdatera det befintliga jobbet med det här API:et och bör i stället uppdateras med API:et för uppdateringsjobbet.
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)	Skapar ett nytt jobb med de angivna parametrarna. Det går inte att uppdatera det befintliga jobbet med det här API:et och bör i stället uppdateras med API:et för uppdateringsjobbet.
beginDelete(string, string, JobsDeleteOptionalParams)	Tar bort ett jobb.
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)	Tar bort ett jobb.
beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Uppdaterar egenskaperna för ett befintligt jobb.
beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Uppdaterar egenskaperna för ett befintligt jobb.
bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)	Upphämtning av bokleverans.
cancel(string, string, CancellationReason, JobsCancelOptionalParams)	AvbrytJobb.
get(string, string, JobsGetOptionalParams)	Hämtar information om det angivna jobbet.
list(JobsListOptionalParams)	Visar en lista över alla jobb som är tillgängliga under prenumerationen.
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)	Visar en lista över alla jobb som är tillgängliga under den angivna resursgruppen.
listCredentials(string, string, JobsListCredentialsOptionalParams)	Den här metoden hämtar de okrypterade hemligheter som är relaterade till jobbet.
markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)	Begäran om att markera enheter för ett visst jobb som levererat

Metodinformation

beginCreate(string, string, JobResource, JobsCreateOptionalParams)

Skapar ett nytt jobb med de angivna parametrarna. Det går inte att uppdatera det befintliga jobbet med det här API:et och bör i stället uppdateras med API:et för uppdateringsjobbet.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

jobResource

JobResource

Jobbinformation från begärandetexten.

options

JobsCreateOptionalParams

Alternativparametrarna.

Returer

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

beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)

Skapar ett nytt jobb med de angivna parametrarna. Det går inte att uppdatera det befintliga jobbet med det här API:et och bör i stället uppdateras med API:et för uppdateringsjobbet.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

jobResource

JobResource

Jobbinformation från begärandetexten.

options

JobsCreateOptionalParams

Alternativparametrarna.

Returer

Promise<JobResource>

beginDelete(string, string, JobsDeleteOptionalParams)

Tar bort ett jobb.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

options

JobsDeleteOptionalParams

Alternativparametrarna.

Returer

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

beginDeleteAndWait(string, string, JobsDeleteOptionalParams)

Tar bort ett jobb.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

options

JobsDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Uppdaterar egenskaperna för ett befintligt jobb.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

jobResourceUpdateParameter

JobResourceUpdateParameter

Jobbuppdateringsparametrar från begärandetexten.

options

JobsUpdateOptionalParams

Alternativparametrarna.

Returer

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

beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Uppdaterar egenskaperna för ett befintligt jobb.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

jobResourceUpdateParameter

JobResourceUpdateParameter

Jobbuppdateringsparametrar från begärandetexten.

options

JobsUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<JobResource>

bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)

Upphämtning av bokleverans.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

shipmentPickUpRequest

ShipmentPickUpRequest

Information om leveranshämtningsbegäran.

options

JobsBookShipmentPickUpOptionalParams

Alternativparametrarna.

Returer

Promise<ShipmentPickUpResponse>

cancel(string, string, CancellationReason, JobsCancelOptionalParams)

AvbrytJobb.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

cancellationReason

CancellationReason

Orsak till annullering.

options

JobsCancelOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, JobsGetOptionalParams)

Hämtar information om det angivna jobbet.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

options

JobsGetOptionalParams

Alternativparametrarna.

Returer

Promise<JobResource>

list(JobsListOptionalParams)

Visar en lista över alla jobb som är tillgängliga under prenumerationen.

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

Parametrar

options

JobsListOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Visar en lista över alla jobb som är tillgängliga under den angivna resursgruppen.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

options

JobsListByResourceGroupOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listCredentials(string, string, JobsListCredentialsOptionalParams)

Den här metoden hämtar de okrypterade hemligheter som är relaterade till jobbet.

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

Parametrar

resourceGroupName

string

Resursgruppens namn

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

options

JobsListCredentialsOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)

Begäran om att markera enheter för ett visst jobb som levererat

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

Parametrar

jobName

string

Namnet på jobbresursen i den angivna resursgruppen. jobbnamn måste vara mellan 3 och 24 tecken långa och endast använda alfanumeriska och understreck

resourceGroupName

string

Resursgruppens namn

markDevicesShippedRequest

MarkDevicesShippedRequest

Markera levererad begäran för enheter

options

JobsMarkDevicesShippedOptionalParams

Alternativparametrarna.

Returer

Promise<void>