Contêiner de locação

A Lease Container operação 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.

Você pode chamar a Lease Container operação em um dos seguintes modos:

  • Acquire, para solicitar um novo contrato de locação.

  • Renew, para renovar um contrato de locação existente.

  • Change, para alterar o ID de um contrato de locação existente.

  • Release, para liberar o contrato caso não seja mais necessário, para que outro cliente possa imediatamente adquirir um contrato contra o contêiner.

  • Break, para encerrar o contrato, mas garantir que outro cliente não possa adquirir um novo contrato até que o período atual expire.

Observação

A Lease Container operação está disponível na versão 2012-02-12 e posteriores.

Solicitação

Você pode construir a solicitação Lease Container da seguinte maneira. O HTTPS é recomendado. Substitua myaccount pelo nome da sua conta de armazenamento.

Método URI de solicitação Versão HTTP
PUT https://myaccount.blob.core.windows.net/mycontainer?comp=lease&restype=container HTTP/1.1

Para especificar o contêiner raiz, insira $root como nome do contêiner.

URI do serviço de armazenamento emulado

Ao fazer uma solicitação no serviço de armazenamento emulado, especifique o nome do host do emulador e a porta do Armazenamento de Blobs do Azure como 127.0.0.1:10000, seguidos pelo nome da conta de armazenamento emulada.

Método URI de solicitação Versão HTTP
PUT http://127.0.0.1:10000/mycontainer?comp=lease&restype=container HTTP/1.0

HTTP/1.1

Para obter mais informações, consulte Usar o emulador Azurite para o desenvolvimento local do Armazenamento do Azure.

Parâmetros de URI

Você pode especificar o seguinte parâmetro adicional no URI da requisição.

Parâmetro Description
timeout Optional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Definindo tempos limite para operações de Armazenamento de Blobs.

Cabeçalhos de solicitação

A tabela a seguir descreve cabeçalhos de solicitação obrigatórios e opcionais.

Cabeçalho da solicitação Description
Authorization Required. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
Date ou x-ms-date Required. Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
x-ms-version Optional. Especifica a versão da operação a ser usada para essa solicitação. Para obter mais informações, consulte Controle de versão para os serviços de Armazenamento do Azure.
x-ms-lease-id: <ID> Obrigado a renovar, alterar ou liberar o contrato.

Você pode especificar o valor de x-ms-lease-id em qualquer formato válido de string GUID. Veja Construtor Guid (String) para uma lista de formatos válidos.
x-ms-lease-action: <acquire ¦ renew ¦ change ¦ release ¦ break> acquire: Solicita um novo contrato. Se o contêiner não tiver um arrendamento ativo, o Armazenamento de Blobs cria um arrendamento sobre o contêiner e retorna um novo ID de locação. Se o contêiner tiver um contrato de locação ativo, você só pode solicitar um novo contrato usando o ID do contrato ativo. Você pode, no entanto, especificar um novo x-ms-lease duration, incluindo um negativo (-1) para um contrato que nunca expira.

renew: Renova o contrato. Você pode renovar o contrato se o ID especificado na solicitação corresponder ao associado ao contêiner. Note que o contrato pode ser renovado mesmo que tenha expirado, desde que o contêiner não tenha sido alugado novamente desde o término desse contrato. Quando você renova uma concessão, o relógio de duração da concessão é redefinido.

change: Altere o ID do contrato de locação ativo. A change deve incluir o ID atual do contrato em x-ms-lease-id, e um novo ID de aluguel em x-ms-proposed-lease-id.

release: Libere o contrato. Você pode liberar o contrato se o ID especificado na solicitação corresponder ao associado ao contêiner. A liberação do contrato permite que outro cliente adquira imediatamente o contrato do contêiner, assim que a liberação estiver concluída.

break: Rescinda o contrato de locação, se o contêiner tiver um contrato ativo. Depois que o contrato de aluguel é rompido, ele não pode ser renovado. Qualquer solicitação autorizada pode rescindir o contrato de aluguel. O pedido não precisa especificar um ID de contrato correspondente. Quando um contrato de locação é resclado, o período de rescisão do contrato é deixado expirar. Você só pode realizar break e release alugar operações no contêiner durante esse período. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.

Um contrato de aluguel que foi rescindido também pode ser liberado. Um cliente pode adquirir imediatamente um contrato de leasing de contêineres que foi liberado.
x-ms-lease-break-period: N Optional. Para uma break operação, esse cabeçalho é a duração proposta que o arrendamento deve continuar antes de ser quebrado, entre 0 e 60 segundos. Esse período de interrupção só é usado se for menor que o tempo restante do contrato. Se for mais longo, o tempo restante na concessão será usado. Um novo contrato não estará disponível antes do término do período de interrupção, mas o contrato pode ser mantido por mais tempo do que o período de interrupção. Se esse cabeçalho não aparecer com uma break operação, um contrato de duração fixa é encerrado após o término do período restante, e um contrato infinito termina imediatamente.
x-ms-lease-duration: -1 ¦ n seconds Necessário para acquire. Especifica a duração da concessão, em segundos, ou menos uma (-1) para uma concessão que nunca expira. Uma concessão não infinita pode ter entre 15 e 60 segundos. A duração do contrato não pode ser alterada usando renew ou change.
x-ms-proposed-lease-id: <ID> Opcional para acquire, e obrigatório para change. ID de concessão proposta, em um formato de cadeia de caracteres GUID. Armazenamento de Blobs retorna 400 (Invalid request) se o ID proposto de locação não estiver no formato correto. Veja Construtor Guid (String) para uma lista de formatos válidos.
Origin Optional. Especifica a origem de onde a solicitação é emitida. A presença desse cabeçalho resulta em cabeçalhos de compartilhamento de recursos (CORS) de origem cruzada na resposta. Veja o suporte CORS para os serviços de armazenamento para detalhes.
x-ms-client-request-id Optional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres kib (1 kibibyte) que é registrado nos logs quando o registro em log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações recebidas pelo servidor. Para obter mais informações, consulte Monitorar o Armazenamento de Blobs do Azure.

Essa operação também suporta o uso de cabeçalhos condicionais para executar a operação somente se uma condição especificada for atendida. Para obter mais informações, consulte Especificando cabeçalhos condicionais para operações de Armazenamento de Blobs.

Corpo da solicitação

None.

Solicitação de exemplo

O seguinte exemplo de solicitação mostra como adquirir um contrato de locação:

  
Request Syntax:  
PUT https://myaccount.blob.core.windows.net/mycontainer?restype=container&comp=lease HTTP/1.1  
  
Request Headers:  
x-ms-version: 2012-02-12  
x-ms-lease-action: acquire  
x-ms-lease-duration: -1  
x-ms-proposed-lease-id: 1f812371-a41d-49e6-b123-f4b542e851c5  
x-ms-date: Thu, 26 Jan 2012 23:30:18 GMT  
Authorization: SharedKey testaccount1:esSKMOYdK4o+nGTuTyeOLBI+xqnqi6aBmiW4XI699+o=  
  

Resposta

A resposta inclui um código de status HTTP e um conjunto de cabeçalhos de resposta.

Código de status

Os códigos de status de sucesso retornados para operações de arrendamento são os seguintes:

  • Acquire: Uma operação bem-sucedida retorna o código de status 201 (Criado).

  • Renew: Uma operação bem-sucedida retorna o código de status 200 (OK).

  • Change: Uma operação bem-sucedida retorna o código de status 200 (OK).

  • Release: Uma operação bem-sucedida retorna o código de status 200 (OK).

  • Break: Uma operação bem-sucedida retorna o código de status 202 (Aceito).

Para obter informações sobre códigos de status, consulte Status e códigos de erro.

Cabeçalhos de resposta

A resposta dessa operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação de protocolo HTTP/1.1 .

Syntax Description
ETag O ETag para o recipiente. Este cabeçalho é retornado para solicitações feitas contra a versão 2013-08-15 e posteriores, e o ETag valor está entre aspas. Lease Container Operações feitas contra a versão 2013-08-15 e posteriores não modificam essa propriedade, mas versões anteriores sim.
Last-Modified Retornado para solicitações feitas contra a versão 2013-08-15 e posteriores. Retorna a data e a hora em que o contêiner foi modificado pela última vez. Para obter mais informações, consulte Representação de valores de data e hora em cabeçalhos.

Qualquer operação que modifique o contêiner, suas propriedades ou metadados, atualiza o tempo da última modificação. Isso inclui definir as permissões do container. Operações em blobs não afetam o tempo de última modificação do container. Lease Container Operações feitas contra a versão 2013-08-15 e posteriores não modificam essa propriedade, mas versões anteriores sim.
x-ms-lease-id: <id> Quando você solicita um contrato de locação, o Armazenamento de Blobs retorna um ID de arrendamento único. Enquanto o contrato estiver ativo, você deve incluir o ID do contrato em qualquer solicitação para excluir o contêiner, renovar, alterar ou liberar o contrato.

Uma operação de renovação bem-sucedida também retorna o ID do contrato de locação ativo.
x-ms-lease-time: seconds Tempo aproximado restante no período de concessão, em segundos. Esse cabeçalho é devolvido apenas para um pedido bem-sucedido de rescindir o contrato. Se a quebra for imediata, 0 é retornado.
x-ms-request-id Esse cabeçalho identifica exclusivamente a solicitação feita e pode ser usado para solucionar problemas da solicitação. Para obter mais informações, consulte Solução de problemas de operações de API.
x-ms-version Indica a versão do Armazenamento de Blobs usada para executar a solicitação. Esse cabeçalho é retornado para solicitações feitas na versão 2009-09-19 e posterior.
Data Um valor de data/hora UTC que indica a hora em que a resposta foi iniciada. O serviço gera esse valor.
Access-Control-Allow-Origin Devolvido se a solicitação incluir um Origin cabeçalho, e o CORS for ativado com uma regra de correspondência. Esse cabeçalho retorna o valor do cabeçalho de pedido de origem em caso de correspondência.
Access-Control-Expose-Headers Devolvido se a solicitação incluir um Origin cabeçalho, e o CORS for ativado com uma regra de correspondência. Retorna a lista de cabeçalhos de resposta que serão expostos ao cliente ou emissor da solicitação.
Access-Control-Allow-Credentials Retornado se a solicitação incluir um Origin cabeçalho, e o CORS estiver ativado com uma regra de correspondência que não permite todas as origens. Este cabeçalho será definido como true.
x-ms-client-request-id Você pode usar esse cabeçalho para solucionar problemas de solicitações e respostas correspondentes. O valor desse cabeçalho é igual ao valor do cabeçalho x-ms-client-request-id, se ele estiver presente na solicitação. O valor é de no máximo 1.024 caracteres ASCII visíveis. Se o cabeçalho x-ms-client-request-id não estiver presente na solicitação, ele não estará presente na resposta.

Corpo da resposta

None.

Resposta de exemplo

A seguir, uma resposta exemplo para um pedido de aquisição de locação:

Response Status:  
HTTP/1.1 201 Created  
  
Response Headers:  
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cc6b209a-b593-4be1-a38a-dde7c106f402  
x-ms-version: 2012-02-12  
x-ms-lease-id: 1f812371-a41d-49e6-b123-f4b542e851c5  
Date: Thu, 26 Jan 2012 23:30:18 GMT  
  

Authorization

A autorização é necessária quando você está chamando qualquer operação de acesso a dados no Armazenamento do Azure. Você pode autorizar a Lease Container operação conforme descrito nas seções a seguir.

Importante

A Microsoft recomenda usar a ID do Microsoft Entra com identidades gerenciadas para autorizar solicitações ao Armazenamento do Azure. A ID do Microsoft Entra fornece segurança superior e facilidade de uso em comparação com a autorização de Chave Compartilhada.

O Armazenamento do Azure dá suporte ao uso da ID do Microsoft Entra para autorizar solicitações para dados de blob. Com o Microsoft Entra ID, você pode usar o controle de acesso baseado em função (Azure RBAC) do Azure para conceder permissões a um principal de segurança. O principal de segurança pode ser um user, group, application service principal ou identidade gerenciada pelo Azure. A entidade de segurança é autenticada pela ID do Microsoft Entra para retornar um token OAuth 2.0. O token pode então ser usado para autorizar uma solicitação contra o Armazenamento de Blobs.

Para saber mais sobre a autorização usando a ID do Microsoft Entra, consulte Autorizar o acesso a blobs usando a ID do Microsoft Entra.

Permissões

As seguintes ações RBAC são necessárias para que um usuário Microsoft Entra, grupo, identidade gerenciada ou principal de serviço chame a Lease Container operação, e para o papel RBAC embutido do Azure com menor privilégio que inclui essa ação:

Para saber mais sobre como atribuir funções usando o Azure RBAC, veja Atribuir um papel no Azure para acesso a dados de blob.

Remarks

Uma concessão em um contêiner fornece acesso de gravação e exclusão exclusivo ao contêiner. Um leasing de contêiner controla apenas a capacidade de deletar o contêiner usando a operação Delete Container . Para excluir um contêiner com uma concessão ativa, o cliente deve incluir a ID da concessão ativa com a solicitação de exclusão. Se o ID do contrato não for incluído, a operação falha com o 412 (Pré-condição falhada). Todas as outras operações de contêineres têm sucesso em contêineres alugados, sem incluir o ID do leasing. O arrendamento é concedido pelo período especificado quando o contrato é adquirido, que pode ser entre 15 e 60 segundos, ou uma duração infinita.

Quando um cliente adquire um contrato de locação, um ID do contrato é devolvido. Armazenamento de Blobs gera um ID de locação, caso não esteja especificado na solicitação de aquisição. O cliente pode usar esse ID do contrato para renovar, alterar seu ID ou liberar o contrato. O diagrama a seguir mostra os possíveis estados de um arrendamento e os comandos ou eventos que causam mudanças no estado do arrendamento.

Diagrama dos estados do arrendamento de contêineres e gatilhos de mudança de estado.

Um contrato de locação pode ser em um dos cinco estados, dependendo se o contrato está bloqueado ou desbloqueado, e se o contrato é renovável nesse estado. As ações de arrendamento mostradas no diagrama anterior causam transições de estado.

Status de renovação Contrato de locação bloqueada Contrato de locação desbloqueado
Arrendamento renovável Arrendado Expired
Arrendamento não renovável Quebra Quebrado, Disponível
  • Available, o contrato de locação é desbloqueado e pode ser adquirido. Ação permitida: acquire.

  • Leased, o contrato de aluguel está trancado. Ações permitidas: acquire (apenas o mesmo ID de locação), renew, change, release, e break.

  • Expired, a duração do contrato expirou. Ações permitidas: acquire, renew, release, e break.

  • Breaking, o contrato foi resclado, mas continuará bloqueado até o término do período de restrição. Ações permitidas: release e break.

  • Broken, o contrato de locação foi rescindido e o período de interrupção expirou. Ações permitidas: acquire, release, e break.

Armazenamento de Blobs mantém o ID do contrato de locação após o término de um leasing de container. Um cliente pode renovar ou liberar o contrato usando seu ID de contrato expirado. Se o cliente tentar renovar ou liberar um contrato expirado com seu ID de contrato anterior, e a solicitação falhar, então o contêiner foi alugado novamente ou excluído, já que o contrato do cliente estava ativo pela última vez.

Se um contrato de locação expirar em vez de ser explicitamente liberado, o cliente pode precisar esperar até um minuto antes que um novo contrato possa ser adquirido para o contêiner. No entanto, o cliente pode renovar a concessão com a ID expirada imediatamente.

A propriedade do Last-Modified-Time contêiner não é atualizada por chamadas para Lease Container.

As tabelas a seguir mostram os resultados das ações em contêineres com contratos de locação em vários estados de arrendamento. As letras (A), (B) e (C) representam IDs de arrendamento, e (X) representa um ID de arrendamento gerado pelo Armazenamento de Blobs.

Resultados das tentativas de uso em contêineres por estado do arrendamento

Action Available Arrendado (A) Quebra (A) Quebrado (A) Expirado (A)
Exclua com (A) Reprovações (412) Arrendado (A), exclusão é bem-sucedida Quebrar (A), excluir é bem-sucedido Reprovações (412) Reprovações (412)
Exclua com (B) Reprovações (412) Reprovações (409) Reprovações (412) Reprovações (412) Reprovações (412)
Excluir, sem contrato especificado Disponível, exclusão bem-sucedida Reprovações (412) Reprovações (412) Disponível, exclusão bem-sucedida Disponível, exclusão bem-sucedida
Outras operações com (A) Reprovações (412) Arrendado (A), operação bem-sucedida Quebra (A), operação bem-sucedida Reprovações (412) Reprovações (412)
Outras operações com (B) Reprovações (412) Reprovações (409) Reprovações (409) Reprovações (412) Reprovações (412)
Operações, sem contrato de locação especificado Disponível, operação bem-sucedida Arrendado (A), operação bem-sucedida Quebra (A), operação bem-sucedida Quebrado (A), operação bem-sucedida Expirado (A), operação bem-sucedida

Resultados das operações de arrendamento de contêineres por estado do arrendamento

Action Available Arrendado (A) Quebra (A) Quebrado (A) Expirado (A)
Acquire, sem ID de contrato proposto Arrendado (X) Reprovações (409) Reprovações (409) Arrendado (X) Arrendado (X)
Acquire (A) Arrendado (A) Locado (A), nova duração Reprovações (409) Arrendado (A) Arrendado (A)
Acquire (B) Arrendado (B) Reprovações (409) Reprovações (409) Arrendado (B) Arrendado (B)
Break, período=0 Reprovações (409) Quebrado (A) Quebrado (A) Quebrado (A) Quebrado (A)
Break, período>0 Reprovações (409) Quebra (A) Quebra (A) Quebrado (A) Quebrado (A)
Change, (A) a (B) Reprovações (409) Arrendado (B) Reprovações (409) Reprovações (409) Reprovações (409)
Change, (B) até (A) Reprovações (409) Arrendado (A) Reprovações (409) Reprovações (409) Reprovações (409)
Change, (B) a (C) Reprovações (409) Reprovações (409) Reprovações (409) Reprovações (409) Reprovações (409)
Renew (A) Reprovações (409) Alugado (A), resetar o relógio de expiração Reprovações (409) Reprovações (409) Arrendado (A)
Renew (B) Reprovações (409) Reprovações (409) Reprovações (409) Reprovações (409) Reprovações (409)
Release (A) Reprovações (409) Available Available Available Available
Release (B) Reprovações (409) Reprovações (409) Reprovações (409) Reprovações (409) Reprovações (409)
Duração expira Available Expirado (A) Quebrado (A) Quebrado (A) Expirado (A)

Faturamento

As solicitações de preços podem ser originadas de clientes que usam APIs de Armazenamento de Blobs, diretamente por meio da API REST do Armazenamento de Blobs ou de uma biblioteca de clientes do Armazenamento do Azure. Essas solicitações acumulam encargos por transação. O tipo de transação afeta a forma como a conta é cobrada. Por exemplo, as transações de leitura se acumulam em uma categoria de cobrança diferente das transações de gravação. A tabela a seguir mostra a categoria de cobrança para solicitações Lease Container com base no tipo de conta de armazenamento:

Operation Tipo de conta de armazenamento Categoria de cobrança
Contêiner de Arrendamento (adquirir, liberar, renovar) Blob de blocos premium
Padrão de uso geral v2
Outras operações
Contêiner de Arrendamento (adquirir, liberar, renovar) Padrão de uso geral v1 Operações de leitura
Contêiner de Leasing (intervalo, troca) Blob de blocos premium
Padrão de uso geral v2
Outras operações
Contêiner de Leasing (intervalo, troca) Padrão de uso geral v1 Operações de escrita

Para saber mais sobre os preços da categoria de cobrança especificada, consulte de Preços do Armazenamento de Blobs do Azure.

Consulte também

Autorizar solicitações para o Armazenamento do Azure
Status e códigos de erro
Códigos de erro do Armazenamento de Blobs
Concessão de blob