BlobLeaseClient Klass

Skapar en ny BlobLeaseClient.

Den här klienten tillhandahåller låneåtgärder på en BlobClient eller ContainerClient.

Arv

builtins.object

BlobLeaseClient

Konstruktor

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

Parametrar

client

BlobClient eller ContainerClient

Obligatorisk

Klienten för bloben eller containern som ska leasas.

lease_id

str

standardvärde: None

En sträng som representerar låne-ID för ett befintligt lån. Det här värdet behöver inte anges för att hämta ett nytt lån eller bryta ett.

Variabler

id

str

ID:t för lånet som för närvarande underhålls. Detta kommer att vara Ingen om inget lån ännu har förvärvats.

etag

str

ETag av lånet håller för närvarande på att underhållas. Detta blir Ingen om inget lån ännu har förvärvats eller ändrats.

last_modified

datetime

Den senast ändrade tidsstämpeln för lånet som för närvarande underhålls. Detta blir Ingen om inget lån ännu har förvärvats eller ändrats.

Metoder

acquire	Begär ett nytt lån. Om containern inte har något aktivt lån skapar Blob-tjänsten ett lån för containern och returnerar ett nytt låne-ID.
break_lease	Bryt lånet om containern eller bloben har ett aktivt lån. När ett lån har brutits kan det inte förnyas. Alla auktoriserade begäranden kan bryta lånet; begäran krävs inte för att ange ett matchande låne-ID. När ett lån bryts tillåts låneavbrottsperioden att förflutit, under vilken tid ingen låneåtgärd förutom avbrott och frisläppning kan utföras på containern eller bloben. När ett lån har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas.
change	Ändra låne-ID för ett aktivt lån.
release	Frigör lånet. Lånet kan frisläppas om det angivna klientlåne-ID:t matchar det som är associerat med containern eller bloben. Genom att frigöra lånet kan en annan klient omedelbart hämta lånet för containern eller bloben så snart lanseringen är klar.
renew	Förnyar lånet. Lånet kan förnyas om det låne-ID som anges i låneklienten matchar det som är associerat med containern eller bloben. Observera att lånet kan förnyas även om det har upphört att gälla så länge containern eller blobben inte har hyrts igen sedan lånet löpte ut. När du förnyar ett lån återställs lånetidsklockan.

acquire

Begär ett nytt lån.

Om containern inte har något aktivt lån skapar Blob-tjänsten ett lån för containern och returnerar ett nytt låne-ID.

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

Parametrar

lease_duration

int

Obligatorisk

Anger varaktigheten för lånet, i sekunder eller negativt (-1) för ett lån som aldrig upphör att gälla. Ett icke-oändligt lån kan vara mellan 15 och 60 sekunder. Det går inte att ändra lånetiden med förnyelse eller ändring. Standardvärdet är -1 (oändligt lån).

if_modified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag

str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag.

if_tags_match_condition

str

Ange en SQL where-sats för blobtaggar som endast ska användas på blob med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Nytt i version 12.4.0.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

None

break_lease

Bryt lånet om containern eller bloben har ett aktivt lån.

När ett lån har brutits kan det inte förnyas. Alla auktoriserade begäranden kan bryta lånet; begäran krävs inte för att ange ett matchande låne-ID. När ett lån bryts tillåts låneavbrottsperioden att förflutit, under vilken tid ingen låneåtgärd förutom avbrott och frisläppning kan utföras på containern eller bloben. När ett lån har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas.

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

Parametrar

lease_break_period

int

Obligatorisk

Det här är den föreslagna varaktigheten på sekunder som lånet ska fortsätta innan det bryts, mellan 0 och 60 sekunder. Den här brytperioden används endast om den är kortare än den tid som återstår för lånet. Om det är längre används den återstående tiden för lånet. Ett nytt lån kommer inte att vara tillgängligt innan brytperioden har gått ut, men lånet kan hållas längre än brytperioden. Om det här huvudet inte visas med en avbrottsåtgärd bryts ett lån med fast varaktighet efter att den återstående låneperioden har gått ut och ett oändligt lån bryts omedelbart.

if_modified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

if_tags_match_condition

str

Ange en SQL where-sats för blobtaggar som endast ska användas på blob med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Nytt i version 12.4.0.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ungefärlig tid som återstår i låneperioden, i sekunder.

Returtyp

int

change

Ändra låne-ID för ett aktivt lån.

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

Parametrar

proposed_lease_id

str

Obligatorisk

Föreslaget låne-ID i ett GUID-strängformat. Blob-tjänsten returnerar 400 (ogiltig begäran) om det föreslagna låne-ID:t inte har rätt format.

if_modified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag

str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag.

if_tags_match_condition

str

Ange en SQL where-sats för blobtaggar som endast ska användas på blob med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Nytt i version 12.4.0.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ingen

release

Frigör lånet.

Lånet kan frisläppas om det angivna klientlåne-ID:t matchar det som är associerat med containern eller bloben. Genom att frigöra lånet kan en annan klient omedelbart hämta lånet för containern eller bloben så snart lanseringen är klar.

release(**kwargs: Any) -> None

Parametrar

if_modified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag

str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag.

if_tags_match_condition

str

Ange en SQL where-sats för blobtaggar som endast ska användas på blob med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Ny i version 12.4.0.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ingen

renew

Förnyar lånet.

Lånet kan förnyas om det låne-ID som anges i låneklienten matchar det som är associerat med containern eller bloben. Observera att lånet kan förnyas även om det har upphört att gälla så länge containern eller blobben inte har hyrts igen sedan lånet löpte ut. När du förnyar ett lån återställs lånetidsklockan.

renew(**kwargs: Any) -> None

Parametrar

if_modified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag

str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag.

if_tags_match_condition

str

Ange en SQL where-sats för blobtaggar som endast ska användas på blobar med ett matchande värde. t.ex. "\"tagname\"='my tag'"

Ny i version 12.4.0.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ingen