Jobs interface

Pakiet:

@azure/arm-databox

Interfejs reprezentujący zadania.

Metody

beginCreate(string, string, JobResource, JobsCreateOptionalParams)	Tworzy nowe zadanie z określonymi parametrami. Nie można zaktualizować istniejącego zadania za pomocą tego interfejsu API i zamiast tego należy go zaktualizować przy użyciu interfejsu API zadania aktualizacji.
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)	Tworzy nowe zadanie z określonymi parametrami. Nie można zaktualizować istniejącego zadania za pomocą tego interfejsu API i zamiast tego należy go zaktualizować przy użyciu interfejsu API zadania aktualizacji.
beginDelete(string, string, JobsDeleteOptionalParams)	Usuwa zadanie.
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)	Usuwa zadanie.
beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Aktualizuje właściwości istniejącego zadania.
beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)	Aktualizuje właściwości istniejącego zadania.
bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)	Odbiór przesyłki zarezerwowanej.
cancel(string, string, CancellationReason, JobsCancelOptionalParams)	CancelJob.
get(string, string, JobsGetOptionalParams)	Pobiera informacje o określonym zadaniu.
list(JobsListOptionalParams)	Wyświetla listę wszystkich zadań dostępnych w ramach subskrypcji.
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)	Wyświetla listę wszystkich zadań dostępnych w ramach danej grupy zasobów.
listCredentials(string, string, JobsListCredentialsOptionalParams)	Ta metoda pobiera niezaszyfrowane wpisy tajne związane z zadaniem.
markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)	Żądanie oznaczania urządzeń dla danego zadania jako wysłanego

Szczegóły metody

beginCreate(string, string, JobResource, JobsCreateOptionalParams)

Tworzy nowe zadanie z określonymi parametrami. Nie można zaktualizować istniejącego zadania za pomocą tego interfejsu API i zamiast tego należy go zaktualizować przy użyciu interfejsu API zadania aktualizacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

jobResource

JobResource

Szczegóły zadania z treści żądania.

options

JobsCreateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)

Tworzy nowe zadanie z określonymi parametrami. Nie można zaktualizować istniejącego zadania za pomocą tego interfejsu API i zamiast tego należy go zaktualizować przy użyciu interfejsu API zadania aktualizacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

jobResource

JobResource

Szczegóły zadania z treści żądania.

options

JobsCreateOptionalParams

Parametry opcji.

Zwraca

Promise<JobResource>

beginDelete(string, string, JobsDeleteOptionalParams)

Usuwa zadanie.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

options

JobsDeleteOptionalParams

Parametry opcji.

Zwraca

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

beginDeleteAndWait(string, string, JobsDeleteOptionalParams)

Usuwa zadanie.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

options

JobsDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Aktualizuje właściwości istniejącego zadania.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

jobResourceUpdateParameter

JobResourceUpdateParameter

Parametry aktualizacji zadania z treści żądania.

options

JobsUpdateOptionalParams

Parametry opcji.

Zwraca

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

beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)

Aktualizuje właściwości istniejącego zadania.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

jobResourceUpdateParameter

JobResourceUpdateParameter

Parametry aktualizacji zadania z treści żądania.

options

JobsUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<JobResource>

bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)

Odbiór przesyłki zarezerwowanej.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

shipmentPickUpRequest

ShipmentPickUpRequest

Szczegóły żądania odbioru przesyłki.

options

JobsBookShipmentPickUpOptionalParams

Parametry opcji.

Zwraca

Promise<ShipmentPickUpResponse>

cancel(string, string, CancellationReason, JobsCancelOptionalParams)

CancelJob.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

cancellationReason

CancellationReason

Przyczyna anulowania.

options

JobsCancelOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, JobsGetOptionalParams)

Pobiera informacje o określonym zadaniu.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

options

JobsGetOptionalParams

Parametry opcji.

Zwraca

Promise<JobResource>

list(JobsListOptionalParams)

Wyświetla listę wszystkich zadań dostępnych w ramach subskrypcji.

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

Parametry

options

JobsListOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listByResourceGroup(string, JobsListByResourceGroupOptionalParams)

Wyświetla listę wszystkich zadań dostępnych w ramach danej grupy zasobów.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

options

JobsListByResourceGroupOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>

listCredentials(string, string, JobsListCredentialsOptionalParams)

Ta metoda pobiera niezaszyfrowane wpisy tajne związane z zadaniem.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

options

JobsListCredentialsOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>

markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)

Żądanie oznaczania urządzeń dla danego zadania jako wysłanego

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

Parametry

jobName

string

Nazwa zasobu zadania w określonej grupie zasobów. nazwy zadań muszą mieć długość od 3 do 24 znaków i używać tylko znaków alfanumerycznych i podkreślenia

resourceGroupName

string

Nazwa grupy zasobów

markDevicesShippedRequest

MarkDevicesShippedRequest

Oznaczanie wysłanych żądań urządzeń

options

JobsMarkDevicesShippedOptionalParams

Parametry opcji.

Zwraca

Promise<void>