BlobLeaseClient Classe

Cria um novo BlobLeaseClient.

Este cliente fornece operações de concessão num BlobClient ou ContainerClient.

Herança

builtins.object

BlobLeaseClient

Construtor

BlobLeaseClient(client: BlobClient | ContainerClient, lease_id: str | None = None)

Parâmetros

client

BlobClient ou ContainerClient

Necessário

O cliente do blob ou contentor a alugar.

lease_id

str

valor predefinido: None

Uma cadeia que representa o ID de concessão de uma concessão existente. Este valor não precisa de ser especificado para adquirir uma nova concessão ou quebrar uma.

Variáveis

id

str

O ID da concessão atualmente a ser mantida. Esta será Nenhuma se ainda não tiver sido adquirida nenhuma concessão.

etag

str

A ETag da concessão atualmente a ser mantida. Esta será Nenhuma se ainda não tiver sido adquirida ou modificada nenhuma concessão.

last_modified

datetime

O último carimbo de data/hora modificado da concessão atualmente a ser mantida. Esta será Nenhuma se ainda não tiver sido adquirida ou modificada nenhuma concessão.

Métodos

acquire	Pede uma nova concessão. Se o contentor não tiver uma concessão ativa, o serviço Blob cria uma concessão no contentor e devolve um novo ID de concessão.
break_lease	Quebre a concessão, se o contentor ou blob tiver uma concessão ativa. Depois de uma concessão ser interrompida, não pode ser renovada. Qualquer pedido autorizado pode interromper a concessão; o pedido não é necessário para especificar um ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual nenhuma operação de concessão, exceto quebra e libertação, pode ser realizada no contentor ou blob. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.
change	Altere o ID de concessão de uma concessão ativa.
release	Liberte a concessão. A concessão poderá ser libertada se o ID de concessão do cliente especificado corresponder ao associado ao contentor ou blob. Libertar a concessão permite que outro cliente adquira imediatamente a concessão para o contentor ou blob assim que a versão estiver concluída.
renew	Renova a concessão. A concessão pode ser renovada se o ID de concessão especificado no cliente de concessão corresponder ao associado ao contentor ou blob. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado, desde que o contentor ou blob não tenha sido novamente arrendado desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto.

acquire

Pede uma nova concessão.

Se o contentor não tiver uma concessão ativa, o serviço Blob cria uma concessão no contentor e devolve um novo ID de concessão.

acquire(lease_duration: int = -1, **kwargs: Any) -> None

Parâmetros

lease_duration

int

Necessário

Especifica a duração da concessão, em segundos ou negativa (-1) para uma concessão que nunca expira. Uma concessão não infinita pode ser entre 15 e 60 segundos. Não é possível alterar a duração da concessão através da renovação ou alteração. A predefinição é -1 (concessão infinita).

if_modified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor ETag ou o caráter universal (*). Utilizado para verificar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition .

match_condition

MatchConditions

A condição de correspondência a utilizar no etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Tipo de retorno

None

break_lease

Quebre a concessão, se o contentor ou blob tiver uma concessão ativa.

Depois de uma concessão ser interrompida, não pode ser renovada. Qualquer pedido autorizado pode interromper a concessão; o pedido não é necessário para especificar um ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual nenhuma operação de concessão, exceto quebra e libertação, pode ser realizada no contentor ou blob. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.

break_lease(lease_break_period: int | None = None, **kwargs: Any) -> int

Parâmetros

lease_break_period

int

Necessário

Esta é a duração proposta de segundos que a concessão deve continuar antes de ser quebrada, entre 0 e 60 segundos. Este período de interrupção só é utilizado se for mais curto do que o tempo restante na concessão. Se for mais longo, é utilizado o tempo restante na concessão. Uma nova concessão não estará disponível antes de o período de interrupção expirar, mas a concessão pode ser mantida por mais tempo do que o período de interrupção. Se este cabeçalho não aparecer com uma operação de interrupção, uma concessão de duração fixa é interrompida após o período de concessão restante terminar e uma concessão infinita quebra imediatamente.

if_modified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

if_tags_match_condition

str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Tempo aproximado restante no período de concessão, em segundos.

Tipo de retorno

int

change

Altere o ID de concessão de uma concessão ativa.

change(proposed_lease_id: str, **kwargs: Any) -> None

Parâmetros

proposed_lease_id

str

Necessário

ID de concessão proposto, num formato de cadeia GUID. O serviço Blob devolve 400 (Pedido inválido) se o ID de concessão proposto não estiver no formato correto.

if_modified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor ETag ou o caráter universal (*). Utilizado para verificar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition .

match_condition

MatchConditions

A condição de correspondência a utilizar no etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Nenhuma

release

Liberte a concessão.

A concessão poderá ser libertada se o ID de concessão do cliente especificado corresponder ao associado ao contentor ou blob. Libertar a concessão permite que outro cliente adquira imediatamente a concessão para o contentor ou blob assim que a versão estiver concluída.

release(**kwargs: Any) -> None

Parâmetros

if_modified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor ETag ou o caráter universal (*). Utilizado para verificar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition .

match_condition

MatchConditions

A condição de correspondência a utilizar no etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Nenhuma

renew

Renova a concessão.

A concessão pode ser renovada se o ID de concessão especificado no cliente de concessão corresponder ao associado ao contentor ou blob. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado, desde que o contentor ou blob não tenha sido novamente arrendado desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto.

renew(**kwargs: Any) -> None

Parâmetros

if_modified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Um valor DateTime. O Azure espera que o valor de data transmitido seja UTC. Se o fuso horário estiver incluído, quaisquer datetimes não UTC serão convertidos em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data/hora especificada.

etag

str

Um valor ETag ou o caráter universal (*). Utilizado para verificar se o recurso foi alterado e agir de acordo com a condição especificada pelo parâmetro match_condition .

match_condition

MatchConditions

A condição de correspondência a utilizar no etag.

if_tags_match_condition

str

Especifique um SQL em que a cláusula nas etiquetas de blob funcione apenas no blob com um valor correspondente. Por exemplo, "\"tagname\"='my tag'"

Novidade na versão 12.4.0.

timeout

int

Define o tempo limite do lado do servidor para a operação em segundos. Para obter mais detalhes, veja https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Este valor não é controlado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, veja aqui.

Devoluções

Nenhuma