queue Paket

  • Referenz

Pakete

aio

Klassen

AccessPolicy

Access Policy class used by the set and get access policy methods.

Eine gespeicherte Zugriffsrichtlinie kann die Startzeit, die Ablaufzeit und die Berechtigungen für die SAS angeben, denen sie zugeordnet ist. Je nachdem, wie Sie den Zugriff auf Ihre Ressource steuern möchten, können Sie alle diese Parameter in der gespeicherten Zugriffsrichtlinie angeben und sie in der URL für die Shared Access Signature weglassen. Auf diese Weise können Sie das Verhalten der zugeordneten Signatur jederzeit ändern sowie aufheben. Oder Sie können einen oder mehrere der Zugriffsrichtlinienparameter in der gespeicherten Zugriffsrichtlinie und die anderen Zugriffsrichtlinienparameter in der URL angeben. Schließlich können Sie alle Parameter in der URL angeben. In diesem Fall können Sie die gespeicherte Zugriffsrichtlinie verwenden, um die Signatur aufzuheben, aber nicht um ihr Verhalten zu ändern.

Die SAS und die gespeicherte Zugriffsrichtlinie müssen zusammen alle Felder enthalten, die zum Authentifizieren der Signatur erforderlich sind. Wenn eines der Pflichtfelder fehlt, schlägt die Anforderung fehl. Wenn ein Feld sowohl in der SAS-URL als auch in der gespeicherten Zugriffsrichtlinie angegeben ist, schlägt die Anforderung mit dem Statuscode 400 (Ungültige Anforderung) fehl.
AccountSasPermissions

ResourceTypes -Klasse, die mit generate_account_sas-Funktion und für die AccessPolicies verwendet werden soll, die mit set_*_acl verwendet wird. Es gibt zwei Sas-Typen, die zum Gewähren des Ressourcenzugriffs verwendet werden können. Eine besteht darin, Zugriff auf eine bestimmte Ressource (ressourcenspezifisch) zu gewähren. Eine andere besteht darin, zugriff auf den gesamten Dienst für ein bestimmtes Konto zu gewähren und bestimmte Vorgänge basierend auf den hier gefundenen Beständigkeiten zuzulassen.
BinaryBase64DecodePolicy

Richtlinie zur Nachrichtendecodierung für 64-codierte Basisnachrichten in Bytes.

Decodiert base64-codierte Nachrichten in Bytes. Wenn der Eingabeinhalt nicht auf Basis 64 gültig ist, wird ein DecodeError ausgelöst.
BinaryBase64EncodePolicy

Basis-64-Nachrichtencodierungsrichtlinie für binäre Nachrichten.

Codiert binäre Nachrichten in Basis 64. Wenn der Eingabeinhalt keine Bytes ist, wird ein TypeError ausgelöst.
CorsRule

CORS ist eine HTTP-Funktion, die einer Webanwendung in einer Domäne den Zugriff auf Ressourcen in einer anderen Domäne ermöglicht. Webbrowser implementieren eine als same-origin-Richtlinie bekannte Sicherheitseinschränkung, die verhindert, dass eine Website APIs in einer anderen Domäne aufruft. CORS ist eine sichere Methode, um einer Domäne (der Ursprungsdomäne) den Aufruf von APIs in einer anderen Domäne zu ermöglichen.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.
ExponentialRetry

Exponentielle Wiederholung.

Erstellt ein Exponentielles Wiederholungsobjekt. Die initial_backoff wird für den ersten Wiederholungsversuch verwendet. Nachfolgende Wiederholungsversuche werden nach initial_backoff + increment_power^retry_count Sekunden wiederholt.
LinearRetry

Linearer Wiederholungsversuch.

Erstellt ein Linear-Wiederholungsobjekt.
LocationMode

Gibt den Speicherort an, an den die Anforderung gesendet werden soll. Dieser Modus gilt nur für RA-GRS-Konten, die sekundären Lesezugriff ermöglichen. Alle anderen Kontotypen müssen PRIMARY verwenden.
Metrics

Eine Zusammenfassung der Nach API gruppierten Anforderungsstatistiken in Stunden- oder Minutenaggregaten.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.
QueueAnalyticsLogging

Azure Analytics-Protokollierungseinstellungen.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.
QueueClient

Ein Client, der mit einer bestimmten Warteschlange interagiert.

Weitere optionale Konfigurationen finden Sie hier.
QueueMessage

Stellt eine Warteschlangennachricht dar.
QueueProperties

Warteschlangeneigenschaften.
QueueSasPermissions

QueueSasPermissions-Klasse, die mit der generate_queue_sas Funktion und für die accessPolicies verwendet werden soll, die mit set_queue_access_policyverwendet wird.
QueueServiceClient

Ein Client, der mit dem Warteschlangendienst auf Kontoebene interagiert.

Dieser Client bietet Vorgänge zum Abrufen und Konfigurieren der Kontoeigenschaften sowie zum Auflisten, Erstellen und Löschen von Warteschlangen innerhalb des Kontos. Für Vorgänge im Zusammenhang mit einer bestimmten Warteschlange kann ein Client für diese Entität mithilfe der get_queue_client -Funktion abgerufen werden.

Weitere optionale Konfigurationen finden Sie hier.
ResourceTypes

Gibt die Ressourcentypen an, auf die mit der Konto-SAS zugegriffen werden kann.
RetentionPolicy

Die Aufbewahrungsrichtlinie, die bestimmt, wie lange die zugeordneten Daten beibehalten werden sollen.

Alle erforderlichen Parameter müssen aufgefüllt werden, um an Azure senden zu können.
TextBase64DecodePolicy

Nachrichtendecodierungsrichtlinie für 64-codierte Basisnachrichten in Text.

Decodiert base64-codierte Nachrichten in Text (Unicode). Wenn der Eingabeinhalt nicht auf Basis 64 gültig ist, wird ein DecodeError ausgelöst. Nachrichtendaten müssen UTF-8 unterstützen.
TextBase64EncodePolicy

Basis-64-Nachrichtencodierungsrichtlinie für Textnachrichten.

Codiert Textnachrichten (Unicode) in Basis 64. Wenn der Eingabeinhalt kein Text ist, wird ein TypeError ausgelöst. Eingabetext muss UTF-8 unterstützen.

Enumerationen

StorageErrorCode

Functions

generate_account_sas

Generiert eine Shared Access Signature für den Warteschlangendienst.

Verwenden Sie die zurückgegebene Signatur mit dem Anmeldeinformationsparameter eines beliebigen Warteschlangendiensts.

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

Parameter

account_name
str
Erforderlich

Der Speicherkontoname, der zum Generieren der Shared Access Signature verwendet wird.

account_key
str
Erforderlich

Der Kontoschlüssel, der auch als gemeinsamer Schlüssel oder Zugriffsschlüssel bezeichnet wird, um die Shared Access Signature zu generieren.

resource_types
ResourceTypes
Erforderlich

Gibt die Ressourcentypen an, auf die mit der Konto-SAS zugegriffen werden kann.

permission
AccountSasPermissions oder str
Erforderlich

Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt.

expiry
datetime oder str
Erforderlich

Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

start
datetime oder str
Standardwert: None

Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

ip
str
Standardwert: None

Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise sip=168.1.5.65 oder sip=168.1.5.60-168.1.5.70 auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt.

protocol
str

Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Der Standardwert ist https.

Gibt zurück

Ein Sas-Token (Shared Access Signature).

Rückgabetyp

str

generate_queue_sas

Generiert eine Shared Access Signature für eine Warteschlange.

Verwenden Sie die zurückgegebene Signatur mit dem Anmeldeinformationsparameter eines beliebigen Warteschlangendiensts.

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

Parameter

account_name
str
Erforderlich

Der Speicherkontoname, der zum Generieren der Shared Access Signature verwendet wird.

queue_name
str
Erforderlich

Der Name der Warteschlange.

account_key
str
Erforderlich

Der Kontoschlüssel, der auch als gemeinsamer Schlüssel oder Zugriffsschlüssel bezeichnet wird, um die Shared Access Signature zu generieren.

permission
QueueSasPermissions oder str
Standardwert: None

Die Berechtigungen, die der SAS zugeordnet sind. Der Benutzer ist auf Vorgänge beschränkt, für die er eine Berechtigung besitzt. Erforderlich, es sei denn, es wird ein policy_id angegeben, der auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde.

expiry
datetime oder str
Standardwert: None

Der Zeitpunkt, zu dem die Shared Access Signature ungültig wird. Erforderlich, es sei denn, es wird ein policy_id angegeben, der auf eine gespeicherte Zugriffsrichtlinie verweist, die dieses Feld enthält. Dieses Feld muss ausgelassen werden, wenn es in einer zugehörigen gespeicherten Zugriffsrichtlinie angegeben wurde. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

start
datetime oder str
Standardwert: None

Der Zeitpunkt, zu dem die Shared Access Signature gültig wird. Wenn Sie diesen Wert weglassen, wird als Startzeit dieses Aufrufs die Uhrzeit verwendet, zu der die Anforderung vom Speicherdienst empfangen wird. Azure konvertiert Werte immer in UTC. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist.

policy_id
str
Standardwert: None

Ein eindeutiger Wert mit einer Länge von bis zu 64 Zeichen, der mit einer gespeicherten Zugriffsrichtlinie korreliert. Verwenden Sie set_queue_access_policyzum Erstellen einer gespeicherten Zugriffsrichtlinie .

ip
str
Standardwert: None

Gibt eine IP-Adresse oder einen IP-Adressbereich an, von dem Anforderungen akzeptiert werden sollen. Wenn die IP-Adresse, von der die Anforderung stammt, nicht mit der IM SAS-Token angegebenen IP-Adresse oder dem Adressbereich übereinstimmt, wird die Anforderung nicht authentifiziert. Wenn Sie beispielsweise sip='168.1.5.65' oder sip='168.1.5.60-168.1.5.70' auf der SAS angeben, wird die Anforderung auf diese IP-Adressen beschränkt.

protocol
str

Gibt das zulässige Protokoll für eine durchgeführte Anforderung an. Der Standardwert ist https.

Gibt zurück

Ein Sas-Token (Shared Access Signature).

Rückgabetyp

str

Beispiele

Generieren Sie ein SAS-Token.


   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'
   )