Compartir a través de

queue Paquete

  • Referencia

Paquetes

aio

Clases

AccessPolicy

Clase de directiva de acceso usada por el conjunto y obtención de métodos de directiva de acceso.

Una directiva de acceso almacenada puede especificar la hora de inicio, la hora de expiración y los permisos para las firmas de acceso compartido con las que está asociada. En función de cómo quiera controlar el acceso al recurso, puede especificar todos estos parámetros en la directiva de acceso almacenado y omitirlos de la dirección URL de la firma de acceso compartido. De esta forma, podrá modificar el comportamiento de la firma asociada en cualquier momento, así como revocarla. O puede especificar uno o más de los parámetros de la directiva de acceso en la directiva de acceso almacenada y el resto en la dirección URL. Por último, puede especificar todos los parámetros en la dirección URL. En este caso, puede utilizar la directiva de acceso almacenada para revocar la firma, pero no para modificar su comportamiento.

Es preciso que la firma de acceso compartido y la directiva de acceso almacenada, en su conjunto, incluyan todos los campos necesarios para autenticar la firma. Si falta alguno de los campos necesarios, la solicitud producirá un error. Asimismo, si un campo se especifica en la dirección URL de la firma de acceso compartido y en la directiva de acceso almacenada, la solicitud producirá un error con el código de estado 400 (solicitud incorrecta).
AccountSasPermissions

ResourceTypes clase que se va a usar con generate_account_sas función y para accessPolicies usada con set_*_acl. Hay dos tipos de SAS que se pueden usar para conceder acceso a los recursos. Uno es conceder acceso a un recurso específico (específico del recurso). Otro es conceder acceso a todo el servicio para una cuenta específica y permitir determinadas operaciones en función de las perms que se encuentran aquí.
BinaryBase64DecodePolicy

Directiva de descodificación de mensajes para los mensajes codificados en base 64 en bytes.

Descodifica los mensajes codificados en base64 en bytes. Si el contenido de entrada no es válido en base 64, se generará un DecodeError.
BinaryBase64EncodePolicy

Directiva de codificación de mensajes base 64 para mensajes binarios.

Codifica los mensajes binarios en base 64. Si el contenido de entrada no es bytes, se generará un TypeError.
CorsRule

CORS es una característica de HTTP que permite que una aplicación web que se ejecuta en un dominio tenga acceso a recursos de otro dominio. Los exploradores web implementan una restricción de seguridad denominada directiva del mismo origen que impide que una página web llame a las API de otro dominio diferente; CORS proporciona una forma segura de permitir que un dominio (el dominio de origen) llame a las API de otro dominio.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.
ExponentialRetry

Reintento exponencial.

Construye un objeto de reintento exponencial. El initial_backoff se usa para el primer reintento. Los reintentos posteriores se reintentan después de initial_backoff + increment_power^retry_count segundos.
LinearRetry

Reintento lineal.

Construye un objeto de reintento lineal.
LocationMode

Especifica la ubicación a la que se debe enviar la solicitud. Este modo solo se aplica a las cuentas de RA-GRS que permiten el acceso de lectura secundario. Todos los demás tipos de cuenta deben usar PRIMARY.
Metrics

Resumen de las estadísticas de solicitud agrupadas por API en agregados de hora o minuto.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.
QueueAnalyticsLogging

Configuración de registro de Azure Analytics.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.
QueueClient

Un cliente para interactuar con una cola específica.

Para obtener más configuración opcional, haga clic aquí.
QueueMessage

Representa un mensaje de cola.
QueueProperties

Propiedades de cola.
QueueSasPermissions

Clase QueueSasPermissions que se va a usar con la generate_queue_sas función y para accessPolicies usada con set_queue_access_policy.
QueueServiceClient

Un cliente para interactuar con Queue Service en el nivel de cuenta.

Este cliente proporciona operaciones para recuperar y configurar las propiedades de la cuenta, así como enumerar, crear y eliminar colas dentro de la cuenta. Para las operaciones relacionadas con una cola específica, se puede recuperar un cliente para esta entidad mediante la get_queue_client función .

Para obtener más configuración opcional, haga clic aquí.
ResourceTypes

Especifica los tipos de recursos a los que se puede acceder con la SAS de la cuenta.
RetentionPolicy

La directiva de retención que determina cuánto tiempo deben conservarse los datos asociados.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.
TextBase64DecodePolicy

Directiva de descodificación de mensajes para mensajes codificados en base 64 en texto.

Descodifica los mensajes codificados en base64 en texto (unicode). Si el contenido de entrada no es válido en base 64, se generará un DecodeError. Los datos de mensajes deben admitir UTF-8.
TextBase64EncodePolicy

Directiva de codificación de mensajes base 64 para mensajes de texto.

Codifica los mensajes de texto (unicode) en base 64. Si el contenido de entrada no es texto, se generará un TypeError. El texto de entrada debe admitir UTF-8.

Enumeraciones

StorageErrorCode

Funciones

generate_account_sas

Genera una firma de acceso compartido para el servicio de cola.

Use la firma devuelta con el parámetro de credencial de cualquier queue Service.

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

Parámetros

account_name
str
Requerido

Nombre de la cuenta de almacenamiento que se usa para generar la firma de acceso compartido.

account_key
str
Requerido

La clave de cuenta, también denominada clave compartida o clave de acceso, para generar la firma de acceso compartido.

resource_types
ResourceTypes
Requerido

Especifica los tipos de recursos a los que se puede acceder con la SAS de la cuenta.

permission
AccountSasPermissions o str
Requerido

Permisos asociados a la firma de acceso compartido. El usuario está restringido a las operaciones permitidas por los permisos.

expiry
datetime o str
Requerido

Hora en la que la firma de acceso compartido deja de ser válida. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

start
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido es válida. Si se omite, se supone que la hora de inicio de esta llamada es la hora a la que el servicio de almacenamiento recibe la solicitud. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

ip
str
valor predeterminado: None

Especifica una dirección IP o un intervalo de direcciones IP de las que se van a aceptar solicitudes. Si la dirección IP desde la que se origina la solicitud no coincide con la dirección IP o el intervalo de direcciones especificado en el token de SAS, la solicitud no se autentica. Por ejemplo, especificando sip=168.1.5.65 o sip=168.1.5.60-168.1.5.70 en la SAS restringe la solicitud a esas direcciones IP.

protocol
str

Especifica el protocolo permitido para una solicitud realizada. El valor predeterminado es https.

Devoluciones

Un token de firma de acceso compartido (sas).

Tipo de valor devuelto

str

generate_queue_sas

Genera una firma de acceso compartido para una cola.

Use la firma devuelta con el parámetro de credencial de cualquier queue Service.

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

Parámetros

account_name
str
Requerido

Nombre de la cuenta de almacenamiento que se usa para generar la firma de acceso compartido.

queue_name
str
Requerido

Nombre de la cola.

account_key
str
Requerido

La clave de cuenta, también denominada clave compartida o clave de acceso, para generar la firma de acceso compartido.

permission
QueueSasPermissions o str
valor predeterminado: None

Permisos asociados a la firma de acceso compartido. El usuario está restringido a las operaciones permitidas por los permisos. Obligatorio a menos que se indique un policy_id que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada.

expiry
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido deja de ser válida. Obligatorio a menos que se indique un policy_id que haga referencia a una directiva de acceso almacenada que contenga este campo. Este campo se debe omitir si se ha especificado en una directiva de acceso almacenada asociada. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

start
datetime o str
valor predeterminado: None

Hora en la que la firma de acceso compartido es válida. Si se omite, se supone que la hora de inicio de esta llamada es la hora a la que el servicio de almacenamiento recibe la solicitud. Azure siempre convertirá valores a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC.

policy_id
str
valor predeterminado: None

Valor único de hasta 64 caracteres de longitud que se correlaciona con una directiva de acceso almacenada. Para crear una directiva de acceso almacenada, use set_queue_access_policy.

ip
str
valor predeterminado: None

Especifica una dirección IP o un intervalo de direcciones IP de las que se van a aceptar solicitudes. Si la dirección IP desde la que se origina la solicitud no coincide con la dirección IP o el intervalo de direcciones especificado en el token de SAS, la solicitud no se autentica. Por ejemplo, especificando sip='168.1.5.65' o sip='168.1.5.60-168.1.5.70' en la SAS restringe la solicitud a esas direcciones IP.

protocol
str

Especifica el protocolo permitido para una solicitud realizada. El valor predeterminado es https.

Devoluciones

Un token de firma de acceso compartido (sas).

Tipo de valor devuelto

str

Ejemplos

Genere un token 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'
   )