ContainerListBlobsOptions interface

Balíček:
@azure/storage-blob

Možnosti konfigurace kontejneru – Operace výpisu objektů blob

Vidět:

Extends
CommonOptions

Vlastnosti

abortSignal

Implementace rozhraní AbortSignalLike, která signalizují požadavek na zrušení operace. Například pomocí kontroleru @azure/abort-controller vytvořte AbortSignal.
endBefore

Optional. Specifikuje relativní cestu uvnitř kontejneru, před kterou záznam končí. Podporováno pouze tehdy, když je formát odpovědi StorageResponseFormat.Arrow.
includeCopy

Určuje, jestli se metadata související s jakoukoli aktuální nebo předchozí operací kopírování objektu blob mají zahrnout do odpovědi.
includeDeleted

Určuje, jestli mají být do odpovědi zahrnuty obnovitelné odstraněné objekty blob.
includeDeletedWithVersions

Určuje, jestli se odstraněný objekt blob s verzemi vrátí v odpovědi.
includeImmutabilityPolicy

Určuje, jestli se v odpovědi vrátí zásada neměnnosti objektu blob.
includeLegalHold

Určuje, jestli se v odpovědi vrátí blokování z právních důvodů objektu blob.
includeMetadata

Určuje, jestli se v odpovědi vrátí metadata objektu blob.
includeSnapshots

Určuje, jestli se snímky mají zahrnout do výčtu. Snímky jsou uvedené od nejstarších po nejnovější v odpovědi.
includeTags

Určuje, jestli se v odpovědi vrátí značky objektů blob.
includeUncommitedBlobs

Určuje, jestli se do odpovědi zahrnou objekty blob, pro které se bloky nahrály, ale které nebyly potvrzeny pomocí seznamu blokovaných položek.
includeVersions

Určuje, zda mají být verze zahrnuty do výčtu. V odpovědi jsou uvedené verze od nejstarších po nejnovější.
prefix

Filtruje výsledky tak, aby vracely pouze kontejnery, jejichž název začíná zadanou předponou.
responseFormat

Specifikuje formát, který by služba měla použít pro vrácení výsledků seznamu. Výchozí nastavení je StorageResponseFormat.Auto.
startFrom

Specifikuje relativní cestu pro seznam cest. Pro nerekurzivní seznam je podporována pouze jedna úroveň entity; Pro rekurzivní seznam je podporováno více úrovní entit. (Zahrnující)

Zděděné vlastnosti

tracingOptions

Možnosti konfigurace rozsahů vytvořených při povolení trasování

Podrobnosti vlastnosti

abortSignal

Implementace rozhraní AbortSignalLike, která signalizují požadavek na zrušení operace. Například pomocí kontroleru @azure/abort-controller vytvořte AbortSignal.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

endBefore

Optional. Specifikuje relativní cestu uvnitř kontejneru, před kterou záznam končí. Podporováno pouze tehdy, když je formát odpovědi StorageResponseFormat.Arrow.

endBefore?: string

Hodnota vlastnosti

string

includeCopy

Určuje, jestli se metadata související s jakoukoli aktuální nebo předchozí operací kopírování objektu blob mají zahrnout do odpovědi.

includeCopy?: boolean

Hodnota vlastnosti

boolean

includeDeleted

Určuje, jestli mají být do odpovědi zahrnuty obnovitelné odstraněné objekty blob.

includeDeleted?: boolean

Hodnota vlastnosti

boolean

includeDeletedWithVersions

Určuje, jestli se odstraněný objekt blob s verzemi vrátí v odpovědi.

includeDeletedWithVersions?: boolean

Hodnota vlastnosti

boolean

includeImmutabilityPolicy

Určuje, jestli se v odpovědi vrátí zásada neměnnosti objektu blob.

includeImmutabilityPolicy?: boolean

Hodnota vlastnosti

boolean

includeLegalHold

Určuje, jestli se v odpovědi vrátí blokování z právních důvodů objektu blob.

includeLegalHold?: boolean

Hodnota vlastnosti

boolean

includeMetadata

Určuje, jestli se v odpovědi vrátí metadata objektu blob.

includeMetadata?: boolean

Hodnota vlastnosti

boolean

includeSnapshots

Určuje, jestli se snímky mají zahrnout do výčtu. Snímky jsou uvedené od nejstarších po nejnovější v odpovědi.

includeSnapshots?: boolean

Hodnota vlastnosti

boolean

includeTags

Určuje, jestli se v odpovědi vrátí značky objektů blob.

includeTags?: boolean

Hodnota vlastnosti

boolean

includeUncommitedBlobs

Určuje, jestli se do odpovědi zahrnou objekty blob, pro které se bloky nahrály, ale které nebyly potvrzeny pomocí seznamu blokovaných položek.

includeUncommitedBlobs?: boolean

Hodnota vlastnosti

boolean

includeVersions

Určuje, zda mají být verze zahrnuty do výčtu. V odpovědi jsou uvedené verze od nejstarších po nejnovější.

includeVersions?: boolean

Hodnota vlastnosti

boolean

prefix

Filtruje výsledky tak, aby vracely pouze kontejnery, jejichž název začíná zadanou předponou.

prefix?: string

Hodnota vlastnosti

string

responseFormat

Specifikuje formát, který by služba měla použít pro vrácení výsledků seznamu. Výchozí nastavení je StorageResponseFormat.Auto.

responseFormat?: StorageResponseFormat

Hodnota vlastnosti

StorageResponseFormat

startFrom

Specifikuje relativní cestu pro seznam cest. Pro nerekurzivní seznam je podporována pouze jedna úroveň entity; Pro rekurzivní seznam je podporováno více úrovní entit. (Zahrnující)

startFrom?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

tracingOptions

Možnosti konfigurace rozsahů vytvořených při povolení trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno zCommonOptions.tracingOptions