Megosztás a következőn keresztül:

queue Csomag

  • Referencia

Csomagok

aio

Osztályok

AccessPolicy

A készlet által használt Hozzáférési szabályzat osztály, és hozzáférési szabályzati metódusok lekérése.

A tárolt hozzáférési szabályzatok megadhatják a kezdési időpontot, a lejárati időt és az engedélyeket azokhoz a közös hozzáférésű jogosultságkódokhoz, amelyekhez társítva van. Attól függően, hogy hogyan szeretné szabályozni az erőforráshoz való hozzáférést, megadhatja ezeket a paramétereket a tárolt hozzáférési szabályzatban, és kihagyhatja őket a közös hozzáférésű jogosultságkód URL-címéből. Ezzel bármikor módosíthatja a társított aláírás viselkedését, valamint visszavonhatja azt. Vagy megadhat egy vagy több hozzáférésiszabályzat-paramétert a tárolt hozzáférési szabályzatban, a többit pedig az URL-címen. Végül megadhatja az URL-cím összes paraméterét. Ebben az esetben a tárolt hozzáférési szabályzattal visszavonhatja az aláírást, de nem módosíthatja annak viselkedését.

A közös hozzáférésű jogosultságkódnak és a tárolt hozzáférési szabályzatnak együtt tartalmaznia kell az aláírás hitelesítéséhez szükséges összes mezőt. Ha valamelyik kötelező mező hiányzik, a kérés sikertelen lesz. Hasonlóképpen, ha egy mező a közös hozzáférésű jogosultságkód URL-címében és a tárolt hozzáférési szabályzatban is meg van adva, a kérés a 400-ás állapotkóddal (hibás kérelem) meghiúsul.
AccountSasPermissions

ResourceTypes osztályt generate_account_sas függvényhez, valamint a set_*_acl használt AccessPolicies osztályhoz. Az SAS-nek két típusa lehet az erőforrás-hozzáférés biztosításához. Az egyik az, hogy hozzáférést ad egy adott erőforráshoz (erőforrás-specifikus). Egy másik lehetőség, hogy hozzáférést ad a teljes szolgáltatáshoz egy adott fiókhoz, és bizonyos műveleteket engedélyez az itt található teljesítmények alapján.
BinaryBase64DecodePolicy

Az alap 64 kódolású üzenetek üzenetdekódolási szabályzata bájtokra.

A base64 kódolású üzeneteket bájtokra dekódolja. Ha a bemeneti tartalom nem érvényes 64-es alap, a rendszer létrehoz egy DecodeError értéket.
BinaryBase64EncodePolicy

64-es alapszintű üzenetkódolási szabályzat bináris üzenetekhez.

A bináris üzeneteket a 64-es alapra kódolja. Ha a bemeneti tartalom nem bájt, a rendszer typeError értéket ad meg.
CorsRule

A CORS egy olyan HTTP-szolgáltatás, amely egy adott tartományban futó webalkalmazás számára teszi lehetővé, hogy hozzáférjen egy másik tartomány erőforrásaihoz. A webböngészők azonoseredet-szabálynak nevezett biztonsági korlátozással akadályozzák meg, hogy egy adott weblap más tartományokból hívjon meg API-kat. A CORS biztonságos megoldást nyújt arra, hogy a forrástartományból más tartományokban lévő API-k legyenek meghívhatók.

Az Azure-ba való küldéshez minden szükséges paramétert fel kell tölteni.
ExponentialRetry

Exponenciális újrapróbálkozás.

Exponenciális újrapróbálkozási objektumot állít össze. Az első újrapróbálkozáshoz a initial_backoff használja a rendszer. A következő újrapróbálkozások initial_backoff + increment_power^retry_count másodperc után újrapróbálkoznak.
LinearRetry

Lineáris újrapróbálkozás.

Lineáris újrapróbálkozás objektumot hoz létre.
LocationMode

Megadja a helyet, ahová a kérést el kell küldeni. Ez a mód csak azokra az RA-GRS-fiókokra vonatkozik, amelyek lehetővé teszik a másodlagos olvasási hozzáférést. Minden más fióktípusnak ELSŐDLEGESet kell használnia.
Metrics

A kérelemstatisztikák összegzése API-k szerint csoportosítva óránkénti vagy percenkénti összesítésekben.

Az Azure-ba való küldéshez minden szükséges paramétert fel kell tölteni.
QueueAnalyticsLogging

Az Azure Analytics naplózási beállításai.

Az Azure-ba való küldéshez minden szükséges paramétert fel kell tölteni.
QueueClient

Egy adott üzenetsort kezelő ügyfél.

További választható konfigurációért kattintson ide.
QueueMessage

Üzenetsort jelöl.
QueueProperties

Üzenetsor tulajdonságai.
QueueSasPermissions

A függvényhez és a generate_queue_sas függvényhez használandó QueueSasPermissions osztályhoz, valamint a paranccsal használt AccessPolicies osztályhoz set_queue_access_policy.
QueueServiceClient

Egy ügyfél, amely a queue szolgáltatással kommunikál a fiók szintjén.

Ez az ügyfél műveleteket biztosít a fióktulajdonságok lekéréséhez és konfigurálásához, valamint a fiókon belüli üzenetsorok létrehozásához és törléséhez. Egy adott üzenetsorhoz kapcsolódó műveletek esetén az entitáshoz tartozó ügyfél lekérhető a get_queue_client függvénnyel.

További választható konfigurációért kattintson ide.
ResourceTypes

Megadja a fiók SAS-jével elérhető erőforrástípusokat.
RetentionPolicy

A kapcsolódó adatok megőrzésének időtartamát meghatározó adatmegőrzési szabályzat.

Az Azure-ba való küldéshez minden szükséges paramétert fel kell tölteni.
TextBase64DecodePolicy

Az alap 64 kódolású üzenetek üzenetdekódolási szabályzata szöveggé.

A base64 kódolású üzeneteket szöveggé (Unicode) dekódolja. Ha a bemeneti tartalom nem érvényes 64-es alap, a rendszer létrehoz egy DecodeError értéket. Az üzenetadatoknak támogatniuk kell az UTF-8 protokollt.
TextBase64EncodePolicy

64-es alapszintű üzenetkódolási szabályzat szöveges üzenetekhez.

A szöveges (Unicode) üzeneteket a 64-es alapra kódolja. Ha a bemeneti tartalom nem szöveg, a rendszer typeError értéket ad meg. A bemeneti szövegnek támogatnia kell az UTF-8-et.

Enumerációk

StorageErrorCode

Függvények

generate_account_sas

Létrehoz egy közös hozzáférésű jogosultságkódot a queue szolgáltatáshoz.

Használja a visszaadott aláírást bármely Queue Service hitelesítőadat-paraméterével.

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

Paraméterek

account_name
str
Kötelező

A közös hozzáférésű jogosultságkód létrehozásához használt tárfióknév.

account_key
str
Kötelező

A közös hozzáférésű jogosultságkód létrehozásához a fiókkulcs, más néven megosztott kulcs vagy hozzáférési kulcs.

resource_types
ResourceTypes
Kötelező

Megadja a fiók SAS-jével elérhető erőforrástípusokat.

permission
AccountSasPermissions vagy str
Kötelező

A közös hozzáférésű jogosultságkódhoz társított engedélyek. A felhasználó az engedélyek által engedélyezett műveletekre korlátozódik.

expiry
datetime vagy str
Kötelező

A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Az Azure mindig UTC értékké konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti.

start
datetime vagy str
alapértelmezett érték: None

A közös hozzáférésű jogosultságkód érvényességének időpontja. Ha nincs megadva, a rendszer feltételezi, hogy a hívás indítási ideje az az időpont, amikor a storage szolgáltatás megkapja a kérést. Az Azure mindig UTC értékké konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti.

ip
str
alapértelmezett érték: None

Megadja azt az IP-címet vagy IP-címtartományt, amelyből a kéréseket fogadni szeretné. Ha az IP-cím, amelyről a kérés származik, nem egyezik az SAS-jogkivonatban megadott IP-címmel vagy címtartománysal, a kérés nem lesz hitelesítve. Ha például a sip=168.1.5.65 vagy a sip=168.1.5.60-168.1.5.70 paramétert adja meg az SAS-en, az korlátozza a kérést ezekre az IP-címekre.

protocol
str

Meghatározza, hogy egy kéréshez mely protokoll engedélyezett. Az alapértelmezett érték a https.

Válaszok

Közös hozzáférésű jogosultságkód (sas) jogkivonat.

Visszatérési típus

str

generate_queue_sas

Létrehoz egy közös hozzáférésű jogosultságkódot egy üzenetsorhoz.

Használja a visszaadott aláírást bármely Queue Service hitelesítőadat-paraméterével.

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

Paraméterek

account_name
str
Kötelező

A közös hozzáférésű jogosultságkód létrehozásához használt tárfióknév.

queue_name
str
Kötelező

Az üzenetsor neve.

account_key
str
Kötelező

A közös hozzáférésű jogosultságkód létrehozásához a fiókkulcs, más néven megosztott kulcs vagy hozzáférési kulcs.

permission
QueueSasPermissions vagy str
alapértelmezett érték: None

A közös hozzáférésű jogosultságkódhoz társított engedélyek. A felhasználó az engedélyek által engedélyezett műveletekre korlátozódik. Kötelező, kivéve, ha egy policy_id a mezőt tartalmazó tárolt hozzáférési szabályzatra hivatkozik. Ezt a mezőt ki kell hagyni, ha egy társított tárolt hozzáférési szabályzatban van megadva.

expiry
datetime vagy str
alapértelmezett érték: None

A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Kötelező, kivéve, ha egy policy_id a mezőt tartalmazó tárolt hozzáférési szabályzatra hivatkozik. Ezt a mezőt ki kell hagyni, ha egy társított tárolt hozzáférési szabályzatban van megadva. Az Azure mindig UTC értékké konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti.

start
datetime vagy str
alapértelmezett érték: None

A közös hozzáférésű jogosultságkód érvényességének időpontja. Ha nincs megadva, a rendszer feltételezi, hogy a hívás indítási ideje az az időpont, amikor a storage szolgáltatás megkapja a kérést. Az Azure mindig UTC értékké konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti.

policy_id
str
alapértelmezett érték: None

Egy legfeljebb 64 karakter hosszúságú egyedi érték, amely egy tárolt hozzáférési szabályzattal korrelál. Tárolt hozzáférési szabályzat létrehozásához használja a következőt set_queue_access_policy: .

ip
str
alapértelmezett érték: None

Megadja azt az IP-címet vagy IP-címtartományt, amelyből a kéréseket fogadni szeretné. Ha az IP-cím, amelyről a kérés származik, nem egyezik az SAS-jogkivonatban megadott IP-címmel vagy címtartománysal, a kérés nem lesz hitelesítve. Ha például a sip='168.1.5.65' vagy a sip='168.1.5.60-168.1.5.70' értéket adja meg az SAS-en, akkor a kérés az adott IP-címekre lesz korlátozva.

protocol
str

Meghatározza, hogy egy kéréshez mely protokoll engedélyezett. Az alapértelmezett érték a https.

Válaszok

Közös hozzáférésű jogosultságkód (sas) jogkivonat.

Visszatérési típus

str

Példák

Sas-jogkivonat létrehozása.


   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'
   )