BlobContainers interface
Interfejs reprezentujący obiekty blobContainers.
Metody
| begin |
Ta operacja umożliwia migrację kontenera obiektów blob z kontenera na poziomie kontenera WORM do kontenera z włączonym niezmiennością na poziomie obiektu. Wymagania wstępne wymagają zasad niezmienności na poziomie kontenera w stanie zablokowanym lub odblokowanym. Przechowywanie wersji na poziomie konta musi być włączone i nie powinno być wstrzymane ze względów prawnych dla kontenera. |
| begin |
Ta operacja umożliwia migrację kontenera obiektów blob z kontenera na poziomie kontenera WORM do kontenera z włączonym niezmiennością na poziomie obiektu. Wymagania wstępne wymagają zasad niezmienności na poziomie kontenera w stanie zablokowanym lub odblokowanym. Przechowywanie wersji na poziomie konta musi być włączone i nie powinno być wstrzymane ze względów prawnych dla kontenera. |
| clear |
Czyści tagi archiwizacji ze względów prawnych. Wyczyszczenie tego samego lub nieistniejącego tagu powoduje operację idempotentną. Funkcja ClearLegalHold czyści tylko określone tagi w żądaniu. |
| create(string, string, string, Blob |
Tworzy nowy kontener w ramach określonego konta zgodnie z opisem w treści żądania. Zasób kontenera zawiera metadane i właściwości dla tego kontenera. Nie zawiera listy obiektów blob zawartych w kontenerze. |
| create |
Tworzy lub aktualizuje odblokowane zasady niezmienności. Element ETag w If-Match jest honorowany, jeśli jest podany, ale nie jest wymagany dla tej operacji. |
| delete(string, string, string, Blob |
Usuwa określony kontener na koncie. |
| delete |
Przerywa odblokowane zasady niezmienności. Odpowiedź usunięcia ma niezmiennośćPeriodSinceCreationInDays ustawioną na 0. Element ETag w If-Match jest wymagany dla tej operacji. Usunięcie zablokowanych zasad niezmienności jest niedozwolone. Jedynym sposobem jest usunięcie kontenera po usunięciu wszystkich wygasłych obiektów blob wewnątrz zablokowanego kontenera zasad. |
| extend |
Rozszerza niezmiennośćPeriodSinceCreationInDays zablokowanej niezmiennościPolicy. Jedyną akcją dozwoloną w zasadach zablokowanych będzie ta akcja. Element ETag w If-Match jest wymagany dla tej operacji. |
| get(string, string, string, Blob |
Pobiera właściwości określonego kontenera. |
| get |
Pobiera istniejące zasady niezmienności wraz z odpowiednim elementem ETag w nagłówkach odpowiedzi i treści. |
| lease(string, string, string, Blob |
Operacja dzierżawy kontenera ustanawia blokadę kontenera na potrzeby operacji usuwania i zarządza nią. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony. |
| list(string, string, Blob |
Wyświetla listę wszystkich kontenerów i nie obsługuje prefiksu, takiego jak płaszczyzna danych. Obecnie protokół SRP nie zwraca tokenu kontynuacji. |
| lock |
Ustawia stan ImmutabilityPolicy na Stan zablokowany. Jedyną akcją dozwoloną dla zablokowanych zasad jest akcja ExtendImmutabilityPolicy. Element ETag w If-Match jest wymagany dla tej operacji. |
| set |
Ustawia tagi blokady prawnej. Ustawienie tego samego tagu powoduje operację idempotentną. Właściwość SetLegalHold jest zgodna ze wzorcem dołączania i nie usuwa istniejących tagów, które nie zostały określone w żądaniu. |
| update(string, string, string, Blob |
Aktualizacje właściwości kontenera określone w treści żądania. Właściwości, które nie zostały wymienione w żądaniu, będą niezmienione. Aktualizacja kończy się niepowodzeniem, jeśli określony kontener jeszcze nie istnieje. |
Szczegóły metody
beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Ta operacja umożliwia migrację kontenera obiektów blob z kontenera na poziomie kontenera WORM do kontenera z włączonym niezmiennością na poziomie obiektu. Wymagania wstępne wymagają zasad niezmienności na poziomie kontenera w stanie zablokowanym lub odblokowanym. Przechowywanie wersji na poziomie konta musi być włączone i nie powinno być wstrzymane ze względów prawnych dla kontenera.
function beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i tylko kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Ta operacja umożliwia migrację kontenera obiektów blob z kontenera na poziomie kontenera WORM do kontenera z włączonym niezmiennością na poziomie obiektu. Wymagania wstępne wymagają zasad niezmienności na poziomie kontenera w stanie zablokowanym lub odblokowanym. Przechowywanie wersji na poziomie konta musi być włączone i nie powinno być wstrzymane ze względów prawnych dla kontenera.
function beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i tylko kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
Parametry opcji.
Zwraca
Promise<void>
clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)
Czyści tagi archiwizacji ze względów prawnych. Wyczyszczenie tego samego lub nieistniejącego tagu powoduje operację idempotentną. Funkcja ClearLegalHold czyści tylko określone tagi w żądaniu.
function clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- legalHold
- LegalHold
Właściwość LegalHold, która zostanie wyczysztana z kontenera obiektów blob.
Parametry opcji.
Zwraca
Promise<LegalHold>
create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)
Tworzy nowy kontener w ramach określonego konta zgodnie z opisem w treści żądania. Zasób kontenera zawiera metadane i właściwości dla tego kontenera. Nie zawiera listy obiektów blob zawartych w kontenerze.
function create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- blobContainer
- BlobContainer
Właściwości kontenera obiektów blob do utworzenia.
Parametry opcji.
Zwraca
Promise<BlobContainer>
createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)
Tworzy lub aktualizuje odblokowane zasady niezmienności. Element ETag w If-Match jest honorowany, jeśli jest podany, ale nie jest wymagany dla tej operacji.
function createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
Parametry opcji.
Zwraca
delete(string, string, string, BlobContainersDeleteOptionalParams)
Usuwa określony kontener na koncie.
function delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
Parametry opcji.
Zwraca
Promise<void>
deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)
Przerywa odblokowane zasady niezmienności. Odpowiedź usunięcia ma niezmiennośćPeriodSinceCreationInDays ustawioną na 0. Element ETag w If-Match jest wymagany dla tej operacji. Usunięcie zablokowanych zasad niezmienności jest niedozwolone. Jedynym sposobem jest usunięcie kontenera po usunięciu wszystkich wygasłych obiektów blob wewnątrz zablokowanego kontenera zasad.
function deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- ifMatch
-
string
Wersja stanu jednostki (ETag) zasad niezmienności do zaktualizowania. Wartość "*" może służyć do zastosowania operacji tylko wtedy, gdy istnieją już zasady niezmienności. W przypadku pominięcia ta operacja będzie zawsze stosowana.
Parametry opcji.
Zwraca
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)
Rozszerza niezmiennośćPeriodSinceCreationInDays zablokowanej niezmiennościPolicy. Jedyną akcją dozwoloną w zasadach zablokowanych będzie ta akcja. Element ETag w If-Match jest wymagany dla tej operacji.
function extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- ifMatch
-
string
Wersja stanu jednostki (ETag) zasad niezmienności do zaktualizowania. Wartość "*" może służyć do zastosowania operacji tylko wtedy, gdy istnieją już zasady niezmienności. W przypadku pominięcia ta operacja będzie zawsze stosowana.
Parametry opcji.
Zwraca
get(string, string, string, BlobContainersGetOptionalParams)
Pobiera właściwości określonego kontenera.
function get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- options
- BlobContainersGetOptionalParams
Parametry opcji.
Zwraca
Promise<BlobContainer>
getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)
Pobiera istniejące zasady niezmienności wraz z odpowiednim elementem ETag w nagłówkach odpowiedzi i treści.
function getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
Parametry opcji.
Zwraca
lease(string, string, string, BlobContainersLeaseOptionalParams)
Operacja dzierżawy kontenera ustanawia blokadę kontenera na potrzeby operacji usuwania i zarządza nią. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony.
function lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
Parametry opcji.
Zwraca
Promise<LeaseContainerResponse>
list(string, string, BlobContainersListOptionalParams)
Wyświetla listę wszystkich kontenerów i nie obsługuje prefiksu, takiego jak płaszczyzna danych. Obecnie protokół SRP nie zwraca tokenu kontynuacji.
function list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- options
- BlobContainersListOptionalParams
Parametry opcji.
Zwraca
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)
Ustawia stan ImmutabilityPolicy na Stan zablokowany. Jedyną akcją dozwoloną dla zablokowanych zasad jest akcja ExtendImmutabilityPolicy. Element ETag w If-Match jest wymagany dla tej operacji.
function lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- ifMatch
-
string
Wersja stanu jednostki (ETag) zasad niezmienności do zaktualizowania. Wartość "*" może służyć do zastosowania operacji tylko wtedy, gdy istnieją już zasady niezmienności. W przypadku pominięcia ta operacja będzie zawsze stosowana.
Parametry opcji.
Zwraca
setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)
Ustawia tagi blokady prawnej. Ustawienie tego samego tagu powoduje operację idempotentną. Właściwość SetLegalHold jest zgodna ze wzorcem dołączania i nie usuwa istniejących tagów, które nie zostały określone w żądaniu.
function setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- legalHold
- LegalHold
Właściwość LegalHold, która zostanie ustawiona na kontener obiektów blob.
Parametry opcji.
Zwraca
Promise<LegalHold>
update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)
Aktualizacje właściwości kontenera określone w treści żądania. Właściwości, które nie zostały wymienione w żądaniu, będą niezmienione. Aktualizacja kończy się niepowodzeniem, jeśli określony kontener jeszcze nie istnieje.
function update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- containerName
-
string
Nazwa kontenera obiektów blob w ramach określonego konta magazynu. Nazwy kontenerów obiektów blob muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- blobContainer
- BlobContainer
Właściwości do aktualizacji dla kontenera obiektów blob.
Parametry opcji.
Zwraca
Promise<BlobContainer>