BlobLeaseClient Classe
Cria um novo BlobLeaseClient.
Esse cliente fornece operações de concessão em um BlobClient ou ContainerClient.
- Herança
-
azure.storage.blob._lease.BlobLeaseClientBlobLeaseClient
Construtor
BlobLeaseClient(client: BlobClient | ContainerClient, lease_id: str | None = None)
Parâmetros
- lease_id
- str
Uma cadeia de caracteres que representa a ID de concessão de uma concessão existente. Esse valor não precisa ser especificado para adquirir uma nova concessão ou interromper uma.
Variáveis
- id
- str
A ID da concessão que está sendo mantida no momento. Este será None se nenhuma concessão ainda tiver sido adquirida.
- etag
- str
A ETag da concessão que está sendo mantida no momento. Isso será Nenhum se nenhuma concessão ainda tiver sido adquirida ou modificada.
- last_modified
- datetime
O último carimbo de data/hora modificado da concessão que está sendo mantida no momento. Isso será Nenhum se nenhuma concessão ainda tiver sido adquirida ou modificada.
Métodos
acquire |
Solicita uma nova concessão. Se o contêiner não tiver uma concessão ativa, o serviço Blob criará uma no contêiner e retornará uma nova ID de concessão. |
break_lease |
Quebre a concessão, se o contêiner ou o blob tiver uma concessão ativa. Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrido, durante o qual nenhuma operação de concessão, exceto interrupção e versão, pode ser executada no contêiner ou blob. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. |
change |
Altere a ID de concessão de uma concessão ativa. |
release |
Libera a concessão. A concessão poderá ser liberada se a ID de concessão do cliente especificada corresponder à associada ao contêiner ou blob. Liberar a concessão permite que outro cliente adquira imediatamente a concessão para o contêiner ou blob assim que a versão for concluída. |
renew |
Renova a concessão. A concessão poderá ser renovada se a ID de concessão especificada no cliente de concessão corresponder à associada ao contêiner ou blob. Observe que a concessão pode ser renovada mesmo que tenha expirado desde que o contêiner ou blob não tenha sido concedido novamente desde a expiração dessa concessão. Quando você renova uma concessão, o relógio de duração é redefinido. |
acquire
Solicita uma nova concessão.
Se o contêiner não tiver uma concessão ativa, o serviço Blob criará uma no contêiner e retornará uma nova ID de concessão.
async acquire(lease_duration: int = -1, **kwargs: Any) -> None
Parâmetros
- lease_duration
- int
Especifica a duração de concessão, em segundos, ou um negativo (- 1) para uma concessão que nunca expira. A duração de uma concessão não infinita pode ser entre 15 e 60 segundos. Uma duração de concessão não pode ser alterada usando renovação ou alteração. O padrão é -1 (concessão infinita).
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente 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 passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado 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 ser usada na etag.
- if_tags_match_condition
- str
Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo 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 informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Tipo de retorno
break_lease
Quebre a concessão, se o contêiner ou o blob tiver uma concessão ativa.
Uma vez interrompida a concessão, não é possível renová-la. Qualquer solicitação autorizada pode interromper a concessão; a solicitação não precisa especificar uma ID de concessão correspondente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrido, durante o qual nenhuma operação de concessão, exceto interrupção e versão, pode ser executada no contêiner ou blob. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida.
async break_lease(lease_break_period: int | None = None, **kwargs: Any) -> int
Parâmetros
- lease_break_period
- int
Esta é a duração proposta de segundos que a concessão deve continuar antes de ser quebrada, entre 0 e 60 segundos. Esse ponto de interrupção é usado somente se for menor do que o tempo restante da concessão. Se for mais longo, o tempo restante da concessão será usado. Uma nova concessão só estará disponível após a expiração do ponto de interrupção, mas a concessão poderá ser mantida por mais tempo do que o período de interrupção. Se esse cabeçalho não aparecer com uma operação de interrupção, uma concessão de duração fixa será interrompida após o período de concessão restante decorrido e uma concessão infinita será interrompida imediatamente.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente 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 passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente 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 em marcas de blob opere somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo 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 informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Tempo aproximado restante do período de concessão, em segundos.
Tipo de retorno
change
Altere a ID de concessão de uma concessão ativa.
async change(proposed_lease_id: str, **kwargs: Any) -> None
Parâmetros
- proposed_lease_id
- str
ID proposta da concessão, em um formato de cadeia de caracteres GUID. O serviço Blob retornará 400 (solicitação inválida) se a ID de concessão proposta não estiver no formato correto.
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente 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 passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado 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 ser usada na etag.
- if_tags_match_condition
- str
Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo 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 informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, confira aqui.
Retornos
Nenhum
release
Libera a concessão.
A concessão poderá ser liberada se a ID de concessão do cliente especificada corresponder à associada ao contêiner ou blob. Liberar a concessão permite que outro cliente adquira imediatamente a concessão para o contêiner ou blob assim que a versão for concluída.
async release(**kwargs: Any) -> None
Parâmetros
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente 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 passado seja UTC. Se o fuso horário estiver incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, supõe-se que seja UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado 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 ser usada na etag.
- if_tags_match_condition
- str
Especifique um SQL em que a cláusula em marcas de blob opere somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo 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 informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
Retornos
Nenhum
renew
Renova a concessão.
A concessão poderá ser renovada se a ID de concessão especificada no cliente de concessão corresponder à associada ao contêiner ou blob. Observe que a concessão pode ser renovada mesmo que tenha expirado desde que o contêiner ou blob não tenha sido concedido novamente desde a expiração dessa concessão. Quando você renova uma concessão, o relógio de duração é redefinido.
async renew(**kwargs: Any) -> None
Parâmetros
- if_modified_since
- datetime
Um valor Datetime. O Azure espera que o valor de data passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente 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 passado seja UTC. Se o fuso horário for incluído, todos os datetimes não UTC serão convertidos em UTC. Se uma data for passada sem informações de fuso horário, será considerado UTC. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data/hora especificada.
- etag
- str
Um valor de ETag ou o caractere curinga (*). Usado 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 ser usada na etag.
- if_tags_match_condition
- str
Especifique uma cláusula SQL em que as marcas de blob operem somente no blob com um valor correspondente.
ex. "\"tagname\"='my tag'"
Novo 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 informações, confira https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Esse valor não é rastreado ou validado no cliente. Para configurar tempos limite de rede do lado do cliente, consulte aqui.
Retornos
Nenhum
Azure SDK for Python