ShareLeaseClient Klass

Skapar en ny ShareLeaseClient.

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

Arv

builtins.object

ShareLeaseClient

Konstruktor

ShareLeaseClient(client: ShareFileClient | ShareClient, lease_id: str | None = None)

Parametrar

client

ShareFileClient eller ShareClient

Obligatorisk

Klienten för filen eller resursen 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 blir Ingen om inget lån ännu har förvärvats.

etag

str

ETag 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.

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. Den här åtgärden upprättar och hanterar ett lås på en fil eller resurs för skriv- och borttagningsåtgärder. Om filen eller resursen inte har något aktivt lån skapar fil- eller resurstjänsten ett lån för filen eller resursen. Om filen har ett aktivt lån kan du bara begära ett nytt lån med hjälp av det aktiva låne-ID:t. Om filen eller resursen inte har något aktivt lån skapar fil- eller resurstjänsten ett lån för filen och returnerar ett nytt låne-ID.
break_lease	Tvinga bryter lånet om filen eller resursen har ett aktivt lån. Alla auktoriserade begäranden kan bryta lånet; begäran krävs inte för att ange ett matchande låne-ID. Ett oändligt lån bryts omedelbart. När ett lån har brutits kan det inte ändras. 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 har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas.
change	Ändrar låne-ID för ett aktivt lån. En ändring måste innehålla det aktuella låne-ID:t i x-ms-lease-id och ett nytt låne-ID i x-ms-proposed-lease-id.
release	Frigör lånet. Lånet kan frisläppas om låne-ID:t som anges på begäran matchar det som är associerat med resursen eller filen. Om du släpper lånet kan en annan klient omedelbart hämta lånet för resursen eller filen så snart versionen är klar.
renew	Förnyar resurslånet. Resurslånet kan förnyas om det låne-ID som anges i låneklienten matchar det som är associerat med resursen. Observera att lånet kan förnyas även om det har upphört att gälla så länge som aktien inte har hyrts igen sedan lånet löpte ut. När du förnyar ett lån återställs lånetiden. Nytt i version 12.6.0.

acquire

Begär ett nytt lån. Den här åtgärden upprättar och hanterar ett lås på en fil eller resurs för skriv- och borttagningsåtgärder. Om filen eller resursen inte har något aktivt lån skapar fil- eller resurstjänsten ett lån för filen eller resursen. Om filen har ett aktivt lån kan du bara begära ett nytt lån med hjälp av det aktiva låne-ID:t.

Om filen eller resursen inte har något aktivt lån skapar fil- eller resurstjänsten ett lån för filen och returnerar ett nytt låne-ID.

acquire(**kwargs: Any) -> None

Parametrar

lease_duration

int

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

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-file-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

Tvinga bryter lånet om filen eller resursen har ett aktivt lån. Alla auktoriserade begäranden kan bryta lånet; begäran krävs inte för att ange ett matchande låne-ID. Ett oändligt lån bryts omedelbart.

När ett lån har brutits kan det inte ändras. 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 har brutits anger svaret intervallet i sekunder tills ett nytt lån kan förvärvas.

break_lease(**kwargs: Any) -> int

Parametrar

lease_break_period

int

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

Nytt i version 12.6.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-file-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

Ändrar låne-ID för ett aktivt lån. En ändring måste innehålla det aktuella låne-ID:t i x-ms-lease-id och ett nytt låne-ID i x-ms-proposed-lease-id.

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

Parametrar

proposed_lease_id

str

Obligatorisk

Föreslaget låne-ID i ett GUID-strängformat. Fil- eller resurstjänsten genererar ett fel (ogiltig begäran) om det föreslagna låne-ID:t inte har rätt format.

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-file-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 låne-ID:t som anges på begäran matchar det som är associerat med resursen eller filen. Om du släpper lånet kan en annan klient omedelbart hämta lånet för resursen eller filen så snart versionen är klar.

release(**kwargs: Any) -> None

Parametrar

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-file-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 resurslånet.

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

Nytt i version 12.6.0.

renew(**kwargs: Any) -> None

Parametrar

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-file-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