Jobs interface
Schnittstelle, die einen Auftrag darstellt.
Methoden
| begin |
Erstellt einen neuen Auftrag mit den angegebenen Parametern. Der vorhandene Auftrag kann nicht mit dieser API aktualisiert werden und sollte stattdessen mit der Updateauftrags-API aktualisiert werden. |
| begin |
Erstellt einen neuen Auftrag mit den angegebenen Parametern. Der vorhandene Auftrag kann nicht mit dieser API aktualisiert werden und sollte stattdessen mit der Updateauftrags-API aktualisiert werden. |
| begin |
Löscht einen Auftrag. |
| begin |
Löscht einen Auftrag. |
| begin |
Aktualisiert die Eigenschaften eines vorhandenen Auftrags. |
| begin |
Aktualisiert die Eigenschaften eines vorhandenen Auftrags. |
| book |
Buchen Sie den Versand abholen. |
| cancel(string, string, Cancellation |
CancelJob. |
| get(string, string, Jobs |
Ruft Informationen zum angegebenen Auftrag ab. |
| list(Jobs |
Listet alle Aufträge auf, die unter dem Abonnement verfügbar sind. |
| list |
Listet alle Aufträge auf, die unter der angegebenen Ressourcengruppe verfügbar sind. |
| list |
Diese Methode ruft die unverschlüsselten Geheimnisse im Zusammenhang mit dem Auftrag ab. |
| mark |
Anforderung zum Kennzeichnen von Geräten für einen bestimmten Auftrag als versandfertig |
Details zur Methode
beginCreate(string, string, JobResource, JobsCreateOptionalParams)
Erstellt einen neuen Auftrag mit den angegebenen Parametern. Der vorhandene Auftrag kann nicht mit dieser API aktualisiert werden und sollte stattdessen mit der Updateauftrags-API aktualisiert werden.
function beginCreate(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- jobResource
- JobResource
Auftragsdetails vom Anforderungstext.
- options
- JobsCreateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobResource>, JobResource>>
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)
Erstellt einen neuen Auftrag mit den angegebenen Parametern. Der vorhandene Auftrag kann nicht mit dieser API aktualisiert werden und sollte stattdessen mit der Updateauftrags-API aktualisiert werden.
function beginCreateAndWait(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<JobResource>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- jobResource
- JobResource
Auftragsdetails vom Anforderungstext.
- options
- JobsCreateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<JobResource>
beginDelete(string, string, JobsDeleteOptionalParams)
Löscht einen Auftrag.
function beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- options
- JobsDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)
Löscht einen Auftrag.
function beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- options
- JobsDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)
Aktualisiert die Eigenschaften eines vorhandenen Auftrags.
function beginUpdate(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- jobResourceUpdateParameter
- JobResourceUpdateParameter
Auftragsaktualisierungsparameter vom Anforderungstext.
- options
- JobsUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobResource>, JobResource>>
beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)
Aktualisiert die Eigenschaften eines vorhandenen Auftrags.
function beginUpdateAndWait(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<JobResource>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- jobResourceUpdateParameter
- JobResourceUpdateParameter
Auftragsaktualisierungsparameter vom Anforderungstext.
- options
- JobsUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<JobResource>
bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)
Buchen Sie den Versand abholen.
function bookShipmentPickUp(resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams): Promise<ShipmentPickUpResponse>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- shipmentPickUpRequest
- ShipmentPickUpRequest
Details zur Versandabfuhranfrage.
Die Optionsparameter.
Gibt zurück
Promise<ShipmentPickUpResponse>
cancel(string, string, CancellationReason, JobsCancelOptionalParams)
CancelJob.
function cancel(resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams): Promise<void>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- cancellationReason
- CancellationReason
Grund für die Stornierung.
- options
- JobsCancelOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, JobsGetOptionalParams)
Ruft Informationen zum angegebenen Auftrag ab.
function get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<JobResource>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- options
- JobsGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<JobResource>
list(JobsListOptionalParams)
Listet alle Aufträge auf, die unter dem Abonnement verfügbar sind.
function list(options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>
Parameter
- options
- JobsListOptionalParams
Die Optionsparameter.
Gibt zurück
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)
Listet alle Aufträge auf, die unter der angegebenen Ressourcengruppe verfügbar sind.
function listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
Die Optionsparameter.
Gibt zurück
listCredentials(string, string, JobsListCredentialsOptionalParams)
Diese Methode ruft die unverschlüsselten Geheimnisse im Zusammenhang mit dem Auftrag ab.
function listCredentials(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams): PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>
Parameter
- resourceGroupName
-
string
Der Ressourcengruppenname
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
Die Optionsparameter.
Gibt zurück
markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)
Anforderung zum Kennzeichnen von Geräten für einen bestimmten Auftrag als versandfertig
function markDevicesShipped(jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams): Promise<void>
Parameter
- jobName
-
string
Der Name der Auftragsressource innerhalb der angegebenen Ressourcengruppe. Auftragsnamen müssen zwischen 3 und 24 Zeichen lang sein und nur alphanumerisch und unterstrichen verwenden.
- resourceGroupName
-
string
Der Ressourcengruppenname
- markDevicesShippedRequest
- MarkDevicesShippedRequest
Versandanforderung für Geräte markieren
Die Optionsparameter.
Gibt zurück
Promise<void>