queue Pakiet

Pakiety

aio

Klasy

AccessPolicy	Klasa zasad dostępu używana przez zestaw i uzyskiwanie metod zasad dostępu. Przechowywane zasady dostępu mogą określać czas rozpoczęcia, czas wygaśnięcia i uprawnienia dla sygnatur dostępu współdzielonego, z którymi jest skojarzony. W zależności od tego, jak chcesz kontrolować dostęp do zasobu, możesz określić wszystkie te parametry w przechowywanych zasadach dostępu i pominąć je z adresu URL sygnatury dostępu współdzielonego. Dzięki temu można zmodyfikować zachowanie skojarzonego podpisu w dowolnym momencie, a także odwołać go. Możesz też określić jeden lub więcej parametrów zasad dostępu w ramach przechowywanych zasad dostępu, a inne w adresie URL. Na koniec możesz określić wszystkie parametry w adresie URL. W takim przypadku można użyć przechowywanych zasad dostępu, aby odwołać podpis, ale nie zmodyfikować jego zachowania. Razem sygnatura dostępu współdzielonego i przechowywane zasady dostępu muszą zawierać wszystkie pola wymagane do uwierzytelnienia podpisu. Jeśli brakuje wymaganych pól, żądanie zakończy się niepowodzeniem. Podobnie, jeśli pole jest określone zarówno w adresie URL sygnatury dostępu współdzielonego, jak i w przechowywanych zasadach dostępu, żądanie zakończy się niepowodzeniem z kodem stanu 400 (nieprawidłowe żądanie).
AccountSasPermissions	ResourceTypes klasa, która ma być używana z funkcją generate_account_sas oraz zasadami programu AccessPolicies używanymi z set_*_acl. Istnieją dwa typy sygnatur dostępu współdzielonego, które mogą służyć do udzielania dostępu do zasobów. Jednym z nich jest udzielenie dostępu do określonego zasobu (specyficznego dla zasobu). Innym jest przyznanie dostępu do całej usługi dla określonego konta i zezwolenie na niektóre operacje oparte na permach znalezionych tutaj.
BinaryBase64DecodePolicy	Zasady dekodowania komunikatów dla komunikatów zakodowanych w formacie base 64 w bajtach. Dekoduje komunikaty zakodowane w formacie Base64 do bajtów. Jeśli zawartość wejściowa nie jest prawidłową bazą 64, zostanie zgłoszony błąd DecodeError.
BinaryBase64EncodePolicy	Podstawowe zasady kodowania komunikatów 64 dla komunikatów binarnych. Koduje komunikaty binarne do bazy 64. Jeśli zawartość wejściowa nie jest bajtami, zostanie zgłoszony błąd TypeError.
CorsRule	Mechanizm CORS (udostępnianie zasobów między źródłami) to funkcja protokołu HTTP, która umożliwia aplikacji internetowej działającej w ramach jednej domeny dostęp do zasobów w innej domenie. Przeglądarki internetowe wdrażają ograniczenie bezpieczeństwa nazywane zasadami jednego źródła, które zapobiega wywoływaniu interfejsów API w innych domenach przez strony internetowe. Mechanizm CORS zapewnia bezpieczną metodę umożliwiania jednej domenie (domenie źródłowej) wywoływania interfejsów API z innej domeny. Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.
ExponentialRetry	Ponawianie wykładnicze. Tworzy obiekt ponawiania wykładniczego. Initial_backoff służy do pierwszego ponawiania próby. Kolejne ponowne próby są ponawiane po initial_backoff + increment_power^retry_count sekundach.
LinearRetry	Ponawianie liniowe. Tworzy obiekt ponawiania liniowego.
LocationMode	Określa lokalizację, do którego ma zostać wysłane żądanie. Ten tryb dotyczy tylko kont RA-GRS, które zezwalają na pomocniczy dostęp do odczytu. Wszystkie inne typy kont muszą używać wartości PRIMARY.
Metrics	Podsumowanie statystyk żądań pogrupowanych według interfejsu API w agregacjach godzinowych lub minutowych. Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.
QueueAnalyticsLogging	Ustawienia rejestrowania usługi Azure Analytics. Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.
QueueClient	Klient do interakcji z określoną kolejką. Aby uzyskać więcej opcjonalnych konfiguracji, kliknij tutaj.
QueueMessage	Reprezentuje komunikat kolejki.
QueueProperties	Właściwości kolejki.
QueueSasPermissions	QueueSasPermissions, klasa, która ma być używana z funkcją generate_queue_sas i dla zasad AccessPolicies używanych z set_queue_access_policy.
QueueServiceClient	Klient do interakcji z usługą Kolejki na poziomie konta. Ten klient udostępnia operacje pobierania i konfigurowania właściwości konta, a także tworzenia i usuwania kolejek w ramach konta. W przypadku operacji związanych z określoną kolejką można pobrać klienta dla tej jednostki przy użyciu get_queue_client funkcji . Aby uzyskać więcej opcjonalnych konfiguracji, kliknij tutaj.
ResourceTypes	Określa typy zasobów, które są dostępne za pomocą sygnatury dostępu współdzielonego konta.
RetentionPolicy	Zasady przechowywania określające, jak długo powinny być utrwalane skojarzone dane. Wszystkie wymagane parametry muszą zostać wypełnione w celu wysłania ich na platformę Azure.
TextBase64DecodePolicy	Zasady dekodowania komunikatów dla komunikatów zakodowanych w formacie base 64 do tekstu. Dekoduje komunikaty zakodowane w formacie Base64 na tekst (Unicode). Jeśli zawartość wejściowa nie jest prawidłową bazą 64, zostanie zgłoszony błąd DecodeError. Dane komunikatów muszą obsługiwać kod UTF-8.
TextBase64EncodePolicy	Podstawowe zasady kodowania komunikatów 64 dla wiadomości tekstowych. Koduje komunikaty tekstowe (Unicode) do podstawy 64. Jeśli zawartość wejściowa nie jest tekstem, zostanie zgłoszony błąd TypeError. Tekst wejściowy musi obsługiwać kod UTF-8.

Wyliczenia

StorageErrorCode

Funkcje

generate_account_sas

Generuje sygnaturę dostępu współdzielonego dla usługi kolejki.

Użyj zwróconego podpisu z parametrem poświadczeń dowolnej usługi kolejki.

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

Wymagane

Nazwa konta magazynu używana do generowania sygnatury dostępu współdzielonego.

account_key

str

Wymagane

Klucz konta, nazywany również kluczem udostępnionym lub kluczem dostępu, w celu wygenerowania sygnatury dostępu współdzielonego.

resource_types

ResourceTypes

Wymagane

Określa typy zasobów, które są dostępne za pomocą sygnatury dostępu współdzielonego konta.

permission

AccountSasPermissions lub str

Wymagane

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia.

expiry

datetime lub str

Wymagane

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. W przypadku pominięcia zakłada się, że godzina rozpoczęcia tego wywołania to czas odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

ip

str

wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip=168.1.5.65 lub sip=168.1.5.60-168.1.5.70 w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol

str

Określa protokół dozwolony dla żądania. Wartość domyślna to https.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

generate_queue_sas

Generuje sygnaturę dostępu współdzielonego dla kolejki.

Użyj zwróconego podpisu z parametrem poświadczeń dowolnej usługi kolejki.

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

Wymagane

Nazwa konta magazynu używana do generowania sygnatury dostępu współdzielonego.

queue_name

str

Wymagane

Nazwa kolejki.

account_key

str

Wymagane

Klucz konta, nazywany również kluczem udostępnionym lub kluczem dostępu, w celu wygenerowania sygnatury dostępu współdzielonego.

permission

QueueSasPermissions lub str

wartość domyślna: None

Uprawnienia skojarzone z sygnaturą dostępu współdzielonego. Użytkownik jest ograniczony do operacji dozwolonych przez uprawnienia. Wymagane, chyba że zostanie podana policy_id odwołująca się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu.

expiry

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wymagane, chyba że zostanie podana policy_id odwołująca się do przechowywanych zasad dostępu, które zawierają to pole. To pole musi zostać pominięte, jeśli zostało określone w skojarzonych zapisanych zasadach dostępu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

start

datetime lub str

wartość domyślna: None

Czas, w którym sygnatura dostępu współdzielonego staje się prawidłowa. W przypadku pominięcia zakłada się, że godzina rozpoczęcia tego wywołania to czas odebrania żądania przez usługę magazynu. Platforma Azure zawsze konwertuje wartości na czas UTC. Jeśli data jest przekazywana bez informacji o strefie czasowej, przyjmuje się, że jest to utc.

policy_id

str

wartość domyślna: None

Unikatowa wartość o długości do 64 znaków, która jest skorelowana z zapisanymi zasadami dostępu. Aby utworzyć przechowywane zasady dostępu, użyj polecenia set_queue_access_policy.

ip

str

wartość domyślna: None

Określa adres IP lub zakres adresów IP, z których mają być akceptowane żądania. Jeśli adres IP, z którego pochodzi żądanie, nie jest zgodny z adresem IP lub zakresem adresów określonym w tokenie SAS, żądanie nie jest uwierzytelniane. Na przykład określenie sip='168.1.5.65' lub sip='168.1.5.60-168.1.5.70' w sygnaturze dostępu współdzielonego ogranicza żądanie do tych adresów IP.

protocol

str

Określa protokół dozwolony dla żądania. Wartość domyślna to https.

Zwraca

Token sygnatury dostępu współdzielonego (sas).

Typ zwracany

str

Przykłady

Generowanie tokenu sygnatury dostępu współdzielonego.

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