A client to interact with a specific Queue.
For more optional configuration, please click here.
ConstructorQueueClient(account_url: str, queue_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, api_version: str | None = None, secondary_hostname: str | None = None, message_encode_policy: BinaryBase64EncodePolicy | TextBase64EncodePolicy | None = None, message_decode_policy: BinaryBase64DecodePolicy | TextBase64DecodePolicy | None = None, audience: str | None = None, **kwargs: Any)Create the queue client with url and credential.
token_auth_queue = QueueClient.from_queue_url(queue_url=queue.url, credential=sas_token)
Deletes all messages from the specified queue.
closeThis method is to close the sockets opened by the client. It need not be used when using with a context manager.
create_queueCreates a new queue in the storage account.
If a queue with the same name already exists, the operation fails with a ResourceExistsError.
delete_messageDeletes the specified message.
Normally after a client retrieves a message with the receive messages operation, the client is expected to process and delete the message. To delete the message, you must have the message object itself, or two items of data: id and pop_receipt. The id is returned from the previous receive_messages operation. The pop_receipt is returned from the most recent receive_messages or update_message operation. In order for the delete_message operation to succeed, the pop_receipt specified on the request must match the pop_receipt returned from the receive_messages or update_message operation.
delete_queueDeletes the specified queue and any messages it contains.
When a queue is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The queue is later removed from the Queue service during garbage collection.
Note that deleting a queue is likely to take at least 40 seconds to complete. If an operation is attempted against the queue while it was being deleted, an ~azure.core.exceptions.HttpResponseError will be thrown.
from_connection_stringCreate QueueClient from a Connection String.
from_queue_urlA client to interact with a specific Queue.
get_queue_access_policyReturns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
get_queue_propertiesReturns all user-defined metadata for the specified queue.
The data returned does not include the queue's list of messages.
peek_messagesRetrieves one or more messages from the front of the queue, but does not alter the visibility of the message.
Only messages that are visible may be retrieved. When a message is retrieved for the first time with a call to receive_messages, its dequeue_count property is set to 1. If it is not deleted and is subsequently retrieved again, the dequeue_count property is incremented. The client may use this value to determine how many times a message has been retrieved. Note that a call to peek_messages does not increment the value of dequeue_count, but returns this value for the client to read.
If the key-encryption-key or resolver field is set on the local service object, the messages will be decrypted before being returned.
receive_messageRemoves one message from the front of the queue.
When the message is retrieved from the queue, the response includes the message content and a pop_receipt value, which is required to delete the message. The message is not automatically deleted from the queue, but after it has been retrieved, it is not visible to other clients for the time interval specified by the visibility_timeout parameter.
If the key-encryption-key or resolver field is set on the local service object, the message will be decrypted before being returned.
receive_messagesRemoves one or more messages from the front of the queue.
When a message is retrieved from the queue, the response includes the message content and a pop_receipt value, which is required to delete the message. The message is not automatically deleted from the queue, but after it has been retrieved, it is not visible to other clients for the time interval specified by the visibility_timeout parameter. The iterator will continuously fetch messages until the queue is empty or max_messages is reached (if max_messages is set).
If the key-encryption-key or resolver field is set on the local service object, the messages will be decrypted before being returned.
send_messageAdds a new message to the back of the message queue.
The visibility timeout specifies the time that the message will be invisible. After the timeout expires, the message will become visible. If a visibility timeout is not specified, the default value of 0 is used.
The message time-to-live specifies how long a message will remain in the queue. The message will be deleted from the queue when the time-to-live period expires.
If the key-encryption-key field is set on the local service object, this method will encrypt the content before uploading.
set_queue_access_policySets stored access policies for the queue that may be used with Shared Access Signatures.
When you set permissions for a queue, the existing permissions are replaced. To update the queue's permissions, call get_queue_access_policy to fetch all access policies associated with the queue, modify the access policy that you wish to change, and then call this function with the complete set of data to perform the update.
When you establish a stored access policy on a queue, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will throw an ~azure.core.exceptions.HttpResponseError until the access policy becomes active.
set_queue_metadataSets user-defined metadata on the specified queue.
Metadata is associated with the queue as name-value pairs.
update_messageUpdates the visibility timeout of a message. You can also use this operation to update the contents of a message.
This operation can be used to continually extend the invisibility of a queue message. This functionality can be useful if you want a worker role to "lease" a queue message. For example, if a worker role calls receive_messages and recognizes that it needs more time to process a message, it can continually extend the message's invisibility until it is processed. If the worker role were to fail during processing, eventually the message would become visible again and another worker role could process it.
If the key-encryption-key field is set on the local service object, this method will encrypt the content before uploading.
clear_messagesDeletes all messages from the specified queue.
clear_messages(*, timeout: int | None = None, **kwargs: Any) -> NoneClears all messages.
queue.clear_messages()
This method is to close the sockets opened by the client. It need not be used when using with a context manager.
close() -> NoneCreates a new queue in the storage account.
If a queue with the same name already exists, the operation fails with a ResourceExistsError.
create_queue(*, metadata: Dict[str, str] | None = None, timeout: int | None = None, **kwargs: Any) -> NoneCreate a queue.
queue.create_queue()
Deletes the specified message.
Normally after a client retrieves a message with the receive messages operation, the client is expected to process and delete the message. To delete the message, you must have the message object itself, or two items of data: id and pop_receipt. The id is returned from the previous receive_messages operation. The pop_receipt is returned from the most recent receive_messages or update_message operation. In order for the delete_message operation to succeed, the pop_receipt specified on the request must match the pop_receipt returned from the receive_messages or update_message operation.
delete_message(message: str | QueueMessage, pop_receipt: str | None = None, *, timeout: int | None = None, **kwargs: Any) -> NoneDelete a message.
# Get the message at the front of the queue
msg = next(queue.receive_messages())
# Delete the specified message
queue.delete_message(msg)
Deletes the specified queue and any messages it contains.
When a queue is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The queue is later removed from the Queue service during garbage collection.
Note that deleting a queue is likely to take at least 40 seconds to complete. If an operation is attempted against the queue while it was being deleted, an ~azure.core.exceptions.HttpResponseError will be thrown.
delete_queue(*, timeout: int | None = None, **kwargs: Any) -> NoneDelete a queue.
queue.delete_queue()
Create QueueClient from a Connection String.
from_connection_string(conn_str: str, queue_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, api_version: str | None = None, secondary_hostname: str | None = None, message_encode_policy: BinaryBase64EncodePolicy | TextBase64EncodePolicy | None = None, message_decode_policy: BinaryBase64DecodePolicy | TextBase64DecodePolicy | None = None, audience: str | None = None, **kwargs: Any) -> SelfCreate the queue client from connection string.
from azure.storage.queue import QueueClient
queue = QueueClient.from_connection_string(self.connection_string, "myqueue1")
if queue.account_name is None:
print("Connection string did not provide an account name." + "\n" + "Test: set_access_policy")
sys.exit(1)
A client to interact with a specific Queue.
from_queue_url(queue_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, api_version: str | None = None, secondary_hostname: str | None = None, message_encode_policy: BinaryBase64EncodePolicy | TextBase64EncodePolicy | None = None, message_decode_policy: BinaryBase64DecodePolicy | TextBase64DecodePolicy | None = None, audience: str | None = None, **kwargs: Any) -> SelfReturns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
get_queue_access_policy(*, timeout: int | None = None, **kwargs: Any) -> Dict[str, AccessPolicy]Returns all user-defined metadata for the specified queue.
The data returned does not include the queue's list of messages.
get_queue_properties(*, timeout: int | None = None, **kwargs: Any) -> QueuePropertiesGet the properties on the queue.
properties = queue.get_queue_properties().metadata
Retrieves one or more messages from the front of the queue, but does not alter the visibility of the message.
Only messages that are visible may be retrieved. When a message is retrieved for the first time with a call to receive_messages, its dequeue_count property is set to 1. If it is not deleted and is subsequently retrieved again, the dequeue_count property is incremented. The client may use this value to determine how many times a message has been retrieved. Note that a call to peek_messages does not increment the value of dequeue_count, but returns this value for the client to read.
If the key-encryption-key or resolver field is set on the local service object, the messages will be decrypted before being returned.
peek_messages(max_messages: int | None = None, *, timeout: int | None = None, **kwargs: Any) -> List[QueueMessage]Peek messages.
# Peek at one message at the front of the queue
msg = queue.peek_messages()
# Peek at the last 5 messages
messages = queue.peek_messages(max_messages=5)
# Print the last 5 messages
for message in messages:
print(message.content)
Removes one message from the front of the queue.
When the message is retrieved from the queue, the response includes the message content and a pop_receipt value, which is required to delete the message. The message is not automatically deleted from the queue, but after it has been retrieved, it is not visible to other clients for the time interval specified by the visibility_timeout parameter.
If the key-encryption-key or resolver field is set on the local service object, the message will be decrypted before being returned.
receive_message(*, visibility_timeout: int | None = None, timeout: int | None = None, **kwargs: Any) -> QueueMessage | NoneReceive one message from the queue.
# Pop two messages from the front of the queue
message1 = queue.receive_message()
message2 = queue.receive_message()
# We should see message 3 if we peek
message3 = queue.peek_messages()[0]
if not message1 or not message2 or not message3:
raise ValueError("One of the messages are None.")
print(message1.content)
print(message2.content)
print(message3.content)
Removes one or more messages from the front of the queue.
When a message is retrieved from the queue, the response includes the message content and a pop_receipt value, which is required to delete the message. The message is not automatically deleted from the queue, but after it has been retrieved, it is not visible to other clients for the time interval specified by the visibility_timeout parameter. The iterator will continuously fetch messages until the queue is empty or max_messages is reached (if max_messages is set).
If the key-encryption-key or resolver field is set on the local service object, the messages will be decrypted before being returned.
receive_messages(*, messages_per_page: int | None = None, visibility_timeout: int | None = None, max_messages: int | None = None, timeout: int | None = None, **kwargs: Any) -> ItemPaged[QueueMessage]Receive messages from the queue.
# Receive messages one-by-one
messages = queue.receive_messages()
for msg in messages:
print(msg.content)
# Receive messages by batch
messages = queue.receive_messages(messages_per_page=5)
for msg_batch in messages.by_page():
for msg in msg_batch:
print(msg.content)
queue.delete_message(msg)
Adds a new message to the back of the message queue.
The visibility timeout specifies the time that the message will be invisible. After the timeout expires, the message will become visible. If a visibility timeout is not specified, the default value of 0 is used.
The message time-to-live specifies how long a message will remain in the queue. The message will be deleted from the queue when the time-to-live period expires.
If the key-encryption-key field is set on the local service object, this method will encrypt the content before uploading.
send_message(content: object | None, *, visibility_timeout: int | None = None, time_to_live: int | None = None, timeout: int | None = None, **kwargs: Any) -> QueueMessageSend messages.
queue.send_message("message1")
queue.send_message("message2", visibility_timeout=30) # wait 30s before becoming visible
queue.send_message("message3")
queue.send_message("message4")
queue.send_message("message5")
Sets stored access policies for the queue that may be used with Shared Access Signatures.
When you set permissions for a queue, the existing permissions are replaced. To update the queue's permissions, call get_queue_access_policy to fetch all access policies associated with the queue, modify the access policy that you wish to change, and then call this function with the complete set of data to perform the update.
When you establish a stored access policy on a queue, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will throw an ~azure.core.exceptions.HttpResponseError until the access policy becomes active.
set_queue_access_policy(signed_identifiers: Dict[str, AccessPolicy], *, timeout: int | None = None, **kwargs: Any) -> NoneSet an access policy on the queue.
# Create an access policy
from azure.storage.queue import AccessPolicy, QueueSasPermissions
access_policy = AccessPolicy()
access_policy.start = datetime.utcnow() - timedelta(hours=1)
access_policy.expiry = datetime.utcnow() + timedelta(hours=1)
access_policy.permission = QueueSasPermissions(read=True)
identifiers = {"my-access-policy-id": access_policy}
# Set the access policy
queue.set_queue_access_policy(identifiers)
Sets user-defined metadata on the specified queue.
Metadata is associated with the queue as name-value pairs.
set_queue_metadata(metadata: Dict[str, str] | None = None, *, timeout: int | None = None, **kwargs: Any) -> Dict[str, Any]Set metadata on the queue.
metadata = {"foo": "val1", "bar": "val2", "baz": "val3"}
queue.set_queue_metadata(metadata=metadata)
Updates the visibility timeout of a message. You can also use this operation to update the contents of a message.
This operation can be used to continually extend the invisibility of a queue message. This functionality can be useful if you want a worker role to "lease" a queue message. For example, if a worker role calls receive_messages and recognizes that it needs more time to process a message, it can continually extend the message's invisibility until it is processed. If the worker role were to fail during processing, eventually the message would become visible again and another worker role could process it.
If the key-encryption-key field is set on the local service object, this method will encrypt the content before uploading.
update_message(message: str | QueueMessage, pop_receipt: str | None = None, content: object | None = None, *, visibility_timeout: int | None = None, timeout: int | None = None, **kwargs: Any) -> QueueMessageUpdate a message.
# Send a message
queue.send_message("update me")
# Receive the message
messages = queue.receive_messages()
# Update the message
list_result = next(messages)
message = queue.update_message(
list_result.id, pop_receipt=list_result.pop_receipt, visibility_timeout=0, content="updated"
)
The version of the Storage API used for requests.
Returns location_modeThe location mode that the client is currently using.
By default this will be "primary". Options include "primary" and "secondary".
Returns primary_endpointThe full primary endpoint URL.
Returns primary_hostnameThe hostname of the primary endpoint.
Returns secondary_endpointThe full secondary endpoint URL if configured.
If not available a ValueError will be raised. To explicitly specify a secondary hostname, use the optional secondary_hostname keyword argument on instantiation.
Returns Exceptions secondary_hostnameThe hostname of the secondary endpoint.
If not available this will be None. To explicitly specify a secondary hostname, use the optional secondary_hostname keyword argument on instantiation.
Returns urlThe full endpoint URL to this entity, including SAS token if used.
This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.
ReturnsRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4