Bagikan melalui

queue Paket

  • Referensi

Paket

aio

Kelas

AccessPolicy

Kelas Kebijakan Akses yang digunakan oleh set dan mendapatkan metode kebijakan akses.

Kebijakan akses tersimpan dapat menentukan waktu mulai, waktu kedaluwarsa, dan izin untuk Tanda Tangan Akses Bersama yang terkait dengannya. Bergantung pada bagaimana Anda ingin mengontrol akses ke sumber daya, Anda dapat menentukan semua parameter ini dalam kebijakan akses tersimpan, dan menghilangkannya dari URL untuk Tanda Tangan Akses Bersama. Melakukannya memungkinkan Anda untuk memodifikasi perilaku tanda tangan terkait kapan saja, serta mencabutnya. Atau Anda dapat menentukan satu atau beberapa parameter kebijakan akses dalam kebijakan akses tersimpan, dan yang lainnya di URL. Terakhir, Anda dapat menentukan semua parameter pada URL. Dalam hal ini, Anda dapat menggunakan kebijakan akses tersimpan untuk mencabut tanda tangan, tetapi tidak mengubah perilakunya.

Bersama-sama Tanda Tangan Akses Bersama dan kebijakan akses tersimpan harus menyertakan semua bidang yang diperlukan untuk mengautentikasi tanda tangan. Jika ada bidang yang diperlukan yang hilang, permintaan akan gagal. Demikian juga, jika bidang ditentukan baik di URL Tanda Tangan Akses Bersama maupun dalam kebijakan akses tersimpan, permintaan akan gagal dengan kode status 400 (Permintaan Buruk).
AccountSasPermissions

ResourceTypes kelas yang akan digunakan dengan fungsi generate_account_sas dan untuk AccessPolicies yang digunakan dengan set_*_acl. Ada dua jenis SAS yang dapat digunakan untuk memberikan akses sumber daya. Salah satunya adalah memberikan akses ke sumber daya tertentu (khusus sumber daya). Lainnya adalah memberikan akses ke seluruh layanan untuk akun tertentu dan memungkinkan operasi tertentu berdasarkan perm yang ditemukan di sini.
BinaryBase64DecodePolicy

Kebijakan pendekodean pesan untuk pesan dasar yang dikodekan 64 menjadi byte.

Mendekode pesan yang dikodekan base64 ke byte. Jika konten input bukan basis 64 yang valid, DecodeError akan dinaikkan.
BinaryBase64EncodePolicy

Kebijakan pengodean pesan base 64 untuk pesan biner.

Mengodekan pesan biner ke basis 64. Jika konten input bukan byte, TypeError akan dinaikkan.
CorsRule

CORS adalah fitur HTTP yang memungkinkan aplikasi web berjalan di bawah satu domain untuk mengakses sumber daya di domain lain. Browser web menerapkan pembatasan keamanan yang dikenal sebagai kebijakan asal yang sama yang mencegah halaman web memanggil API di domain yang berbeda; CORS menyediakan cara yang aman untuk memungkinkan satu domain (domain asal) untuk memanggil API di domain lain.

Semua parameter yang diperlukan harus diisi untuk dikirim ke Azure.
ExponentialRetry

Percobaan ulang eksponensial.

Membuat objek percobaan kembali Eksponensial. initial_backoff digunakan untuk coba lagi pertama kali. Percobaan ulang berikutnya dicoba kembali setelah initial_backoff + increment_power^retry_count detik.
LinearRetry

Coba lagi linear.

Membuat objek coba lagi Linear.
LocationMode

Menentukan lokasi tempat permintaan harus dikirim. Mode ini hanya berlaku untuk akun RA-GRS yang memungkinkan akses baca sekunder. Semua jenis akun lainnya harus menggunakan PRIMARY.
Metrics

Ringkasan statistik permintaan yang dikelompokkan menurut API dalam agregat jam atau menit.

Semua parameter yang diperlukan harus diisi untuk dikirim ke Azure.
QueueAnalyticsLogging

Pengaturan Pengelogan Azure Analytics.

Semua parameter yang diperlukan harus diisi untuk dikirim ke Azure.
QueueClient

Klien untuk berinteraksi dengan Antrean tertentu.

Untuk konfigurasi opsional lainnya, silakan klik di sini.
QueueMessage

Mewakili pesan antrean.
QueueProperties

Properti Antrean.
QueueSasPermissions

Kelas QueueSasPermissions yang akan digunakan dengan generate_queue_sas fungsi dan untuk AccessPolicies yang digunakan dengan set_queue_access_policy.
QueueServiceClient

Klien untuk berinteraksi dengan Layanan Antrean di tingkat akun.

Klien ini menyediakan operasi untuk mengambil dan mengonfigurasi properti akun serta mencantumkan, membuat dan menghapus antrean dalam akun. Untuk operasi yang berkaitan dengan antrean tertentu, klien untuk entitas ini dapat diambil menggunakan get_queue_client fungsi .

Untuk konfigurasi opsional lainnya, silakan klik di sini.
ResourceTypes

Menentukan jenis sumber daya yang dapat diakses dengan SAS akun.
RetentionPolicy

Kebijakan penyimpanan yang menentukan berapa lama data terkait harus bertahan.

Semua parameter yang diperlukan harus diisi untuk dikirim ke Azure.
TextBase64DecodePolicy

Kebijakan pendekodean pesan untuk pesan dasar yang dikodekan 64 ke dalam teks.

Mendekode pesan yang dikodekan base64 ke teks (unicode). Jika konten input bukan basis 64 yang valid, DecodeError akan dinaikkan. Data pesan harus mendukung UTF-8.
TextBase64EncodePolicy

Kebijakan pengodean pesan base 64 untuk pesan teks.

Mengodekan pesan teks (unicode) ke basis 64. Jika konten input bukan teks, TypeError akan dinaikkan. Teks input harus mendukung UTF-8.

Enum

StorageErrorCode

Fungsi

generate_account_sas

Menghasilkan tanda tangan akses bersama untuk layanan antrean.

Gunakan tanda tangan yang dikembalikan dengan parameter kredensial dari Layanan Antrean apa pun.

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

Parameter

account_name
str
Diperlukan

Nama akun penyimpanan yang digunakan untuk menghasilkan tanda tangan akses bersama.

account_key
str
Diperlukan

Kunci akun, juga disebut kunci bersama atau kunci akses, untuk menghasilkan tanda tangan akses bersama.

resource_types
ResourceTypes
Diperlukan

Menentukan jenis sumber daya yang dapat diakses dengan SAS akun.

permission
AccountSasPermissions atau str
Diperlukan

Izin yang terkait dengan tanda tangan akses bersama. Pengguna dibatasi untuk operasi yang diizinkan oleh izin.

expiry
datetime atau str
Diperlukan

Waktu tanda tangan akses bersama menjadi tidak valid. Azure akan selalu mengonversi nilai menjadi UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC.

start
datetime atau str
nilai default: None

Waktu di mana tanda tangan akses bersama menjadi valid. Jika dihilangkan, waktu mulai untuk panggilan ini diasumsikan sebagai waktu ketika layanan penyimpanan menerima permintaan. Azure akan selalu mengonversi nilai menjadi UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC.

ip
str
nilai default: None

Menentukan alamat IP atau rentang alamat IP untuk menerima permintaan. Jika alamat IP tempat permintaan berasal tidak cocok dengan alamat IP atau rentang alamat yang ditentukan pada token SAS, permintaan tidak diautentikasi. Misalnya, menentukan sip=168.1.5.65 atau sip=168.1.5.60-168.1.5.70 pada SAS membatasi permintaan ke alamat IP tersebut.

protocol
str

Menentukan protokol yang diizinkan untuk permintaan yang dibuat. Nilai defaultnya adalah https.

Mengembalikan

Token Tanda Tangan Akses Bersama (sas).

Tipe hasil

str

generate_queue_sas

Menghasilkan tanda tangan akses bersama untuk antrean.

Gunakan tanda tangan yang dikembalikan dengan parameter kredensial dari Layanan Antrean apa pun.

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

Parameter

account_name
str
Diperlukan

Nama akun penyimpanan yang digunakan untuk menghasilkan tanda tangan akses bersama.

queue_name
str
Diperlukan

Nama antrean.

account_key
str
Diperlukan

Kunci akun, juga disebut kunci bersama atau kunci akses, untuk menghasilkan tanda tangan akses bersama.

permission
QueueSasPermissions atau str
nilai default: None

Izin yang terkait dengan tanda tangan akses bersama. Pengguna dibatasi untuk operasi yang diizinkan oleh izin. Diperlukan kecuali policy_id diberikan mereferensikan kebijakan akses tersimpan yang berisi bidang ini. Bidang ini harus dihilangkan jika telah ditentukan dalam kebijakan akses tersimpan terkait.

expiry
datetime atau str
nilai default: None

Waktu tanda tangan akses bersama menjadi tidak valid. Diperlukan kecuali policy_id diberikan mereferensikan kebijakan akses tersimpan yang berisi bidang ini. Bidang ini harus dihilangkan jika telah ditentukan dalam kebijakan akses tersimpan terkait. Azure akan selalu mengonversi nilai menjadi UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC.

start
datetime atau str
nilai default: None

Waktu di mana tanda tangan akses bersama menjadi valid. Jika dihilangkan, waktu mulai untuk panggilan ini diasumsikan sebagai waktu ketika layanan penyimpanan menerima permintaan. Azure akan selalu mengonversi nilai menjadi UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC.

policy_id
str
nilai default: None

Panjang nilai unik hingga 64 karakter yang berkorelasi dengan kebijakan akses tersimpan. Untuk membuat kebijakan akses tersimpan, gunakan set_queue_access_policy.

ip
str
nilai default: None

Menentukan alamat IP atau rentang alamat IP untuk menerima permintaan. Jika alamat IP tempat permintaan berasal tidak cocok dengan alamat IP atau rentang alamat yang ditentukan pada token SAS, permintaan tidak diautentikasi. Misalnya, menentukan sip='168.1.5.65' atau sip='168.1.5.60-168.1.5.70' pada SAS membatasi permintaan ke alamat IP tersebut.

protocol
str

Menentukan protokol yang diizinkan untuk permintaan yang dibuat. Nilai defaultnya adalah https.

Mengembalikan

Token Tanda Tangan Akses Bersama (sas).

Tipe hasil

str

Contoh

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