queue Paket

  • Başvuru

Paketler

aio

Sınıflar

AccessPolicy

Küme tarafından kullanılan Erişim İlkesi sınıfı ve erişim ilkesi yöntemleri alın.

Depolanan erişim ilkesi, ilişkili olduğu Paylaşılan Erişim İmzaları için başlangıç saatini, süre sonunu ve izinleri belirtebilir. Kaynağınıza erişimi nasıl denetlemek istediğinize bağlı olarak, bu parametrelerin tümünü depolanmış erişim ilkesi içinde belirtebilir ve Paylaşılan Erişim İmzası URL'sinden atlayabilirsiniz. Bunu yapmak, ilişkili imzanın davranışını istediğiniz zaman değiştirmenize ve iptal etmenize izin verir. Alternatif olarak, depolanan erişim ilkesi içinde bir veya daha fazla erişim ilkesi parametresini ve URL'de diğerlerini belirtebilirsiniz. Son olarak, URL'de tüm parametreleri belirtebilirsiniz. Bu durumda, saklı erişim ilkesini kullanarak imzayı iptal edebilir, ancak davranışını değiştiremezsiniz.

Paylaşılan Erişim İmzası ve depolanmış erişim ilkesi birlikte imzanın kimliğini doğrulamak için gereken tüm alanları içermelidir. Gerekli alanlar eksikse istek başarısız olur. Benzer şekilde, hem Paylaşılan Erişim İmzası URL'sinde hem de depolanmış erişim ilkesinde bir alan belirtilirse, istek 400 (Hatalı İstek) durum koduyla başarısız olur.
AccountSasPermissions

ResourceTypes generate_account_sas işleviyle ve set_*_acl ile kullanılan AccessPolicies için kullanılacak sınıf. Kaynak erişimi vermek için kullanılabilecek iki tür SAS vardır. Bunlardan biri, belirli bir kaynağa (kaynağa özgü) erişim vermektir. Bir diğeri de belirli bir hesap için hizmetin tamamına erişim vermek ve burada bulunan permalara göre belirli işlemlere izin vermektir.
BinaryBase64DecodePolicy

64 tabanlı kodlanmış iletiler için ileti kodunu bayt olarak çözme ilkesi.

Base64 ile kodlanmış iletilerin kodunu bayt olarak çözer. Giriş içeriği geçerli 64 tabanı değilse, bir DecodeError oluşturulur.
BinaryBase64EncodePolicy

İkili iletiler için temel 64 ileti kodlama ilkesi.

İkili iletileri 64 tabanına kodlar. Giriş içeriği bayt değilse bir TypeError oluşturulur.
CorsRule

CORS, başka bir etki alanındaki kaynaklara erişmek için bir etki alanı altında çalışan bir web uygulamasını etkinleştiren bir HTTP özelliğidir. Web tarayıcıları, bir web sayfasının API'leri farklı etki alanından çağırmasını engelleyen, aynı çıkış noktası ilkesi olarak bilinen bir güvenlik kısıtlaması uygular. CORS, bir etki alanına (çıkış noktası etki alanı) başka etki alanındaki API'leri çağırmasına izin veren güvenli bir yol sağlar.

Azure'a göndermek için tüm gerekli parametrelerin doldurulması gerekir.
ExponentialRetry

Üstel yeniden deneme.

Üstel yeniden deneme nesnesi oluşturur. initial_backoff ilk yeniden deneme için kullanılır. Sonraki yeniden denemeler initial_backoff + increment_power^retry_count saniye sonra yeniden denenir.
LinearRetry

Doğrusal yeniden deneme.

Doğrusal yeniden deneme nesnesi oluşturur.
LocationMode

İsteğin gönderileceği konumu belirtir. Bu mod yalnızca ikincil okuma erişimine izin veren RA-GRS hesapları için geçerlidir. Diğer tüm hesap türleri BİRİnCİl kullanmalıdır.
Metrics

Saat veya dakika toplamlarında API'ye göre gruplandırılmış istek istatistiklerinin özeti.

Azure'a göndermek için tüm gerekli parametrelerin doldurulması gerekir.
QueueAnalyticsLogging

Azure Analytics Günlük ayarları.

Azure'a göndermek için tüm gerekli parametrelerin doldurulması gerekir.
QueueClient

Belirli bir Kuyrukla etkileşime geçmek için bir istemci.

Daha fazla isteğe bağlı yapılandırma için lütfen buraya tıklayın.
QueueMessage

Kuyruk iletisini temsil eder.
QueueProperties

Kuyruk Özellikleri.
QueueSasPermissions

işleviyle ve ile generate_queue_sas kullanılan AccessPolicies için kullanılacak QueueSasPermissions set_queue_access_policysınıfı.
QueueServiceClient

Kuyruk Hizmeti ile hesap düzeyinde etkileşime geçmek için bir istemci.

Bu istemci hesap özelliklerini alıp yapılandırmanın yanı sıra hesap içindeki kuyrukları listeleme, oluşturma ve silme işlemlerini sağlar. Belirli bir kuyrukla ilgili işlemler için, bu varlık için bir istemci işlevi kullanılarak get_queue_client alınabilir.

Daha fazla isteğe bağlı yapılandırma için lütfen buraya tıklayın.
ResourceTypes

Hesap SAS'siyle erişilebilen kaynak türlerini belirtir.
RetentionPolicy

İlişkili verilerin ne kadar süreyle kalıcı olması gerektiğini belirleyen bekletme ilkesi.

Azure'a göndermek için tüm gerekli parametrelerin doldurulması gerekir.
TextBase64DecodePolicy

64 tabanlı kodlanmış iletiler için ileti kod çözme ilkesi metne dönüştürüldü.

Base64 ile kodlanmış iletilerin kodunu metne (unicode) çözer. Giriş içeriği geçerli 64 tabanı değilse, bir DecodeError oluşturulur. İleti verilerinin UTF-8'i desteklemesi gerekir.
TextBase64EncodePolicy

Metin iletileri için temel 64 ileti kodlama ilkesi.

Metin (unicode) iletilerini 64 tabanına kodlar. Giriş içeriği metin değilse, bir TypeError oluşturulur. Giriş metni UTF-8'i desteklemelidir.

Numaralandırmalar

StorageErrorCode

İşlevler

generate_account_sas

Kuyruk hizmeti için paylaşılan erişim imzası oluşturur.

Döndürülen imzayı herhangi bir Kuyruk Hizmetinin kimlik bilgisi parametresiyle kullanın.

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

Parametreler

account_name
str
Gerekli

Paylaşılan erişim imzasını oluşturmak için kullanılan depolama hesabı adı.

account_key
str
Gerekli

Paylaşılan erişim imzasını oluşturmak için paylaşılan anahtar veya erişim anahtarı olarak da adlandırılan hesap anahtarı.

resource_types
ResourceTypes
Gerekli

Hesap SAS'siyle erişilebilen kaynak türlerini belirtir.

permission
AccountSasPermissions veya str
Gerekli

Paylaşılan erişim imzası ile ilişkili izinler. Kullanıcı izinler tarafından izin verilen işlemlerle sınırlıdır.

expiry
datetime veya str
Gerekli

Paylaşılan erişim imzasının geçersiz olduğu saat. Azure her zaman değerleri UTC'ye dönüştürür. Saat dilimi bilgisi olmadan bir tarih geçirilirse UTC olduğu varsayılır.

start
datetime veya str
varsayılan değer: None

Paylaşılan erişim imzasının geçerli olduğu saat. Belirtilmezse, bu çağrının başlangıç saatinin depolama hizmetinin isteği aldığı zaman olduğu varsayılır. Azure her zaman değerleri UTC'ye dönüştürür. Saat dilimi bilgisi olmadan bir tarih geçirilirse UTC olduğu varsayılır.

ip
str
varsayılan değer: None

İsteklerin kabul edildiği bir IP adresi veya IP adresi aralığı belirtir. İsteğin kaynaklandığı IP adresi SAS belirtecinde belirtilen IP adresi veya adres aralığıyla eşleşmiyorsa, isteğin kimliği doğrulanmaz. Örneğin, SAS üzerinde sip=168.1.5.65 veya sip=168.1.5.60-168.1.5.70 belirtilmesi isteği bu IP adresleriyle kısıtlar.

protocol
str

Yapılan istek için izin verilen protokolü belirtir. Varsayılan değer https'dir.

Döndürülenler

Paylaşılan Erişim İmzası (sas) belirteci.

Dönüş türü

str

generate_queue_sas

Bir kuyruk için paylaşılan erişim imzası oluşturur.

Döndürülen imzayı herhangi bir Kuyruk Hizmetinin kimlik bilgisi parametresiyle kullanın.

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

Parametreler

account_name
str
Gerekli

Paylaşılan erişim imzasını oluşturmak için kullanılan depolama hesabı adı.

queue_name
str
Gerekli

Kuyruğun adı.

account_key
str
Gerekli

Paylaşılan erişim imzasını oluşturmak için paylaşılan anahtar veya erişim anahtarı olarak da adlandırılan hesap anahtarı.

permission
QueueSasPermissions veya str
varsayılan değer: None

Paylaşılan erişim imzası ile ilişkili izinler. Kullanıcı izinler tarafından izin verilen işlemlerle sınırlıdır. Bu alanı içeren bir depolanmış erişim ilkesine başvuruda bulunan bir policy_id verilmediği sürece gereklidir. İlişkili bir depolanmış erişim ilkesinde belirtilmişse bu alan atlanmalıdır.

expiry
datetime veya str
varsayılan değer: None

Paylaşılan erişim imzasının geçersiz olduğu saat. Bu alanı içeren bir depolanmış erişim ilkesine başvuruda bulunan bir policy_id verilmediği sürece gereklidir. İlişkili bir depolanmış erişim ilkesinde belirtilmişse bu alan atlanmalıdır. Azure her zaman değerleri UTC'ye dönüştürür. Saat dilimi bilgisi olmadan bir tarih geçirilirse UTC olduğu varsayılır.

start
datetime veya str
varsayılan değer: None

Paylaşılan erişim imzasının geçerli olduğu saat. Belirtilmezse, bu çağrının başlangıç saatinin depolama hizmetinin isteği aldığı zaman olduğu varsayılır. Azure her zaman değerleri UTC'ye dönüştürür. Saat dilimi bilgisi olmadan bir tarih geçirilirse UTC olduğu varsayılır.

policy_id
str
varsayılan değer: None

Depolanmış erişim ilkesiyle bağıntılı 64 karakter uzunluğunda benzersiz bir değer. Depolanan erişim ilkesi oluşturmak için kullanın set_queue_access_policy.

ip
str
varsayılan değer: None

İsteklerin kabul edildiği bir IP adresi veya IP adresi aralığı belirtir. İsteğin kaynaklandığı IP adresi SAS belirtecinde belirtilen IP adresi veya adres aralığıyla eşleşmiyorsa, isteğin kimliği doğrulanmaz. Örneğin SAS üzerinde sip='168.1.5.65' veya sip='168.1.5.60-168.1.5.70' belirtilmesi, isteği bu IP adresleriyle kısıtlar.

protocol
str

Yapılan istek için izin verilen protokolü belirtir. Varsayılan değer https'dir.

Döndürülenler

Paylaşılan Erişim İmzası (sas) belirteci.

Dönüş türü

str

Örnekler

Sas belirteci oluşturma.


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