Partager via


BlobContainers interface

Interface représentant un BlobContainers.

Méthodes

beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)

Cette opération migre un conteneur d’objets blob de WORM au niveau du conteneur vers un conteneur compatible avec l’immuabilité au niveau de l’objet. Les prérequis nécessitent une stratégie d’immuabilité au niveau du conteneur à l’état verrouillé ou déverrouillé, le contrôle de version au niveau du compte doit être activé et il ne doit pas y avoir de conservation légale sur le conteneur.

beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)

Cette opération migre un conteneur d’objets blob de WORM au niveau du conteneur vers un conteneur compatible avec l’immuabilité au niveau de l’objet. Les prérequis nécessitent une stratégie d’immuabilité au niveau du conteneur à l’état verrouillé ou déverrouillé, le contrôle de version au niveau du compte doit être activé et il ne doit pas y avoir de conservation légale sur le conteneur.

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

Efface les balises de conservation légales. L’effacement de la balise identique ou inexistante entraîne une opération idempotente. ClearLegalHold efface uniquement les balises spécifiées dans la requête.

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

Crée un conteneur sous le compte spécifié, comme décrit par le corps de la demande. La ressource de conteneur inclut les métadonnées et les propriétés pour ce conteneur. Elle ne comprend pas une liste des objets blob du conteneur.

createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)

Crée ou met à jour une stratégie d’immuabilité déverrouillée. ETag dans If-Match est respecté s’il est donné, mais pas obligatoire pour cette opération.

delete(string, string, string, BlobContainersDeleteOptionalParams)

Supprime le conteneur spécifié sous son compte.

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

Abandonne une stratégie d’immuabilité déverrouillée. La réponse de la suppression a immuabilitéPeriodSinceCreationInDays définie sur 0. ETag dans If-Match est requis pour cette opération. La suppression d’une stratégie d’immuabilité verrouillée n’est pas autorisée. La seule façon consiste à supprimer le conteneur après la suppression de tous les objets blob expirés à l’intérieur du conteneur verrouillé par stratégie.

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

Étend l’immuabilitéPeriodSinceCreationInDays d’une immuabilitéPolicy verrouillée. La seule action autorisée sur une stratégie verrouillée est cette action. ETag dans If-Match est requis pour cette opération.

get(string, string, string, BlobContainersGetOptionalParams)

Obtient les propriétés d’un conteneur spécifié.

getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)

Obtient la stratégie d’immuabilité existante ainsi que l’ETag correspondant dans les en-têtes de réponse et le corps.

lease(string, string, string, BlobContainersLeaseOptionalParams)

L’opération De location de conteneur établit et gère un verrou sur un conteneur pour les opérations de suppression. La durée du verrou peut être de 15 à 60 secondes, ou peut être infinie.

list(string, string, BlobContainersListOptionalParams)

Répertorie tous les conteneurs et ne prend pas en charge un préfixe tel que le plan de données. De plus, SRP aujourd’hui ne retourne pas de jeton de continuation.

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

Définit ImmutabilityPolicy sur l’état Verrouillé. La seule action autorisée sur une stratégie verrouillée est l’action ExtendImmutabilityPolicy. ETag dans If-Match est requis pour cette opération.

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

Définit des balises de conservation légales. La définition de la même balise entraîne une opération idempotente. SetLegalHold suit un modèle d’ajout et n’efface pas les balises existantes qui ne sont pas spécifiées dans la requête.

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

Mises à jour propriétés de conteneur spécifiées dans le corps de la requête. Les propriétés non mentionnées dans la demande resteront inchangées. La mise à jour échoue si le conteneur spécifié n’existe pas déjà.

Détails de la méthode

beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)

Cette opération migre un conteneur d’objets blob de WORM au niveau du conteneur vers un conteneur compatible avec l’immuabilité au niveau de l’objet. Les prérequis nécessitent une stratégie d’immuabilité au niveau du conteneur à l’état verrouillé ou déverrouillé, le contrôle de version au niveau du compte doit être activé et il ne doit pas y avoir de conservation légale sur le conteneur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

options
BlobContainersObjectLevelWormOptionalParams

Paramètres d’options.

Retours

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

beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)

Cette opération migre un conteneur d’objets blob de WORM au niveau du conteneur vers un conteneur compatible avec l’immuabilité au niveau de l’objet. Les prérequis nécessitent une stratégie d’immuabilité au niveau du conteneur à l’état verrouillé ou déverrouillé, le contrôle de version au niveau du compte doit être activé et il ne doit pas y avoir de conservation légale sur le conteneur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

options
BlobContainersObjectLevelWormOptionalParams

Paramètres d’options.

Retours

Promise<void>

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

Efface les balises de conservation légales. L’effacement de la balise identique ou inexistante entraîne une opération idempotente. ClearLegalHold efface uniquement les balises spécifiées dans la requête.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

legalHold
LegalHold

Propriété LegalHold qui sera effacée d’un conteneur d’objets blob.

options
BlobContainersClearLegalHoldOptionalParams

Paramètres d’options.

Retours

Promise<LegalHold>

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

Crée un conteneur sous le compte spécifié, comme décrit par le corps de la demande. La ressource de conteneur inclut les métadonnées et les propriétés pour ce conteneur. Elle ne comprend pas une liste des objets blob du conteneur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

blobContainer
BlobContainer

Propriétés du conteneur d’objets blob à créer.

options
BlobContainersCreateOptionalParams

Paramètres d’options.

Retours

Promise<BlobContainer>

createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)

Crée ou met à jour une stratégie d’immuabilité déverrouillée. ETag dans If-Match est respecté s’il est donné, mais pas obligatoire pour cette opération.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

Retours

delete(string, string, string, BlobContainersDeleteOptionalParams)

Supprime le conteneur spécifié sous son compte.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

options
BlobContainersDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

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

Abandonne une stratégie d’immuabilité déverrouillée. La réponse de la suppression a immuabilitéPeriodSinceCreationInDays définie sur 0. ETag dans If-Match est requis pour cette opération. La suppression d’une stratégie d’immuabilité verrouillée n’est pas autorisée. La seule façon consiste à supprimer le conteneur après la suppression de tous les objets blob expirés à l’intérieur du conteneur verrouillé par stratégie.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

ifMatch

string

Version de l’état de l’entité (ETag) de la stratégie d’immuabilité à mettre à jour. La valeur « * » peut être utilisée pour appliquer l’opération uniquement si la stratégie d’immuabilité existe déjà. Si elle est omise, cette opération est toujours appliquée.

options
BlobContainersDeleteImmutabilityPolicyOptionalParams

Paramètres d’options.

Retours

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

Étend l’immuabilitéPeriodSinceCreationInDays d’une immuabilitéPolicy verrouillée. La seule action autorisée sur une stratégie verrouillée est cette action. ETag dans If-Match est requis pour cette opération.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

ifMatch

string

Version de l’état de l’entité (ETag) de la stratégie d’immuabilité à mettre à jour. La valeur « * » peut être utilisée pour appliquer l’opération uniquement si la stratégie d’immuabilité existe déjà. Si elle est omise, cette opération est toujours appliquée.

options
BlobContainersExtendImmutabilityPolicyOptionalParams

Paramètres d’options.

Retours

get(string, string, string, BlobContainersGetOptionalParams)

Obtient les propriétés d’un conteneur spécifié.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

options
BlobContainersGetOptionalParams

Paramètres d’options.

Retours

Promise<BlobContainer>

getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)

Obtient la stratégie d’immuabilité existante ainsi que l’ETag correspondant dans les en-têtes de réponse et le corps.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

options
BlobContainersGetImmutabilityPolicyOptionalParams

Paramètres d’options.

Retours

lease(string, string, string, BlobContainersLeaseOptionalParams)

L’opération De location de conteneur établit et gère un verrou sur un conteneur pour les opérations de suppression. La durée du verrou peut être de 15 à 60 secondes, ou peut être infinie.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

options
BlobContainersLeaseOptionalParams

Paramètres d’options.

Retours

list(string, string, BlobContainersListOptionalParams)

Répertorie tous les conteneurs et ne prend pas en charge un préfixe tel que le plan de données. De plus, SRP aujourd’hui ne retourne pas de jeton de continuation.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

options
BlobContainersListOptionalParams

Paramètres d’options.

Retours

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

Définit ImmutabilityPolicy sur l’état Verrouillé. La seule action autorisée sur une stratégie verrouillée est l’action ExtendImmutabilityPolicy. ETag dans If-Match est requis pour cette opération.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

ifMatch

string

Version de l’état de l’entité (ETag) de la stratégie d’immuabilité à mettre à jour. La valeur « * » peut être utilisée pour appliquer l’opération uniquement si la stratégie d’immuabilité existe déjà. Si elle est omise, cette opération est toujours appliquée.

options
BlobContainersLockImmutabilityPolicyOptionalParams

Paramètres d’options.

Retours

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

Définit des balises de conservation légales. La définition de la même balise entraîne une opération idempotente. SetLegalHold suit un modèle d’ajout et n’efface pas les balises existantes qui ne sont pas spécifiées dans la requête.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

legalHold
LegalHold

Propriété LegalHold qui sera définie sur un conteneur d’objets blob.

options
BlobContainersSetLegalHoldOptionalParams

Paramètres d’options.

Retours

Promise<LegalHold>

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

Mises à jour propriétés de conteneur spécifiées dans le corps de la requête. Les propriétés non mentionnées dans la demande resteront inchangées. La mise à jour échoue si le conteneur spécifié n’existe pas déjà.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

accountName

string

Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.

containerName

string

Nom du conteneur d’objets blob dans le compte de stockage spécifié. Les noms de conteneurs d’objets blob doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.

blobContainer
BlobContainer

Propriétés à mettre à jour pour le conteneur d’objets blob.

options
BlobContainersUpdateOptionalParams

Paramètres d’options.

Retours

Promise<BlobContainer>