queue Пакет

  • Ссылка

Пакеты

aio

Классы

AccessPolicy

Класс Access Policy, используемый методами политики set и get access.

Хранимая политика доступа может задавать время начала, время окончания и разрешения для подписей коллективного доступа, с которыми она сопоставлена. В зависимости от того, как вы хотите управлять доступом к ресурсу, вы можете указать все эти параметры в хранимой политике доступа и опустить их в URL-адресе подписанного URL-адреса. Это позволяет изменить поведение связанной подписи в любое время, а также отменить ее. Или же вы можете указать один или несколько параметров в политике доступа, а остальные указать в URL-адресе. И наконец, вы можете указать все параметры в URL-адресе. В этом случае хранимую политику доступа можно использовать для отмены подписи, но не для изменения поведения подписи.

Подпись общего доступа и хранимая политика доступа должны включать все поля, необходимые для проверки подлинности подписи. Если какие-либо обязательные поля отсутствуют, то запрос завершится ошибкой. Аналогично, если поле указано и в подписанном URL-адресе, и в хранимой политике доступа, запрос завершится ошибкой с кодом состояния 400 (неправильный запрос).
AccountSasPermissions

ResourceTypes класс для использования с функцией generate_account_sas и для AccessPolicies, используемых с set_*_acl. Существует два типа SAS, которые можно использовать для предоставления доступа к ресурсам. Одним из них является предоставление доступа к определенному ресурсу (конкретному ресурсу). Другой способ — предоставить доступ ко всей службе для определенной учетной записи и разрешить определенные операции на основе найденных здесь операций.
BinaryBase64DecodePolicy

Политика декодирования сообщений для сообщений с кодировкой base 64 в байтах.

Декодирует сообщения в кодировке Base64 в байты. Если входное содержимое не является допустимым основанием 64, будет вызван параметр DecodeError.
BinaryBase64EncodePolicy

Базовая политика кодирования сообщений 64 для двоичных сообщений.

Кодирует двоичные сообщения в base 64. Если входное содержимое не равно байтам, возникает typeError.
CorsRule

CORS является функцией HTTP, которая позволяет веб-приложению, работающему в одном домене, обращаться к ресурсам из другого домена. Веб-браузеры имеют ограничение безопасности под названием политика одного источника, которое не позволяет веб-странице вызывать API из других доменов. CORS обеспечивают безопасный способ, с помощью которого один домен (исходный домен) может вызывать API из другого домена.

Все необходимые параметры должны быть заполнены для отправки в Azure.
ExponentialRetry

Экспоненциальная повторная попытка.

Создает экспоненциальный объект повторных попыток. Для первой попытки используется initial_backoff. Последующие повторные попытки повторяются через initial_backoff + increment_power^retry_count секунд.
LinearRetry

Линейная повторная попытка.

Создает объект linear retry.
LocationMode

Указывает расположение, в которое должен быть отправлен запрос. Этот режим применяется только для учетных записей RA-GRS, которые разрешают дополнительный доступ на чтение. Все остальные типы учетных записей должны использовать PRIMARY.
Metrics

Сводка статистики запросов, сгруппированных по API в статистических выражениях по часам или минутам.

Все необходимые параметры должны быть заполнены для отправки в Azure.
QueueAnalyticsLogging

Параметры ведения журнала Azure Analytics.

Все необходимые параметры должны быть заполнены для отправки в Azure.
QueueClient

Клиент для взаимодействия с определенной очередью.

Дополнительные сведения о настройке см. здесь.
QueueMessage

Представляет сообщение очереди.
QueueProperties

Свойства очереди.
QueueSasPermissions

Класс QueueSasPermissions для использования с функцией generate_queue_sas и для AccessPolicies, используемый с set_queue_access_policy.
QueueServiceClient

Клиент для взаимодействия со службой очередей на уровне учетной записи.

Этот клиент предоставляет операции по получению и настройке свойств учетной записи, а также перечислению, созданию и удалению очередей в учетной записи. Для операций, связанных с определенной очередью, клиент для этой сущности можно получить с помощью get_queue_client функции .

Дополнительные сведения о настройке см. здесь.
ResourceTypes

Указывает типы ресурсов, доступные с помощью SAS учетной записи.
RetentionPolicy

Политика хранения, которая определяет, как долго должны сохраняться связанные данные.

Все необходимые параметры должны быть заполнены для отправки в Azure.
TextBase64DecodePolicy

Политика декодирования сообщений для сообщений в кодировке Base 64 в текст.

Декодирует сообщения в кодировке Base64 в текст (Юникод). Если входное содержимое не является допустимым основанием 64, будет вызван параметр DecodeError. Данные сообщений должны поддерживать UTF-8.
TextBase64EncodePolicy

Базовая политика кодирования сообщений 64 для текстовых сообщений.

Кодирует текстовые сообщения (Юникод) в кодировку Base 64. Если входное содержимое не является текстом, возникает typeError. Входной текст должен поддерживать UTF-8.

Перечисления

StorageErrorCode

Функции

generate_account_sas

Создает подписанный URL-адрес для службы очередей.

Используйте возвращенную подпись с параметром учетных данных любой службы очередей.

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

Параметры

account_name
str
Обязательно

Имя учетной записи хранения, используемое для создания подписанного URL-адреса.

account_key
str
Обязательно

Ключ учетной записи, также называемый общим ключом или ключом доступа, для создания подписанного URL-адреса.

resource_types
ResourceTypes
Обязательно

Указывает типы ресурсов, доступные с помощью SAS учетной записи.

permission
AccountSasPermissions или str
Обязательно

Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями.

expiry
datetime или str
Обязательно

Время, когда подписанный URL-адрес становится недействительным. Azure всегда преобразует значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC.

start
datetime или str
значение по умолчанию: None

Время, когда подписанный URL-адрес становится действительным. Если не указано, то время начала для данного вызова считается временем, когда служба хранилища получает запрос. Azure всегда преобразует значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC.

ip
str
значение по умолчанию: None

Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip=168.1.5.65 или sip=168.1.5.60-168.1.5.70 в SAS ограничивает запрос этими IP-адресами.

protocol
str

Указывает протокол, разрешенный для выполненного запроса. Значение по умолчанию — https.

Возвращаемое значение

Маркер подписанного URL-адреса (SAS).

Возвращаемый тип

str

generate_queue_sas

Создает подписанный URL-адрес для очереди.

Используйте возвращенную подпись с параметром учетных данных любой службы очередей.

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

Параметры

account_name
str
Обязательно

Имя учетной записи хранения, используемое для создания подписанного URL-адреса.

queue_name
str
Обязательно

Имя очереди.

account_key
str
Обязательно

Ключ учетной записи, также называемый общим ключом или ключом доступа, для создания подписанного URL-адреса.

permission
QueueSasPermissions или str
значение по умолчанию: None

Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями. Требуется, если не предоставлен policy_id, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа.

expiry
datetime или str
значение по умолчанию: None

Время, когда подписанный URL-адрес становится недействительным. Требуется, если не предоставлен policy_id, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа. Azure всегда преобразует значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC.

start
datetime или str
значение по умолчанию: None

Время, когда подписанный URL-адрес становится действительным. Если не указано, то время начала для данного вызова считается временем, когда служба хранилища получает запрос. Azure всегда преобразует значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC.

policy_id
str
значение по умолчанию: None

Уникальное значение длиной до 64 символов, коррелирует с хранимой политикой доступа. Чтобы создать хранимую политику доступа, используйте .set_queue_access_policy

ip
str
значение по умолчанию: None

Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip='168.1.5.65' или sip='168.1.5.60-168.1.5.70' в SAS ограничивает запрос этими IP-адресами.

protocol
str

Указывает протокол, разрешенный для выполненного запроса. Значение по умолчанию — https.

Возвращаемое значение

Маркер подписанного URL-адреса (SAS).

Возвращаемый тип

str

Примеры

Создайте маркер 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'
   )