ServiceFabricClientGetApplicationInfoListOptionalParams interface
Nem kötelező paraméterek.
- Extends
Tulajdonságok
| application |
Az ApplicationDefinitionKindre való szűrésre szolgál, amely egy Service Fabric-alkalmazás definiálására szolgáló mechanizmus.
|
| application |
Az alkalmazástípus neve, amellyel szűrheti az alkalmazásokat a lekérdezéshez. Ez az érték nem tartalmazhat alkalmazástípus-verziót. |
| continuation |
A folytatási jogkivonat paramétere a következő eredmények lekérésére szolgál. Az API válaszában szerepel egy nem üres értékkel rendelkező folytatási jogkivonat, ha a rendszer eredményei nem férnek el egyetlen válaszban. Amikor ezt az értéket átadja a következő API-hívásnak, az API a következő eredményhalmazt adja vissza. Ha nincsenek további eredmények, akkor a folytatási jogkivonat nem tartalmaz értéket. Ennek a paraméternek az értéke nem lehet URL-kódolva. |
| exclude |
Az a jelző, amely meghatározza, hogy az alkalmazásparaméterek ki lesznek-e zárva az eredményből. Alapértelmezett érték: hamis. |
| max |
A lapozott lekérdezések részeként visszaadandó eredmények maximális száma. Ez a paraméter határozza meg a visszaadott eredmények számának felső határát. A visszaadott eredmények kisebbek lehetnek a megadott maximális eredményeknél, ha nem férnek el az üzenetben a konfigurációban meghatározott maximális üzenetméret-korlátozásoknak megfelelően. Ha ez a paraméter nulla vagy nincs megadva, a lapozott lekérdezés a lehető legtöbb eredményt tartalmazza, amely illeszkedik a visszatérési üzenetbe. Alapértelmezett érték: 0. |
| timeout |
A kiszolgáló időtúllépése a művelet másodpercek alatt történő végrehajtásához. Ez az időtúllépés azt az időtartamot adja meg, amelyet az ügyfél hajlandó megvárni a kért művelet befejezéséig. A paraméter alapértelmezett értéke 60 másodperc. Alapértelmezett érték: 60. |
Örökölt tulajdonságok
| abort |
A kérések megszakítására használható jel. |
| custom |
A felhasználó által definiált egyéni kérésfejlécek, amelyeket a kérés elküldése előtt alkalmazunk. |
| on |
Visszahívás, amely a letöltési folyamat során aktiválódik. |
| on |
Visszahívás, amely a feltöltési folyamat során aktiválódik. |
| timeout | A kérelmek automatikus leállása előtt eltartható ezredmásodperc. |
Tulajdonság adatai
applicationDefinitionKindFilter
Az ApplicationDefinitionKindre való szűrésre szolgál, amely egy Service Fabric-alkalmazás definiálására szolgáló mechanizmus.
- Alapértelmezett – Alapértelmezett érték, amely ugyanazt a függvényt hajtja végre, mint az "Összes". Az érték a következő:
- Minden – Olyan szűrő, amely megfelel a bemenetnek bármely ApplicationDefinitionKind értékkel. Az érték a következő:
- ServiceFabricApplicationDescription – Az ApplicationDefinitionKind serviceFabricApplicationDescription értékkel egyező szűrő. Az érték 1.
- Compose – Az ApplicationDefinitionKind Érték Compose értékével egyező szűrő. Az érték 2. Alapértelmezett érték: 0.
applicationDefinitionKindFilter?: number
Tulajdonság értéke
number
applicationTypeName
Az alkalmazástípus neve, amellyel szűrheti az alkalmazásokat a lekérdezéshez. Ez az érték nem tartalmazhat alkalmazástípus-verziót.
applicationTypeName?: string
Tulajdonság értéke
string
continuationToken
A folytatási jogkivonat paramétere a következő eredmények lekérésére szolgál. Az API válaszában szerepel egy nem üres értékkel rendelkező folytatási jogkivonat, ha a rendszer eredményei nem férnek el egyetlen válaszban. Amikor ezt az értéket átadja a következő API-hívásnak, az API a következő eredményhalmazt adja vissza. Ha nincsenek további eredmények, akkor a folytatási jogkivonat nem tartalmaz értéket. Ennek a paraméternek az értéke nem lehet URL-kódolva.
continuationToken?: string
Tulajdonság értéke
string
excludeApplicationParameters
Az a jelző, amely meghatározza, hogy az alkalmazásparaméterek ki lesznek-e zárva az eredményből. Alapértelmezett érték: hamis.
excludeApplicationParameters?: boolean
Tulajdonság értéke
boolean
maxResults
A lapozott lekérdezések részeként visszaadandó eredmények maximális száma. Ez a paraméter határozza meg a visszaadott eredmények számának felső határát. A visszaadott eredmények kisebbek lehetnek a megadott maximális eredményeknél, ha nem férnek el az üzenetben a konfigurációban meghatározott maximális üzenetméret-korlátozásoknak megfelelően. Ha ez a paraméter nulla vagy nincs megadva, a lapozott lekérdezés a lehető legtöbb eredményt tartalmazza, amely illeszkedik a visszatérési üzenetbe. Alapértelmezett érték: 0.
maxResults?: number
Tulajdonság értéke
number
timeoutParameter
A kiszolgáló időtúllépése a művelet másodpercek alatt történő végrehajtásához. Ez az időtúllépés azt az időtartamot adja meg, amelyet az ügyfél hajlandó megvárni a kért művelet befejezéséig. A paraméter alapértelmezett értéke 60 másodperc. Alapértelmezett érték: 60.
timeoutParameter?: number
Tulajdonság értéke
number
Örökölt tulajdonság részletei
abortSignal
A kérések megszakítására használható jel.
abortSignal?: AbortSignalLike
Tulajdonság értéke
örökölt msRest.RequestOptionsBase.abortSignal
customHeaders
A felhasználó által definiált egyéni kérésfejlécek, amelyeket a kérés elküldése előtt alkalmazunk.
customHeaders?: {[key: string]: string}
Tulajdonság értéke
{[key: string]: string}
örökölt msRest.RequestOptionsBase.customHeaders
onDownloadProgress
Visszahívás, amely a letöltési folyamat során aktiválódik.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Tulajdonság értéke
(progress: TransferProgressEvent) => void
örökölt msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Visszahívás, amely a feltöltési folyamat során aktiválódik.
onUploadProgress?: (progress: TransferProgressEvent) => void
Tulajdonság értéke
(progress: TransferProgressEvent) => void
örökölt msRest.RequestOptionsBase.onUploadProgress
timeout
A kérelmek automatikus leállása előtt eltartható ezredmásodperc.
timeout?: number
Tulajdonság értéke
number
örökölt msRest.RequestOptionsBase.timeout