ListJobSchedulesOptionalParams interface

Pakket:
@azure/batch

Optionele parameters.

Uitbreiding
OperationOptions

Eigenschappen

clientRequestId

De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
expand

Een OData-$expand-component.
filter

Een OData-$filter-component. Voor meer informatie over het construeren van dit filter, zie https://dotnet.territoriali.olinfo.it/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.
maxResults

Het maximum aantal items dat moet worden geretourneerd in het antwoord. Maximaal 1000 aanvragen kunnen worden teruggestuurd.
ocpDate

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.
returnClientRequestId

Of de server de clientaanvraag-id in het antwoord moet retourneren.
select

Een OData-$select-component.
timeoutInSeconds

De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt."

Overgenomen eigenschappen

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

clientRequestId

De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

clientRequestId?: string

Waarde van eigenschap

string

expand

Een OData-$expand-component.

expand?: string[]

Waarde van eigenschap

string[]

filter

Een OData-$filter-component. Voor meer informatie over het construeren van dit filter, zie https://dotnet.territoriali.olinfo.it/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.

filter?: string

Waarde van eigenschap

string

maxResults

Het maximum aantal items dat moet worden geretourneerd in het antwoord. Maximaal 1000 aanvragen kunnen worden teruggestuurd.

maxResults?: number

Waarde van eigenschap

number

ocpDate

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

ocpDate?: Date

Waarde van eigenschap

Date

returnClientRequestId

Of de server de clientaanvraag-id in het antwoord moet retourneren.

returnClientRequestId?: boolean

Waarde van eigenschap

boolean

select

Een OData-$select-component.

select?: string[]

Waarde van eigenschap

string[]

timeoutInSeconds

De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt."

timeoutInSeconds?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions