BlobContainers interface
Interface que representa um BlobContainers.
Métodos
| begin |
Esta operação migra um contêiner de blob do WORM no nível do contêiner para o contêiner habilitado para imutabilidade no nível do objeto. Os pré-requisitos exigem uma política de imutabilidade no nível do contêiner no estado bloqueado ou desbloqueado, o controle de versão no nível da conta deve estar habilitado e não deve haver retenção legal no contêiner. |
| begin |
Esta operação migra um contêiner de blob do WORM no nível do contêiner para o contêiner habilitado para imutabilidade no nível do objeto. Os pré-requisitos exigem uma política de imutabilidade no nível do contêiner no estado bloqueado ou desbloqueado, o controle de versão no nível da conta deve estar habilitado e não deve haver retenção legal no contêiner. |
| clear |
Limpa tags de retenção legal. Limpar a mesma tag ou inexistente resulta em uma operação idempotente. ClearLegalHold limpa apenas as tags especificadas na solicitação. |
| create(string, string, string, Blob |
Cria um novo contêiner na conta especificada, conforme descrito pelo corpo da solicitação. O recurso de contêiner inclui metadados e propriedades para esse contêiner. Ele não inclui uma lista dos blobs contidos pelo contêiner. |
| create |
Cria ou atualiza uma política de imutabilidade desbloqueada. ETag em If-Match é honrado se dado, mas não necessário para esta operação. |
| delete(string, string, string, Blob |
Exclui o contêiner especificado em sua conta. |
| delete |
Anula uma política de imutabilidade desbloqueada. A resposta de delete tem immutabilityPeriodSinceCreationInDays definido como 0. ETag em If-Match é necessário para esta operação. A exclusão de uma política de imutabilidade bloqueada não é permitida, a única maneira é excluir o contêiner depois de excluir todos os blobs expirados dentro do contêiner bloqueado pela política. |
| extend |
Estende a imutabilidadePeríodoDesdeCriaçãoInDias de uma política de imutabilidade bloqueada. A única ação permitida em uma política bloqueada será essa ação. ETag em If-Match é necessário para esta operação. |
| get(string, string, string, Blob |
Obtém propriedades de um contêiner especificado. |
| get |
Obtém a política de imutabilidade existente junto com a ETag correspondente nos cabeçalhos e no corpo da resposta. |
| lease(string, string, string, Blob |
A operação Lease Container estabelece e gerencia um bloqueio em um contêiner para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita. |
| list(string, string, Blob |
Lista todos os contêineres e não oferece suporte a um prefixo como plano de dados. Além disso, o SRP hoje não retorna o token de continuação. |
| lock |
Define o estado ImmutabilityPolicy como Locked. A única ação permitida em uma política bloqueada é a ação ExtendImmutabilityPolicy. ETag em If-Match é necessário para esta operação. |
| set |
Define tags de retenção legal. Definir a mesma tag resulta em uma operação idempotente. SetLegalHold segue um padrão de acréscimo e não limpa as tags existentes que não são especificadas na solicitação. |
| update(string, string, string, Blob |
Atualiza as propriedades do contêiner conforme especificado no corpo da solicitação. As propriedades não mencionadas no pedido permanecerão inalteradas. A atualização falhará se o contêiner especificado ainda não existir. |
Detalhes de Método
beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Esta operação migra um contêiner de blob do WORM no nível do contêiner para o contêiner habilitado para imutabilidade no nível do objeto. Os pré-requisitos exigem uma política de imutabilidade no nível do contêiner no estado bloqueado ou desbloqueado, o controle de versão no nível da conta deve estar habilitado e não deve haver retenção legal no contêiner.
function beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Esta operação migra um contêiner de blob do WORM no nível do contêiner para o contêiner habilitado para imutabilidade no nível do objeto. Os pré-requisitos exigem uma política de imutabilidade no nível do contêiner no estado bloqueado ou desbloqueado, o controle de versão no nível da conta deve estar habilitado e não deve haver retenção legal no contêiner.
function beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
Os parâmetros de opções.
Devoluções
Promise<void>
clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)
Limpa tags de retenção legal. Limpar a mesma tag ou inexistente resulta em uma operação idempotente. ClearLegalHold limpa apenas as tags especificadas na solicitação.
function clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- legalHold
- LegalHold
A propriedade LegalHold que será limpa de um contêiner de blob.
Os parâmetros de opções.
Devoluções
Promise<LegalHold>
create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)
Cria um novo contêiner na conta especificada, conforme descrito pelo corpo da solicitação. O recurso de contêiner inclui metadados e propriedades para esse contêiner. Ele não inclui uma lista dos blobs contidos pelo contêiner.
function create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- blobContainer
- BlobContainer
Propriedades do contêiner de blob a ser criado.
Os parâmetros de opções.
Devoluções
Promise<BlobContainer>
createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)
Cria ou atualiza uma política de imutabilidade desbloqueada. ETag em If-Match é honrado se dado, mas não necessário para esta operação.
function createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
Os parâmetros de opções.
Devoluções
delete(string, string, string, BlobContainersDeleteOptionalParams)
Exclui o contêiner especificado em sua conta.
function delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
Os parâmetros de opções.
Devoluções
Promise<void>
deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)
Anula uma política de imutabilidade desbloqueada. A resposta de delete tem immutabilityPeriodSinceCreationInDays definido como 0. ETag em If-Match é necessário para esta operação. A exclusão de uma política de imutabilidade bloqueada não é permitida, a única maneira é excluir o contêiner depois de excluir todos os blobs expirados dentro do contêiner bloqueado pela política.
function deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- ifMatch
-
string
A versão do estado da entidade (ETag) da política de imutabilidade a ser atualizada deve ser retornada ao servidor para todas as operações de atualização. O valor ETag deve incluir as aspas duplas à esquerda e à direita, conforme retornadas pelo serviço.
Os parâmetros de opções.
Devoluções
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)
Estende a imutabilidadePeríodoDesdeCriaçãoInDias de uma política de imutabilidade bloqueada. A única ação permitida em uma política bloqueada será essa ação. ETag em If-Match é necessário para esta operação.
function extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- ifMatch
-
string
A versão do estado da entidade (ETag) da política de imutabilidade a ser atualizada deve ser retornada ao servidor para todas as operações de atualização. O valor ETag deve incluir as aspas duplas à esquerda e à direita, conforme retornadas pelo serviço.
Os parâmetros de opções.
Devoluções
get(string, string, string, BlobContainersGetOptionalParams)
Obtém propriedades de um contêiner especificado.
function get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- options
- BlobContainersGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<BlobContainer>
getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)
Obtém a política de imutabilidade existente junto com a ETag correspondente nos cabeçalhos e no corpo da resposta.
function getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
Os parâmetros de opções.
Devoluções
lease(string, string, string, BlobContainersLeaseOptionalParams)
A operação Lease Container estabelece e gerencia um bloqueio em um contêiner para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita.
function lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
Os parâmetros de opções.
Devoluções
Promise<LeaseContainerResponse>
list(string, string, BlobContainersListOptionalParams)
Lista todos os contêineres e não oferece suporte a um prefixo como plano de dados. Além disso, o SRP hoje não retorna o token de continuação.
function list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- options
- BlobContainersListOptionalParams
Os parâmetros de opções.
Devoluções
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)
Define o estado ImmutabilityPolicy como Locked. A única ação permitida em uma política bloqueada é a ação ExtendImmutabilityPolicy. ETag em If-Match é necessário para esta operação.
function lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- ifMatch
-
string
A versão do estado da entidade (ETag) da política de imutabilidade a ser atualizada deve ser retornada ao servidor para todas as operações de atualização. O valor ETag deve incluir as aspas duplas à esquerda e à direita, conforme retornadas pelo serviço.
Os parâmetros de opções.
Devoluções
setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)
Define tags de retenção legal. Definir a mesma tag resulta em uma operação idempotente. SetLegalHold segue um padrão de acréscimo e não limpa as tags existentes que não são especificadas na solicitação.
function setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- legalHold
- LegalHold
A propriedade LegalHold que será definida como um contêiner de blob.
Os parâmetros de opções.
Devoluções
Promise<LegalHold>
update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)
Atualiza as propriedades do contêiner conforme especificado no corpo da solicitação. As propriedades não mencionadas no pedido permanecerão inalteradas. A atualização falhará se o contêiner especificado ainda não existir.
function update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas.
- containerName
-
string
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes dos contêineres de blob devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.
- blobContainer
- BlobContainer
Propriedades a serem atualizadas para o contêiner de blob.
Os parâmetros de opções.
Devoluções
Promise<BlobContainer>