Partager via

queue Paquet

  • Référence

Paquets

aio

Classes

AccessPolicy

Classe de stratégie d’accès utilisée par les méthodes de stratégie d’accès set et get.

Une stratégie d'accès stockée peut spécifier l'heure de début, l'heure d'expiration et les autorisations pour les signatures d'accès partagé auxquelles elle est associée. Selon la façon dont vous souhaitez contrôler l’accès à votre ressource, vous pouvez spécifier tous ces paramètres dans la stratégie d’accès stockée et les omettre de l’URL de la signature d’accès partagé. De cette façon, vous pouvez modifier le comportement de la signature associée à tout moment, de même que la révoquer. Vous pouvez aussi spécifier un ou plusieurs paramètres de stratégie d'accès dans la stratégie d'accès stockée et les autres dans l'URL. Enfin, vous pouvez spécifier tous les paramètres dans l'URL. Dans ce cas, vous pouvez utiliser la stratégie d'accès stockée pour révoquer la signature et non pour modifier son comportement.

La signature d'accès partagé et la stratégie d'accès stockée doivent inclure tous les champs obligatoires pour authentifier la signature. Si les champs obligatoires sont manquants, la demande échoue. De même, si un champ est spécifié dans l'URL de signature d'accès partagé et dans la stratégie d'accès stockée, la demande échoue avec le code d'état 400 (Requête incorrecte).
AccountSasPermissions

ResourceTypes classe à utiliser avec generate_account_sas fonction et pour les accesspolicies utilisées avec set_*_acl. Il existe deux types de SAP qui peuvent être utilisés pour accorder l’accès aux ressources. L’une consiste à accorder l’accès à une ressource spécifique (spécifique à la ressource). Une autre consiste à accorder l’accès à l’ensemble du service pour un compte spécifique et à autoriser certaines opérations basées sur les perms trouvés ici.
BinaryBase64DecodePolicy

Stratégie de décodage de messages pour les messages codés en base 64 en octets.

Décode les messages encodés en base64 en octets. Si le contenu d’entrée n’est pas valide en base 64, un decodeError est déclenché.
BinaryBase64EncodePolicy

Stratégie d’encodage des messages de base 64 pour les messages binaires.

Encode les messages binaires en base 64. Si le contenu d’entrée n’est pas octets, un TypeError est déclenché.
CorsRule

CORS est une fonctionnalité HTTP qui permet à une application web exécutée dans un domaine d'accéder aux ressources d'un autre domaine. Les navigateurs Web implémentent une restriction de sécurité appelée stratégie de même origine qui empêche une page Web d'appeler des API d'un autre domaine ; CORS constitue un moyen sûr pour autoriser un domaine (le domaine d'origine) à appeler des API d'un autre domaine.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
ExponentialRetry

Nouvelle tentative exponentielle.

Construit un objet de nouvelle tentative exponentielle. Le initial_backoff est utilisé pour la première tentative. Les nouvelles tentatives suivantes sont retentées après initial_backoff + increment_power^retry_count secondes.
LinearRetry

Nouvelle tentative linéaire.

Construit un objet de nouvelle tentative linéaire.
LocationMode

Spécifie l’emplacement auquel la demande doit être envoyée. Ce mode s’applique uniquement aux comptes RA-GRS qui autorisent l’accès en lecture secondaire. Tous les autres types de comptes doivent utiliser PRIMARY.
Metrics

Résumé des statistiques de requêtes regroupées par API en agrégats d’heures ou de minutes.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
QueueAnalyticsLogging

Paramètres de journalisation Azure Analytics.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
QueueClient

Client pour interagir avec une file d’attente spécifique.

Pour une configuration plus facultative, cliquez ici.
QueueMessage

Représente un message de file d’attente.
QueueProperties

Propriétés de la file d’attente.
QueueSasPermissions

Classe QueueSasPermissions à utiliser avec la generate_queue_sas fonction et pour accesspolicies utilisée avec set_queue_access_policy.
QueueServiceClient

Client pour interagir avec le service de file d’attente au niveau du compte.

Ce client fournit des opérations pour récupérer et configurer les propriétés du compte, ainsi que répertorier, créer et supprimer des files d’attente dans le compte. Pour les opérations relatives à une file d’attente spécifique, un client pour cette entité peut être récupéré à l’aide de la get_queue_client fonction .

Pour une configuration plus facultative, cliquez ici.
ResourceTypes

Spécifie les types de ressources accessibles avec la signature d’accès partagé du compte.
RetentionPolicy

Stratégie de rétention qui détermine la durée pendant laquelle les données associées doivent être conservées.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
TextBase64DecodePolicy

Stratégie de décodage de message pour les messages encodés en base 64 en texte.

Décode les messages codés en base64 en texte (unicode). Si le contenu d’entrée n’est pas valide en base 64, un decodeError est déclenché. Les données de message doivent prendre en charge UTF-8.
TextBase64EncodePolicy

Stratégie d’encodage des messages en base 64 pour les sms.

Encode les messages texte (unicode) en base 64. Si le contenu d’entrée n’est pas du texte, un TypeError est déclenché. Le texte d’entrée doit prendre en charge UTF-8.

Énumérations

StorageErrorCode

Fonctions

generate_account_sas

Génère une signature d’accès partagé pour le service de file d’attente.

Utilisez la signature retournée avec le paramètre d’informations d’identification d’un service de file d’attente.

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

Paramètres

account_name
str
Obligatoire

Nom du compte de stockage utilisé pour générer la signature d’accès partagé.

account_key
str
Obligatoire

La clé de compte, également appelée clé partagée ou clé d’accès, pour générer la signature d’accès partagé.

resource_types
ResourceTypes
Obligatoire

Spécifie les types de ressources accessibles avec la signature d’accès partagé du compte.

permission
AccountSasPermissions ou str
Obligatoire

Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations.

expiry
datetime ou str
Obligatoire

Heure à laquelle la signature d’accès partagé ne devient plus valide. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.

start
datetime ou str
valeur par défaut: None

Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.

ip
str
valeur par défaut: None

Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP à partir de laquelle la demande provient ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, si vous spécifiez sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la signature d’accès partagé, la demande est restreinte à ces adresses IP.

protocol
str

Spécifie le protocole autorisé pour une demande effectuée. La valeur par défaut est https.

Retours

Jeton de signature d’accès partagé (SAS).

Type de retour

str

generate_queue_sas

Génère une signature d’accès partagé pour une file d’attente.

Utilisez la signature retournée avec le paramètre d’informations d’identification de n’importe quel service de file d’attente.

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

Paramètres

account_name
str
Obligatoire

Nom du compte de stockage utilisé pour générer la signature d’accès partagé.

queue_name
str
Obligatoire

Nom de la file d'attente.

account_key
str
Obligatoire

La clé de compte, également appelée clé partagée ou clé d’accès, pour générer la signature d’accès partagé.

permission
QueueSasPermissions ou str
valeur par défaut: None

Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Obligatoire, sauf si un policy_id fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée.

expiry
datetime ou str
valeur par défaut: None

Heure à laquelle la signature d’accès partagé ne devient plus valide. Obligatoire, sauf si un policy_id fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.

start
datetime ou str
valeur par défaut: None

Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC.

policy_id
str
valeur par défaut: None

Valeur unique d’une longueur maximale de 64 caractères qui correspond à une stratégie d’accès stockée. Pour créer une stratégie d’accès stockée, utilisez set_queue_access_policy.

ip
str
valeur par défaut: None

Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP à partir de laquelle la demande provient ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, si vous spécifiez sip='168.1.5.65' ou sip='168.1.5.60-168.1.5.70' sur la SAP, la demande est restreinte à ces adresses IP.

protocol
str

Spécifie le protocole autorisé pour une demande effectuée. La valeur par défaut est https.

Retours

Jeton de signature d’accès partagé (sas).

Type de retour

str

Exemples

Générez un jeton 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'
   )