queue Balíček

  • Reference

Balíčky

aio

Třídy

AccessPolicy

Třída zásad přístupu používaná metodami zásad přístupu set a get.

Uložené zásady přístupu můžou určovat čas zahájení, čas vypršení platnosti a oprávnění pro sdílené přístupové podpisy, ke kterým jsou přidružené. V závislosti na tom, jak chcete řídit přístup k vašemu prostředku, můžete zadat všechny tyto parametry v rámci uložených zásad přístupu a vynechat je z adresy URL sdíleného přístupového podpisu. To vám umožní kdykoli změnit chování přidruženého podpisu a také ho odvolat. Nebo můžete zadat jeden nebo více parametrů zásad přístupu v rámci uložených zásad přístupu a ostatní na adrese URL. Nakonec můžete zadat všechny parametry adresy URL. V takovém případě můžete pomocí uložených zásad přístupu podpis odvolat, ale ne změnit jeho chování.

Sdílený přístupový podpis a uložené zásady přístupu musí společně obsahovat všechna pole potřebná k ověření podpisu. Pokud některá požadovaná pole chybí, požadavek se nezdaří. Podobně pokud je pole zadané v adrese URL sdíleného přístupového podpisu i v uložených zásadách přístupu, požadavek selže se stavovým kódem 400 (Chybný požadavek).
AccountSasPermissions

ResourceTypes třída, která se má použít s funkcí generate_account_sas a pro accesspolicies používané s set_*_acl. Existují dva typy SAS, které se dají použít k udělení přístupu k prostředkům. Jedním z nich je udělení přístupu ke konkrétnímu prostředku (specifickému prostředku). Další je udělit přístup k celé službě pro konkrétní účet a povolit určité operace založené na příkladech, které najdete tady.
BinaryBase64DecodePolicy

Zásady dekódování zpráv pro základní zprávy s kódováním 64 na bajty

Dekóduje zprávy s kódováním base64 na bajty. Pokud vstupní obsah není platný základ 64, bude vyvolána chyba DecodeError.
BinaryBase64EncodePolicy

Základní zásady kódování 64 zpráv pro binární zprávy

Kóduje binární zprávy do základu 64. Pokud vstupní obsah není bajtů, vyvolá se Chyba TypeError.
CorsRule

CORS je funkce HTTP, která umožňuje webové aplikaci spuštěné v jedné doméně přistupovat k prostředkům v jiné doméně. Webové prohlížeče implementují omezení zabezpečení označované jako zásada stejného původu, které webové stránce znemožňuje volat rozhraní API v jiné doméně. CORS přináší zabezpečený způsob, jak je možné jedné doméně (tj. původní doméně) povolit volání rozhraní API v jiné doméně.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.
ExponentialRetry

Exponenciální opakování.

Vytvoří objekt Exponenciální opakování. Pro první opakování se použije initial_backoff. Další opakování se po initial_backoff + increment_power^retry_count sekundách zopakují.
LinearRetry

Lineární opakování.

Vytvoří objekt lineárního opakování.
LocationMode

Určuje umístění, do které se má požadavek odeslat. Tento režim platí jenom pro účty RA-GRS, které umožňují sekundární přístup ke čtení. Všechny ostatní typy účtů musí používat PRIMÁRNÍ.
Metrics

Souhrn statistik žádostí seskupených podle rozhraní API v hodinových nebo minutových agregacích.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.
QueueAnalyticsLogging

Nastavení protokolování Azure Analytics.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.
QueueClient

Klient pro interakci s konkrétní frontou.

Další volitelnou konfiguraci potřebujete kliknutím sem.
QueueMessage

Představuje zprávu fronty.
QueueProperties

Vlastnosti fronty.
QueueSasPermissions

QueueSasPermissions Třída pro použití s generate_queue_sas funkcí a pro AccessPolicies používané s set_queue_access_policy.
QueueServiceClient

Klient pro interakci se službou Queue Service na úrovni účtu.

Tento klient poskytuje operace pro načtení a konfiguraci vlastností účtu a také výpis, vytváření a odstraňování front v rámci účtu. Pro operace související s konkrétní frontou je možné pomocí funkce načíst klienta pro tuto entitu get_queue_client .

Další volitelnou konfiguraci potřebujete kliknutím sem.
ResourceTypes

Určuje typy prostředků, které jsou přístupné pomocí SAS účtu.
RetentionPolicy

Zásady uchovávání informací, které určují, jak dlouho se mají přidružená data uchovávat.

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.
TextBase64DecodePolicy

Zásady dekódování zpráv pro základní zprávy s kódováním 64 na text

Dekóduje zprávy s kódováním base64 na text (unicode). Pokud vstupní obsah není platný základ 64, bude vyvolána chyba DecodeError. Data zpráv musí podporovat UTF-8.
TextBase64EncodePolicy

Základní zásady kódování 64 zpráv pro textové zprávy

Zakóduje textové zprávy (unicode) do základu 64. Pokud vstupní obsah není text, bude vyvolána chyba TypeError. Vstupní text musí podporovat UTF-8.

Výčty

StorageErrorCode

Funkce

generate_account_sas

Vygeneruje sdílený přístupový podpis pro službu fronty.

Použijte vrácený podpis s parametrem přihlašovacích údajů libovolné frontové služby.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str, start: datetime | str | None = None, ip: str | None = None, **kwargs: Any) -> str

Parametry

account_name
str
Vyžadováno

Název účtu úložiště použitý ke vygenerování sdíleného přístupového podpisu.

account_key
str
Vyžadováno

Klíč účtu, označovaný také jako sdílený klíč nebo přístupový klíč, pro vygenerování sdíleného přístupového podpisu.

resource_types
ResourceTypes
Vyžadováno

Určuje typy prostředků, které jsou přístupné pomocí SAS účtu.

permission
AccountSasPermissions nebo str
Vyžadováno

Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními.

expiry
datetime nebo str
Vyžadováno

Čas, kdy se sdílený přístupový podpis stane neplatným. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.

start
datetime nebo str
výchozí hodnota: None

Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.

ip
str
výchozí hodnota: None

Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy.

protocol
str

Určuje protokol povolený pro zadaný požadavek. Výchozí hodnota je https.

Návraty

Token sdíleného přístupového podpisu (SAS).

Návratový typ

str

generate_queue_sas

Vygeneruje sdílený přístupový podpis pro frontu.

Použijte vrácený podpis s parametrem přihlašovacích údajů libovolné frontové služby.

generate_queue_sas(account_name: str, queue_name: str, account_key: str, permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> str

Parametry

account_name
str
Vyžadováno

Název účtu úložiště použitý ke vygenerování sdíleného přístupového podpisu.

queue_name
str
Vyžadováno

Název fronty.

account_key
str
Vyžadováno

Klíč účtu, označovaný také jako sdílený klíč nebo přístupový klíč, pro vygenerování sdíleného přístupového podpisu.

permission
QueueSasPermissions nebo str
výchozí hodnota: None

Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Povinné, pokud není policy_id odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu.

expiry
datetime nebo str
výchozí hodnota: None

Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není policy_id odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.

start
datetime nebo str
výchozí hodnota: None

Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.

policy_id
str
výchozí hodnota: None

Jedinečná hodnota o délce až 64 znaků, která koreluje s uloženými zásadami přístupu. K vytvoření uložených zásad přístupu použijte set_queue_access_policy.

ip
str
výchozí hodnota: None

Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip='168.1.5.65' nebo sip='168.1.5.60-168.1.5.70' v SAS omezí požadavek na tyto IP adresy.

protocol
str

Určuje protokol povolený pro zadaný požadavek. Výchozí hodnota je https.

Návraty

Token sdíleného přístupového podpisu (SAS).

Návratový typ

str

Příklady

Vygenerujte token SAS.


   from azure.storage.queue import generate_queue_sas
   sas_token = generate_queue_sas(
       queue.account_name,
       queue.queue_name,
       queue.credential.account_key,
       policy_id='my-access-policy-id'
   )