ServiceFabricClientGetComposeDeploymentStatusListOptionalParams interface

Pacchetto:

@azure/servicefabric

Parametri facoltativi.

Extends

RequestOptionsBase

Proprietà

continuationToken	Il parametro del token di continuazione viene usato per ottenere il set di risultati successivo. Un token di continuazione con un valore non vuoto viene incluso nella risposta dell'API quando i risultati del sistema non rientrano in una singola risposta. Quando questo valore viene passato alla chiamata API successiva, l'API restituisce il set di risultati successivo. Se non sono presenti altri risultati, il token di continuazione non contiene un valore. Il valore di questo parametro non deve essere codificato in URL.
maxResults	Numero massimo di risultati da restituire come parte delle query di paging. Questo parametro definisce il limite superiore per il numero di risultati restituiti. I risultati restituiti possono essere inferiori ai risultati massimi specificati se non rientrano nel messaggio in base alle restrizioni massime delle dimensioni dei messaggi definite nella configurazione. Se questo parametro è zero o non specificato, la query di paging include il maggior numero possibile di risultati che rientrano nel messaggio restituito. Valore predefinito: 0.
timeoutParameter	Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata di attesa che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi. Valore predefinito: 60.

Proprietà ereditate

abortSignal	Segnale che può essere usato per interrompere le richieste.
customHeaders	Intestazioni di richiesta personalizzate definite dall'utente che verranno applicate prima dell'invio della richiesta.
onDownloadProgress	Callback che viene attivato all'avanzamento del download.
onUploadProgress	Callback che viene attivato al momento dell'avanzamento del caricamento.
timeout	Numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente.

Dettagli proprietà

continuationToken

Il parametro del token di continuazione viene usato per ottenere il set di risultati successivo. Un token di continuazione con un valore non vuoto viene incluso nella risposta dell'API quando i risultati del sistema non rientrano in una singola risposta. Quando questo valore viene passato alla chiamata API successiva, l'API restituisce il set di risultati successivo. Se non sono presenti altri risultati, il token di continuazione non contiene un valore. Il valore di questo parametro non deve essere codificato in URL.

continuationToken?: string

Valore della proprietà

string

maxResults

Numero massimo di risultati da restituire come parte delle query di paging. Questo parametro definisce il limite superiore per il numero di risultati restituiti. I risultati restituiti possono essere inferiori ai risultati massimi specificati se non rientrano nel messaggio in base alle restrizioni massime delle dimensioni dei messaggi definite nella configurazione. Se questo parametro è zero o non specificato, la query di paging include il maggior numero possibile di risultati che rientrano nel messaggio restituito. Valore predefinito: 0.

maxResults?: number

Valore della proprietà

number

timeoutParameter

Timeout del server per l'esecuzione dell'operazione in secondi. Questo timeout specifica la durata di attesa che il client è disposto a attendere il completamento dell'operazione richiesta. Il valore predefinito per questo parametro è 60 secondi. Valore predefinito: 60.

timeoutParameter?: number

Valore della proprietà

number

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Ereditato da msRest.RequestOptionsBase.abortSignal

customHeaders

Intestazioni di richiesta personalizzate definite dall'utente che verranno applicate prima dell'invio della richiesta.

customHeaders?: {[key: string]: string}

Valore della proprietà

{[key: string]: string}

Ereditato da msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback che viene attivato all'avanzamento del download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

Ereditato da msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback che viene attivato al momento dell'avanzamento del caricamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

Ereditato da msRest.RequestOptionsBase.onUploadProgress

timeout

Numero di millisecondi che una richiesta può richiedere prima di essere terminata automaticamente.

timeout?: number

Valore della proprietà

number

ereditato da msRest.RequestOptionsBase.timeout