QueueService Класс

Это main класс, управляющий ресурсами очереди.

Служба очередей хранит сообщения. Очередь может содержать неограниченное количество сообщений, размер каждого из которых может составлять до 64 КБ. Сообщения обычно добавляются к концу очереди и извлекаются из ее начала, хотя поведение FIFO («первым пришел, первым ушел») не гарантируется.

:type ~azure.storage.common.TokenCredential

Наследование

StorageClient

QueueService

Конструктор

QueueService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None, token_credential=None)

Параметры

account_name

str

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

имя учетной записи хранения. Он используется для проверки подлинности запросов, подписанных с помощью ключа учетной записи, и для создания конечной точки хранилища. Это необходимо, если не предоставлено строка подключения.

account_key

str

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

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

sas_token

str

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

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

is_emulated

bool

значение по умолчанию: False

Следует ли использовать эмулятор. Значение по умолчанию — False. Если этот параметр указан, переопределяет все остальные параметры, кроме строка подключения и сеанса запроса.

protocol

str

значение по умолчанию: https

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

endpoint_suffix

str

значение по умолчанию: core.windows.net

Базовый компонент узла URL-адреса за вычетом имени учетной записи. По умолчанию используется Azure (core.windows.net). Переопределите его, чтобы использовать облако для Китая (core.chinacloudapi.cn).

request_session

<xref:requests.Session>

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

Объект сеанса, который используется для HTTP-запросов.

connection_string

str

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

Если этот параметр указан, будут переопределяться все остальные параметры, кроме сеанса запроса. Формат строка подключения смhttp://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/. в этой статье.

socket_timeout

int

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

Если этот параметр указан, время ожидания сокета по умолчанию переопределяется. Указанное время ожидания — в секундах. Значение по умолчанию см. в разделе DEFAULT_SOCKET_TIMEOUT в _constants.py.

token_credential

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

Учетные данные маркера, используемые для проверки подлинности HTTPS-запросов. Значение токена должно быть обновлено до истечения срока его действия.

Переменные

encode_function

<xref:function>(<xref:data>)

Функция, используемая для кодирования сообщений очереди. Принимает в качестве параметра данные, передаваемые в API put_message, и возвращает закодированное сообщение. По умолчанию используется кодирование текста и XML, но можно использовать байты и другие кодировки. Например, base64 может быть предпочтительнее для разработки в нескольких библиотеках службы хранилища Azure на разных языках. См. сведения о QueueMessageFormat методах xml, base64 и no encoding, а также двоичных эквивалентах.

decode_function

<xref:function>(<xref:data>)

Функция, используемая для кодирования сообщений. Принимает в качестве параметра данные, возвращаемые API get_messages и peek_messages, и возвращает декодированные сообщения. По умолчанию возвращает декодирование текста и xml, но можно использовать байты и другие декодирования. Например, base64 может быть предпочтительнее для разработки в нескольких библиотеках службы хранилища Azure на разных языках. См. сведения о QueueMessageFormat методах xml, base64 и no decoding, а также двоичных эквивалентах.

key_encryption_key

object

Ключ шифрования ключей, предоставляемый пользователем при необходимости. Если этот параметр указан, будет использоваться для шифрования и расшифровки в поддерживаемых методах. Для методов, требующих расшифровки, необходимо указать key_encryption_key или сопоставитель. Если указаны оба варианта, приоритет будет иметь сопоставитель. Необходимо реализовать следующие методы для API, требующих шифрования: wrap_key(key)–упаковывает указанный ключ (байты) с помощью алгоритма по выбору пользователя. Возвращает зашифрованный ключ в виде байтов. get_key_wrap_algorithm()—возвращает алгоритм, используемый для упаковки указанного симметричного ключа. get_kid()—возвращает идентификатор ключа строки для этого ключа-шифрования. Необходимо реализовать следующие методы для API, требующих расшифровки: unwrap_key(ключ, алгоритм)—возвращает распакованную форму указанного симметричного ключа с помощью алгоритма, заданного строковым. get_kid()—возвращает идентификатор ключа строки для этого ключа-шифрования.

key_resolver_function

kid) (<xref:function>

Функция для разрешения ключей, дополнительно предоставляемых пользователем. Если этот параметр указан, будет использоваться для расшифровки в поддерживаемых методах. Для методов, требующих расшифровки, необходимо указать key_encryption_key или сопоставитель. Если указаны оба варианта, приоритет будет иметь сопоставитель. Он использует строку ребенка для возврата ключа шифрования ключа, реализующего интерфейс, определенный выше.

require_encryption

bool

Флаг, который может быть установлен, чтобы убедиться, что все сообщения, успешно отправленные в очередь, а также все сообщения, скачанные и успешно прочитанные из очереди, зашифрованы или зашифрованы на сервере. Если этот флаг установлен, необходимо указать все необходимые параметры для шифрования и расшифровки. См. приведенные выше комментарии в key_encryption_key и сопоставитель.

Методы

clear_messages	Удаляет все сообщения из указанной очереди.
create_queue	Создает очередь в заданной учетной записи.
delete_message	Удаляет указанное сообщение. Обычно после получения клиентом сообщения с помощью операции get_messages клиент должен обработать и удалить сообщение. Чтобы удалить сообщение, необходимо иметь два элемента данных: id и pop_receipt. Идентификатор возвращается из предыдущей операции get_messages. Pop_receipt возвращается из последней get_messages операции или update_message . Для успешного выполнения операции delete_message pop_receipt, указанный в запросе, должен соответствовать pop_receipt, возвращенным из get_messages операции или update_message .
delete_queue	Удаляет указанную очередь и все содержащиеся в ней сообщения. После успешного удаления очередь сразу же помечается для удаления и становится недоступной для клиентов. Впоследствии очередь удаляется из службы очередей в процессе сборки мусора. Обратите внимание, что удаление очереди, скорее всего, займет не менее 40 секунд. При попытке выполнить операцию с очередью во время ее удаления <xref:azure.storage.queue.queueservice.AzureConflictHttpError> будет выдано исключение .
exists	Возвращает логическое значение, указывающее, существует ли очередь.
extract_date_and_request_id
generate_account_shared_access_signature	Создает подписанный URL-адрес для службы очередей. Используйте возвращенную подпись с параметром sas_token QueueService.
generate_queue_shared_access_signature	Создает подписанный URL-адрес для очереди. Используйте возвращенную сигнатуру с параметром sas_token QueueService.
get_messages	Извлекает одно или несколько сообщений из передней части очереди. При извлечении сообщения из очереди ответ включает содержимое сообщения и значение pop_receipt, необходимое для удаления сообщения. Сообщение не удаляется из очереди автоматически, но после его извлечения оно не отображается другим клиентам в течение интервала времени, указанного параметром visibility_timeout. Если для локального объекта службы задано поле key-encryption-key или resolver, сообщения будут расшифрованы перед возвратом.
get_queue_acl	Возвращает сведения о всех хранимых политиках доступа, указанных в очереди, которые могут использоваться с подписанными URL-адресами.
get_queue_metadata	Извлекает определяемые пользователем метаданные и свойства очереди в указанной очереди. Метаданные связаны с очередью в виде пар "имя-значение".
get_queue_service_properties	Возвращает свойства службы очередей учетной записи хранения, включая ведение журнала, аналитику и правила CORS.
get_queue_service_stats	Получает статистику, связанную с репликацией службы очередей. Он доступен, только если для учетной записи хранения включена геоизбыточная репликация с доступом на чтение. Благодаря географически избыточной репликации хранилище Azure надежно хранит ваши данные в двух расположениях. В обоих расположениях хранилище Azure поддерживает несколько работоспособных копий данных. Расположение, в котором вы читаете, создаете, обновляете или удаляете данные, является первичным расположением учетной записи хранилища. Основное расположение находится в регионе, выбранном при создании учетной записи с помощью классического портала Azure управления Azure, например в центрально-северной части США. Расположение, в которое ваши данные реплицируются, — это вторичное расположение. Оно определяется автоматически, исходя из выбранного первичного расположения. Это второй центр обработки данных в том же регионе, где находится первичное расположение. Во вторичном расположении предоставляется доступ только для чтения, если для вашей учетной записи хранилища включена географически избыточная репликация с доступом только для чтения.
list_queues	Возвращает генератор для вывода списка очередей. Генератор будет лениво следовать маркерам продолжения, возвращенным службой, и останавливаться при возвращении всех очередей или достижении num_results. Если указано num_results и в учетной записи большее количество очередей, генератор будет иметь заполненное поле next_marker после завершения. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.
peek_messages	Извлекает одно или несколько сообщений из передней части очереди, но не изменяет видимость сообщения. Можно извлекать только видимые сообщения. Когда сообщение извлекается в первый раз с вызовом get_messages, его dequeue_count свойству присваивается значение 1. Если он не удаляется, а затем возвращается снова, свойство dequeue_count увеличивается. Клиент может использовать это значение, чтобы определить, сколько раз извлекалось сообщение. Обратите внимание, что вызов peek_messages не увеличивает значение DequeueCount, а возвращает это значение для чтения клиентом. Если для локального объекта службы задано поле key-encryption-key или resolver, сообщения будут расшифрованы перед возвратом.
put_message	Добавляет новое сообщение в заднюю часть очереди сообщений. Время ожидания видимости указывает время, когда сообщение будет невидимым. После истечения времени ожидания сообщение станет видимым. Если время ожидания видимости не указано, по умолчанию используется значение 0. Срок жизни сообщения указывает, как долго сообщение будет оставаться в очереди. При истечении срока существования сообщение удаляется из очереди. Если для локального объекта службы задано поле key-encryption-key, этот метод шифрует содержимое перед отправкой.
set_proxy	Задает узел прокси-сервера и порт для туннелирования HTTP CONNECT.
set_queue_acl	Задает хранимые политики доступа для очереди, которая может быть использована с подписями коллективного доступа. При установке разрешений для очереди существующие разрешения заменяются. Чтобы обновить разрешения очереди, вызовите get_queue_acl для получения всех политик доступа, связанных с очередью, измените политику доступа, которую вы хотите изменить, а затем вызовите эту функцию с полным набором данных для выполнения обновления. Для ввода в действие хранимой политики доступа в очереди после настройки может потребоваться до 30 секунд. В течение этого интервала подписанный URL-адрес, связанный с хранимой политикой доступа, будет вызывать исключение , <xref:azure.storage.queue.queueservice.AzureHttpError> пока политика доступа не станет активной.
set_queue_metadata	Задает определяемые пользователем метаданные в указанной очереди. Метаданные связаны с очередью в виде пар "имя-значение".
set_queue_service_properties	Задает свойства службы очередей учетной записи хранения, включая Аналитика Службы хранилища Azure. Если элемент (например, Ведение журнала) остается как Нет, существующие в службе параметры для этой функции сохраняются. Дополнительные сведения о Аналитика Службы хранилища Azure см. в разделе https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.
update_message	Обновления время ожидания видимости сообщения. Можно также воспользоваться этой операцией для обновления содержимого сообщений. Эту операцию можно использовать для постоянного расширения невидимости сообщения очереди. Эта функция может быть полезна, если требуется, чтобы рабочая роль "арендовы" сообщения очереди. Например, если рабочая роль вызывает get_messages и понимает, что ей требуется больше времени для обработки сообщения, она может постоянно расширять невидимость сообщения, пока не будет обработано. Если рабочая роль завершалась ошибкой во время обработки, то сообщение в конечном итоге снова становилось бы видимым и его могла бы обработать другая рабочая роль. Если для локального объекта службы задано поле key-encryption-key, этот метод шифрует содержимое перед отправкой.

clear_messages

Удаляет все сообщения из указанной очереди.

clear_messages(queue_name, timeout=None)

Параметры

queue_name

str

Обязательно

Имя очереди, сообщения которой необходимо очистить.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

create_queue

Создает очередь в заданной учетной записи.

create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)

Параметры

queue_name

str

Обязательно

Имя создаваемой очереди. Имя очереди должно содержать от 3 до 63 символов и может содержать только строчные буквы, цифры и дефис (-). Первая и последняя буквы в очереди должны быть буквенно-цифровыми. Символ тире (-) не может быть первым и последним символом. В имени очереди не разрешено применять последовательные символы тире.

metadata

dict(str, str)

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

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

fail_on_exist

bool

значение по умолчанию: False

Указывает, следует ли вызывать исключение, если очередь уже существует.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Логическое значение, указывающее, была ли создана очередь. Если fail_on_exist задано значение True, вместо возврата false будет выполнено исключение.

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

bool

delete_message

Удаляет указанное сообщение.

Обычно после получения клиентом сообщения с помощью операции get_messages клиент должен обработать и удалить сообщение. Чтобы удалить сообщение, необходимо иметь два элемента данных: id и pop_receipt. Идентификатор возвращается из предыдущей операции get_messages. Pop_receipt возвращается из последней get_messages операции или update_message . Для успешного выполнения операции delete_message pop_receipt, указанный в запросе, должен соответствовать pop_receipt, возвращенным из get_messages операции или update_message .

delete_message(queue_name, message_id, pop_receipt, timeout=None)

Параметры

queue_name

str

Обязательно

Имя очереди, из которой удаляется сообщение.

message_id

str

Обязательно

Идентификатор сообщения, определяющий удаляемое сообщение.

pop_receipt

str

Обязательно

Допустимое значение всплывающего уведомления, возвращенное из предыдущего вызова get_messages или update_message.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

delete_queue

Удаляет указанную очередь и все содержащиеся в ней сообщения.

После успешного удаления очередь сразу же помечается для удаления и становится недоступной для клиентов. Впоследствии очередь удаляется из службы очередей в процессе сборки мусора.

Обратите внимание, что удаление очереди, скорее всего, займет не менее 40 секунд. При попытке выполнить операцию с очередью во время ее удаления <xref:azure.storage.queue.queueservice.AzureConflictHttpError> будет выдано исключение .

delete_queue(queue_name, fail_not_exist=False, timeout=None)

Параметры

queue_name

str

Обязательно

Имя удаляемой очереди.

fail_not_exist

bool

значение по умолчанию: False

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

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Логическое значение, указывающее, была ли удалена очередь. Если fail_not_exist задано значение True, вместо возврата false будет возвращено исключение .

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

bool

exists

Возвращает логическое значение, указывающее, существует ли очередь.

exists(queue_name, timeout=None)

Параметры

queue_name

str

Обязательно

Имя очереди, проверка для существования.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Логическое значение, указывающее, существует ли очередь.

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

bool

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Параметры

retry_context

Обязательно

generate_account_shared_access_signature

Создает подписанный URL-адрес для службы очередей. Используйте возвращенную подпись с параметром sas_token QueueService.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Параметры

resource_types

<xref:ResourceTypes>

Обязательно

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

permission

<xref:AccountPermissions>

Обязательно

Разрешения, связанные с подписанным 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

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

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

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

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

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

str

generate_queue_shared_access_signature

Создает подписанный URL-адрес для очереди. Используйте возвращенную сигнатуру с параметром sas_token QueueService.

generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)

Параметры

queue_name

str

Обязательно

Имя очереди для создания маркера SAS.

permission

QueuePermissions

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

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

expiry

datetime или str

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

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

start

datetime или str

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

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

id

str

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

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

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

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

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

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

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

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

str

get_messages

Извлекает одно или несколько сообщений из передней части очереди.

При извлечении сообщения из очереди ответ включает содержимое сообщения и значение pop_receipt, необходимое для удаления сообщения. Сообщение не удаляется из очереди автоматически, но после его извлечения оно не отображается другим клиентам в течение интервала времени, указанного параметром visibility_timeout.

Если для локального объекта службы задано поле key-encryption-key или resolver, сообщения будут расшифрованы перед возвратом.

get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)

Параметры

queue_name

str

Обязательно

Имя очереди для получения сообщений.

num_messages

int

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

Ненулевое целочисленное значение, которое определяет количество сообщений для получения из очереди (не более 32). Если видимых сообщений меньше, то возвращаются только видимые. По умолчанию эта операция возвращает одно сообщение из очереди.

visibility_timeout

int

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

Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Новое значение должно быть больше или равно 1 секунде и не может превышать 7 дней. Время ожидания видимости сообщения может быть задано позже истечения срока.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Объект QueueMessage , представляющий переданную информацию.

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

list(QueueMessage)

get_queue_acl

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

get_queue_acl(queue_name, timeout=None)

Параметры

queue_name

str

Обязательно

Имя существующей очереди.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Словарь политик доступа, связанных с очередью.

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

dict(str, AccessPolicy)

get_queue_metadata

Извлекает определяемые пользователем метаданные и свойства очереди в указанной очереди. Метаданные связаны с очередью в виде пар "имя-значение".

get_queue_metadata(queue_name, timeout=None)

Параметры

queue_name

str

Обязательно

Имя существующей очереди.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Словарь, представляющий метаданные очереди со свойством approximate_message_count int в дикте, оценивающим количество сообщений в очереди.

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

dict(str, str)

get_queue_service_properties

Возвращает свойства службы очередей учетной записи хранения, включая ведение журнала, аналитику и правила CORS.

get_queue_service_properties(timeout=None)

Параметры

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Свойства службы очередей.

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

ServiceProperties

get_queue_service_stats

Получает статистику, связанную с репликацией службы очередей. Он доступен, только если для учетной записи хранения включена геоизбыточная репликация с доступом на чтение.

Благодаря географически избыточной репликации хранилище Azure надежно хранит ваши данные в двух расположениях. В обоих расположениях хранилище Azure поддерживает несколько работоспособных копий данных. Расположение, в котором вы читаете, создаете, обновляете или удаляете данные, является первичным расположением учетной записи хранилища. Основное расположение находится в регионе, выбранном при создании учетной записи с помощью классического портала Azure управления Azure, например в центрально-северной части США. Расположение, в которое ваши данные реплицируются, — это вторичное расположение. Оно определяется автоматически, исходя из выбранного первичного расположения. Это второй центр обработки данных в том же регионе, где находится первичное расположение. Во вторичном расположении предоставляется доступ только для чтения, если для вашей учетной записи хранилища включена географически избыточная репликация с доступом только для чтения.

get_queue_service_stats(timeout=None)

Параметры

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Статистика службы очередей.

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

ServiceStats

list_queues

Возвращает генератор для вывода списка очередей. Генератор будет лениво следовать маркерам продолжения, возвращенным службой, и останавливаться при возвращении всех очередей или достижении num_results.

Если указано num_results и в учетной записи большее количество очередей, генератор будет иметь заполненное поле next_marker после завершения. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.

list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)

Параметры

prefix

str

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

Фильтрует результаты для возвращения только очередей с именами, начинающимися с указанного префикса.

num_results

int

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

Максимальное количество возвращаемых очередей.

include_metadata

bool

значение по умолчанию: False

Указывает, что метаданные контейнера возвращаются в ответе.

marker

str

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

Непрозрачный маркер продолжения. Это значение можно получить из поля next_marker предыдущего объекта генератора, если num_results был указан и этот генератор завершил перечисление результатов. Если этот генератор указан, он начнет возвращать результаты с точки, где остановлен предыдущий генератор.

timeout

int

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

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

peek_messages

Извлекает одно или несколько сообщений из передней части очереди, но не изменяет видимость сообщения.

Можно извлекать только видимые сообщения. Когда сообщение извлекается в первый раз с вызовом get_messages, его dequeue_count свойству присваивается значение 1. Если он не удаляется, а затем возвращается снова, свойство dequeue_count увеличивается. Клиент может использовать это значение, чтобы определить, сколько раз извлекалось сообщение. Обратите внимание, что вызов peek_messages не увеличивает значение DequeueCount, а возвращает это значение для чтения клиентом.

Если для локального объекта службы задано поле key-encryption-key или resolver, сообщения будут расшифрованы перед возвратом.

peek_messages(queue_name, num_messages=None, timeout=None)

Параметры

queue_name

str

Обязательно

Имя очереди для просмотра сообщений.

num_messages

int

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

Безнулевое целочисленное значение, которое определяет количество сообщений для извлечения из очереди (не более 32). По умолчанию эта операция извлекает одно сообщение из очереди.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Список объектов QueueMessage. Обратите внимание, что time_next_visible и pop_receipt не будут заполнены, так как при просмотре сообщение не отображается и можно получить только уже видимые сообщения.

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

list(QueueMessage)

put_message

Добавляет новое сообщение в заднюю часть очереди сообщений.

Время ожидания видимости указывает время, когда сообщение будет невидимым. После истечения времени ожидания сообщение станет видимым. Если время ожидания видимости не указано, по умолчанию используется значение 0.

Срок жизни сообщения указывает, как долго сообщение будет оставаться в очереди. При истечении срока существования сообщение удаляется из очереди.

Если для локального объекта службы задано поле key-encryption-key, этот метод шифрует содержимое перед отправкой.

put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)

Параметры

queue_name

str

Обязательно

Имя очереди, в который помещалось сообщение.

content

<xref:obj>

Обязательно

Содержимое сообщения. Допустимый тип определяется encode_function, заданным в службе. Значение по умолчанию — str. Закодированное сообщение может иметь размер до 64 КБ.

visibility_timeout

int

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

Если не указано, значение по умолчанию равно 0. Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Значение должно быть больше или равно 0 и не может превышать 7 дней. Для времени ожидания видимости сообщения нельзя задать значение позже истечения срока. visibility_timeout должно быть задано значение меньше срока жизни.

time_to_live

int

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

Задает интервал срока существования сообщения в секундах. Срок жизни может быть любым положительным числом или -1 для бесконечности. Если этот параметр пропущен, по умолчанию срок существования составляет 7 дней.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Объект QueueMessage. Этот объект также заполняется содержимым, хотя он не возвращается из службы.

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

QueueMessage

set_proxy

Задает узел прокси-сервера и порт для туннелирования HTTP CONNECT.

set_proxy(host, port, user=None, password=None)

Параметры

host

str

Обязательно

Адрес прокси-сервера. Например: '192.168.0.100'

port

int

Обязательно

Порт прокси-сервера. Например: 6000

user

str

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

Пользователь для авторизации прокси-сервера.

password

str

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

Пароль для авторизации прокси-сервера.

set_queue_acl

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

При установке разрешений для очереди существующие разрешения заменяются. Чтобы обновить разрешения очереди, вызовите get_queue_acl для получения всех политик доступа, связанных с очередью, измените политику доступа, которую вы хотите изменить, а затем вызовите эту функцию с полным набором данных для выполнения обновления.

Для ввода в действие хранимой политики доступа в очереди после настройки может потребоваться до 30 секунд. В течение этого интервала подписанный URL-адрес, связанный с хранимой политикой доступа, будет вызывать исключение , <xref:azure.storage.queue.queueservice.AzureHttpError> пока политика доступа не станет активной.

set_queue_acl(queue_name, signed_identifiers=None, timeout=None)

Параметры

queue_name

str

Обязательно

Имя существующей очереди.

signed_identifiers

dict(str, AccessPolicy)

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

Словарь политик доступа, которые необходимо связать с очередью. Словарь может содержать до 5 элементов. Пустой словарь очистит политики доступа, заданные в службе.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

set_queue_metadata

Задает определяемые пользователем метаданные в указанной очереди. Метаданные связаны с очередью в виде пар "имя-значение".

set_queue_metadata(queue_name, metadata=None, timeout=None)

Параметры

queue_name

str

Обязательно

Имя существующей очереди.

metadata

dict

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

Дикт, содержащий пары "имя-значение", которые необходимо связать с очередью в качестве метаданных.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

set_queue_service_properties

Задает свойства службы очередей учетной записи хранения, включая Аналитика Службы хранилища Azure. Если элемент (например, Ведение журнала) остается как Нет, существующие в службе параметры для этой функции сохраняются. Дополнительные сведения о Аналитика Службы хранилища Azure см. в разделе https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.

set_queue_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

Параметры

logging

<xref:Logging>

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

Параметры ведения журнала предоставляют журналы запросов.

hour_metrics

<xref:Metrics>

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

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

minute_metrics

<xref:Metrics>

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

Параметры метрик минуты предоставляют статистику запросов за каждую минуту для очередей.

cors

list(CorsRule)

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

В список можно включить до пяти элементов CorsRule. Если указан пустой список, все правила CORS будут удалены, а CORS будет отключен для службы. Дополнительные сведения о правилах CORS и логике оценки см. в разделе https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

update_message

Обновления время ожидания видимости сообщения. Можно также воспользоваться этой операцией для обновления содержимого сообщений.

Эту операцию можно использовать для постоянного расширения невидимости сообщения очереди. Эта функция может быть полезна, если требуется, чтобы рабочая роль "арендовы" сообщения очереди. Например, если рабочая роль вызывает get_messages и понимает, что ей требуется больше времени для обработки сообщения, она может постоянно расширять невидимость сообщения, пока не будет обработано. Если рабочая роль завершалась ошибкой во время обработки, то сообщение в конечном итоге снова становилось бы видимым и его могла бы обработать другая рабочая роль.

Если для локального объекта службы задано поле key-encryption-key, этот метод шифрует содержимое перед отправкой.

update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)

Параметры

queue_name

str

Обязательно

Имя очереди, содержащей сообщение для обновления.

message_id

str

Обязательно

Идентификатор сообщения, идентифицируя обновляемого сообщения.

pop_receipt

str

Обязательно

Допустимое значение подтверждения, полученное из предыдущего вызова метода get_messages или операции update_message.

visibility_timeout

int

Обязательно

Указывает новое значение времени ожидания видимости в секундах, отсчитываемое относительно времени сервера. Новое значение должно быть больше или равно 0 и не может превышать 7 дней. Для времени ожидания видимости сообщения нельзя задать значение позже истечения срока. Сообщения можно обновлять, пока оно не будет удалено или пока не кончится срок его действия.

content

<xref:obj>

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

Содержимое сообщения. Допустимый тип определяется encode_function, заданным в службе. Значение по умолчанию — str.

timeout

int

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

Время ожидания сервера, выраженное в секундах.

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

Список объектов QueueMessage. Для удобства этот объект также заполняется содержимым, хотя он не возвращается службой.

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

list(QueueMessage)

Атрибуты

protocol

request_session

socket_timeout