BlobContainers interface

Balíček:

@azure/arm-storage

Rozhraní představující objekt BlobContainers.

Metody

beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)	Tato operace migruje kontejner objektů blob z WORM na úrovni kontejneru do kontejneru s povolenou neměnností na úrovni objektu. Požadavky vyžadují zásady neměnnosti na úrovni kontejneru v uzamčeném nebo odemknutém stavu, správa verzí na úrovni účtu musí být povolená a kontejner by neměl být blokovaný z právních důvodů.
beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)	Tato operace migruje kontejner objektů blob z WORM na úrovni kontejneru do kontejneru s povolenou neměnností na úrovni objektu. Požadavky vyžadují zásady neměnnosti na úrovni kontejneru v uzamčeném nebo odemknutém stavu, správa verzí na úrovni účtu musí být povolená a kontejner by neměl být blokovaný z právních důvodů.
clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)	Vymaže značky blokování z právních důvodů. Vymazání stejné nebo neexistující značky má za následek idempotentní operaci. ClearLegalHold vymaže pouze zadané značky v požadavku.
create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)	Vytvoří nový kontejner v rámci zadaného účtu, jak je popsáno v textu požadavku. Prostředek kontejneru obsahuje metadata a vlastnosti daného kontejneru. Neobsahuje seznam objektů blob obsažených v kontejneru.
createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)	Vytvoří nebo aktualizuje odemknuté zásady neměnnosti. Značka ETag v If-Match se respektuje, pokud je zadána, ale není pro tuto operaci vyžadována.
delete(string, string, string, BlobContainersDeleteOptionalParams)	Odstraní zadaný kontejner v rámci svého účtu.
deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)	Přeruší odemknuté zásady neměnnosti. Odpověď na odstranění má vlastnost ImmutabilityPeriodSinceCreationInDays nastavenou na hodnotu 0. Pro tuto operaci se vyžaduje značka ETag v If-Match. Odstranění zásad uzamčené neměnnosti není povolené. Jediným způsobem je odstranit kontejner po odstranění všech objektů blob, jejichž platnost vypršela, uvnitř kontejneru uzamčeného zásadou.
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)	Rozšiřuje immutabilityPeriodSinceCreationInDays uzamčené immutabilityPolicy. Jediná akce povolená u uzamčených zásad bude tato akce. Pro tuto operaci se vyžaduje značka ETag v If-Match.
get(string, string, string, BlobContainersGetOptionalParams)	Získá vlastnosti zadaného kontejneru.
getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)	Získá existující zásady neměnnosti spolu s odpovídající značkou ETag v hlavičce a textu odpovědi.
lease(string, string, string, BlobContainersLeaseOptionalParams)	Operace zapůjčení kontejneru vytvoří a spravuje zámek kontejneru pro operace odstranění. Doba trvání zámku může být 15 až 60 sekund nebo může být nekonečná.
list(string, string, BlobContainersListOptionalParams)	Vypíše všechny kontejnery a nepodporuje předponu, jako je rovina dat. Ani SRP dnes nevrací pokračovací token.
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)	Nastaví ImmutabilityPolicy na uzamčený stav. Jediná akce povolená u uzamčených zásad je akce ExtendImmutabilityPolicy. Pro tuto operaci se vyžaduje značka ETag v If-Match.
setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)	Nastaví značky blokování z právních důvodů. Nastavení stejné značky má za následek idempotentní operaci. SetLegalHold se řídí vzorem připojení a nevymaže existující značky, které nejsou v požadavku zadány.
update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)	Aktualizace vlastnosti kontejneru uvedené v textu požadavku. Vlastnosti, které nejsou uvedené v požadavku, se nezmění. Aktualizace se nezdaří, pokud zadaný kontejner ještě neexistuje.

Podrobnosti metody

beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)

Tato operace migruje kontejner objektů blob z WORM na úrovni kontejneru do kontejneru s povolenou neměnností na úrovni objektu. Požadavky vyžadují zásady neměnnosti na úrovni kontejneru v uzamčeném nebo odemknutém stavu, správa verzí na úrovni účtu musí být povolená a kontejner by neměl být blokovaný z právních důvodů.

function beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

options

BlobContainersObjectLevelWormOptionalParams

Parametry možností.

Návraty

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)

Tato operace migruje kontejner objektů blob z WORM na úrovni kontejneru do kontejneru s povolenou neměnností na úrovni objektu. Požadavky vyžadují zásady neměnnosti na úrovni kontejneru v uzamčeném nebo odemknutém stavu, správa verzí na úrovni účtu musí být povolená a kontejner by neměl být blokovaný z právních důvodů.

function beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

options

BlobContainersObjectLevelWormOptionalParams

Parametry možností.

Návraty

Promise<void>

clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)

Vymaže značky blokování z právních důvodů. Vymazání stejné nebo neexistující značky má za následek idempotentní operaci. ClearLegalHold vymaže pouze zadané značky v požadavku.

function clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

legalHold

LegalHold

Vlastnost LegalHold, která se vymaže z kontejneru objektů blob.

options

BlobContainersClearLegalHoldOptionalParams

Parametry možností.

Návraty

Promise<LegalHold>

create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)

Vytvoří nový kontejner v rámci zadaného účtu, jak je popsáno v textu požadavku. Prostředek kontejneru obsahuje metadata a vlastnosti daného kontejneru. Neobsahuje seznam objektů blob obsažených v kontejneru.

function create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

blobContainer

BlobContainer

Vlastnosti kontejneru objektů blob, který se má vytvořit.

options

BlobContainersCreateOptionalParams

Parametry možností.

Návraty

Promise<BlobContainer>

createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)

Vytvoří nebo aktualizuje odemknuté zásady neměnnosti. Značka ETag v If-Match se respektuje, pokud je zadána, ale není pro tuto operaci vyžadována.

function createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

options

BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams

Parametry možností.

Návraty

Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>

delete(string, string, string, BlobContainersDeleteOptionalParams)

Odstraní zadaný kontejner v rámci svého účtu.

function delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

options

BlobContainersDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)

Přeruší odemknuté zásady neměnnosti. Odpověď na odstranění má vlastnost ImmutabilityPeriodSinceCreationInDays nastavenou na hodnotu 0. Pro tuto operaci se vyžaduje značka ETag v If-Match. Odstranění zásad uzamčené neměnnosti není povolené. Jediným způsobem je odstranit kontejner po odstranění všech objektů blob, jejichž platnost vypršela, uvnitř kontejneru uzamčeného zásadou.

function deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

ifMatch

string

Verze stavu entity (ETag) zásady neměnnosti, která se má aktualizovat. Hodnotu *lze použít k použití operace pouze v případě, že již existují zásady neměnnosti. Pokud tuto operaci vynecháte, použije se vždy.

options

BlobContainersDeleteImmutabilityPolicyOptionalParams

Parametry možností.

Návraty

Promise<BlobContainersDeleteImmutabilityPolicyResponse>

extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)

Rozšiřuje immutabilityPeriodSinceCreationInDays uzamčené immutabilityPolicy. Jediná akce povolená u uzamčených zásad bude tato akce. Pro tuto operaci se vyžaduje značka ETag v If-Match.

function extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

ifMatch

string

Verze stavu entity (ETag) zásady neměnnosti, která se má aktualizovat. Hodnotu *lze použít k použití operace pouze v případě, že již existují zásady neměnnosti. Pokud tuto operaci vynecháte, použije se vždy.

options

BlobContainersExtendImmutabilityPolicyOptionalParams

Parametry možností.

Návraty

Promise<BlobContainersExtendImmutabilityPolicyResponse>

get(string, string, string, BlobContainersGetOptionalParams)

Získá vlastnosti zadaného kontejneru.

function get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

options

BlobContainersGetOptionalParams

Parametry možností.

Návraty

Promise<BlobContainer>

getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)

Získá existující zásady neměnnosti spolu s odpovídající značkou ETag v hlavičce a textu odpovědi.

function getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

options

BlobContainersGetImmutabilityPolicyOptionalParams

Parametry možností.

Návraty

Promise<BlobContainersGetImmutabilityPolicyResponse>

lease(string, string, string, BlobContainersLeaseOptionalParams)

Operace zapůjčení kontejneru vytvoří a spravuje zámek kontejneru pro operace odstranění. Doba trvání zámku může být 15 až 60 sekund nebo může být nekonečná.

function lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

options

BlobContainersLeaseOptionalParams

Parametry možností.

Návraty

Promise<LeaseContainerResponse>

list(string, string, BlobContainersListOptionalParams)

Vypíše všechny kontejnery a nepodporuje předponu, jako je rovina dat. Ani SRP dnes nevrací pokračovací token.

function list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

options

BlobContainersListOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>

lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)

Nastaví ImmutabilityPolicy na uzamčený stav. Jediná akce povolená u uzamčených zásad je akce ExtendImmutabilityPolicy. Pro tuto operaci se vyžaduje značka ETag v If-Match.

function lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

ifMatch

string

Verze stavu entity (ETag) zásady neměnnosti, která se má aktualizovat. Hodnotu *lze použít k použití operace pouze v případě, že již existují zásady neměnnosti. Pokud tuto operaci vynecháte, použije se vždy.

options

BlobContainersLockImmutabilityPolicyOptionalParams

Parametry možností.

Návraty

Promise<BlobContainersLockImmutabilityPolicyResponse>

setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)

Nastaví značky blokování z právních důvodů. Nastavení stejné značky má za následek idempotentní operaci. SetLegalHold se řídí vzorem připojení a nevymaže existující značky, které nejsou v požadavku zadány.

function setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

legalHold

LegalHold

Vlastnost LegalHold, která se nastaví na kontejner objektů blob.

options

BlobContainersSetLegalHoldOptionalParams

Parametry možností.

Návraty

Promise<LegalHold>

update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)

Aktualizace vlastnosti kontejneru uvedené v textu požadavku. Vlastnosti, které nejsou uvedené v požadavku, se nezmění. Aktualizace se nezdaří, pokud zadaný kontejner ještě neexistuje.

function update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>

Parametry

resourceGroupName

string

Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.

accountName

string

Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.

containerName

string

Název kontejneru objektů blob v rámci zadaného účtu úložiště. Názvy kontejnerů objektů blob musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčku (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.

blobContainer

BlobContainer

Vlastnosti, které se mají aktualizovat pro kontejner objektů blob.

options

BlobContainersUpdateOptionalParams

Parametry možností.

Návraty

Promise<BlobContainer>