queue Pakket

  • Referentie

Pakketten

aio

Klassen

AccessPolicy

De klasse Toegangsbeleid die wordt gebruikt door de methoden voor het instellen en ophalen van toegangsbeleid.

Een opgeslagen toegangsbeleid kan de begintijd, verlooptijd en machtigingen opgeven voor de Shared Access Signatures waaraan het is gekoppeld. Afhankelijk van hoe u de toegang tot uw resource wilt beheren, kunt u al deze parameters opgeven in het opgeslagen toegangsbeleid en deze weglaten uit de URL voor de Shared Access Signature. Als u dit doet, kunt u het gedrag van de gekoppelde handtekening op elk gewenst moment wijzigen en intrekken. U kunt ook een of meer van de parameters voor het toegangsbeleid opgeven in het opgeslagen toegangsbeleid en de andere parameters op de URL. Ten slotte kunt u alle parameters op de URL opgeven. In dit geval kunt u het opgeslagen toegangsbeleid gebruiken om de handtekening in te trekken, maar niet om het gedrag ervan te wijzigen.

De Shared Access Signature en het opgeslagen toegangsbeleid moeten samen alle velden bevatten die nodig zijn om de handtekening te verifiëren. Als er vereiste velden ontbreken, mislukt de aanvraag. Als een veld zowel in de Shared Access Signature-URL als in het opgeslagen toegangsbeleid is opgegeven, mislukt de aanvraag met statuscode 400 (Ongeldige aanvraag).
AccountSasPermissions

ResourceTypes klasse die moet worden gebruikt met generate_account_sas functie en voor de AccessPolicies die worden gebruikt met set_*_acl. Er zijn twee typen SAS die kunnen worden gebruikt om toegang tot resources te verlenen. Een daarvan is het verlenen van toegang tot een specifieke resource (resource-specifiek). Een andere optie is om toegang te verlenen tot de hele service voor een specifiek account en bepaalde bewerkingen toe te staan op basis van de hier te vinden machines.
BinaryBase64DecodePolicy

Beleid voor berichtdecodering voor met base 64 gecodeerde berichten in bytes.

Met base64 gecodeerde berichten decoderen naar bytes. Als de invoerinhoud niet geldig is op basis 64, wordt een DecodeError gegenereerd.
BinaryBase64EncodePolicy

Base 64-berichtcoderingsbeleid voor binaire berichten.

Codeert binaire berichten naar base 64. Als de invoerinhoud geen bytes is, wordt er een TypeError gegenereerd.
CorsRule

CORS is een HTTP-functie waarmee een webtoepassing die wordt uitgevoerd onder één domein, toegang kan krijgen tot resources in een ander domein. Webbrowsers implementeren een beveiligingsbeperking die bekend staat als same orgine-beleid waarmee wordt voorkomen dat een webpagina API's in een ander domein aanroept. CORS biedt een veilige manier om het ene domein (het oorspronkelijke domein) toe te staan om API's in een ander domein aan te roepen.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.
ExponentialRetry

Exponentieel opnieuw proberen.

Maakt een exponentieel object voor opnieuw proberen. De initial_backoff wordt gebruikt voor de eerste nieuwe poging. Volgende nieuwe pogingen worden opnieuw geprobeerd na initial_backoff + increment_power^retry_count seconden.
LinearRetry

Lineaire nieuwe poging.

Maakt een lineaire pogingsobject.
LocationMode

Hiermee geeft u de locatie waarnaar de aanvraag moet worden verzonden. Deze modus is alleen van toepassing op RA-GRS-accounts die secundaire leestoegang toestaan. Alle andere accounttypen moeten PRIMARY gebruiken.
Metrics

Een samenvatting van aanvraagstatistieken gegroepeerd per API in uur- of minuutaggregaties.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.
QueueAnalyticsLogging

Instellingen voor logboekregistratie van Azure Analytics.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.
QueueClient

Een client voor interactie met een specifieke wachtrij.

Klik hier voor meer optionele configuratie.
QueueMessage

Vertegenwoordigt een wachtrijbericht.
QueueProperties

Wachtrijeigenschappen.
QueueSasPermissions

De klasse QueueSasPermissions die moet worden gebruikt met de generate_queue_sas functie en voor de AccessPolicies die worden gebruikt met set_queue_access_policy.
QueueServiceClient

Een client voor interactie met de Queue Service op accountniveau.

Deze client biedt bewerkingen voor het ophalen en configureren van de accounteigenschappen, evenals het weergeven, maken en verwijderen van wachtrijen binnen het account. Voor bewerkingen met betrekking tot een specifieke wachtrij kan een client voor deze entiteit worden opgehaald met behulp van de get_queue_client functie.

Klik hier voor meer optionele configuratie.
ResourceTypes

Hiermee geeft u de resourcetypen op die toegankelijk zijn met de account-SAS.
RetentionPolicy

Het bewaarbeleid dat bepaalt hoe lang de gekoppelde gegevens moeten blijven bestaan.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.
TextBase64DecodePolicy

Beleid voor berichtdecodering voor met base 64 gecodeerde berichten in tekst.

Met base64 gecodeerde berichten decoderen naar tekst (Unicode). Als de invoerinhoud niet geldig is op basis 64, wordt een DecodeError gegenereerd. Berichtgegevens moeten UTF-8 ondersteunen.
TextBase64EncodePolicy

Base 64-berichtcoderingsbeleid voor sms-berichten.

Hiermee worden tekstberichten (Unicode) gecodeerd op basis 64. Als de invoerinhoud geen tekst is, wordt er een TypeError gegenereerd. Invoertekst moet UTF-8 ondersteunen.

Enums

StorageErrorCode

Functies

generate_account_sas

Hiermee genereert u een shared access signature voor de wachtrijservice.

Gebruik de geretourneerde handtekening met de referentieparameter van een Wachtrijservice.

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

Parameters

account_name
str
Vereist

De naam van het opslagaccount dat wordt gebruikt voor het genereren van de Shared Access Signature.

account_key
str
Vereist

De accountsleutel, ook wel gedeelde sleutel of toegangssleutel genoemd, om de shared access signature te genereren.

resource_types
ResourceTypes
Vereist

Hiermee geeft u de resourcetypen op die toegankelijk zijn met de account-SAS.

permission
AccountSasPermissions of str
Vereist

De machtigingen die zijn gekoppeld aan de Shared Access Signature. De gebruiker is beperkt tot bewerkingen die zijn toegestaan door de machtigingen.

expiry
datetime of str
Vereist

Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is.

start
datetime of str
standaardwaarde: None

Het tijdstip waarop de Shared Access Signature geldig wordt. Als u dit weglaat, wordt ervan uitgegaan dat de begintijd voor deze aanroep het tijdstip is waarop de opslagservice de aanvraag ontvangt. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is.

ip
str
standaardwaarde: None

Hiermee geeft u een IP-adres of een bereik van IP-adressen van waaruit aanvragen te accepteren. Als het IP-adres waaruit de aanvraag afkomstig is, niet overeenkomt met het IP-adres of adresbereik dat is opgegeven in het SAS-token, wordt de aanvraag niet geverifieerd. Als u bijvoorbeeld sip=168.1.5.65 of sip=168.1.5.60-168.1.5.70 opgeeft op de SAS, wordt de aanvraag beperkt tot deze IP-adressen.

protocol
str

Hiermee geeft u het protocol op dat is toegestaan voor een aanvraag die is gedaan. De standaardwaarde is https.

Retouren

Een Sas-token (Shared Access Signature).

Retourtype

str

generate_queue_sas

Hiermee wordt een shared access signature gegenereerd voor een wachtrij.

Gebruik de geretourneerde handtekening met de referentieparameter van een 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

Parameters

account_name
str
Vereist

De naam van het opslagaccount dat wordt gebruikt voor het genereren van de Shared Access Signature.

queue_name
str
Vereist

De naam van de wachtrij.

account_key
str
Vereist

De accountsleutel, ook wel gedeelde sleutel of toegangssleutel genoemd, om de shared access signature te genereren.

permission
QueueSasPermissions of str
standaardwaarde: None

De machtigingen die zijn gekoppeld aan de Shared Access Signature. De gebruiker is beperkt tot bewerkingen die zijn toegestaan door de machtigingen. Vereist, tenzij er een policy_id wordt gegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid.

expiry
datetime of str
standaardwaarde: None

Het tijdstip waarop de handtekening voor gedeelde toegang ongeldig wordt. Vereist, tenzij er een policy_id wordt gegeven die verwijst naar een opgeslagen toegangsbeleid dat dit veld bevat. Dit veld moet worden weggelaten als het is opgegeven in een gekoppeld opgeslagen toegangsbeleid. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is.

start
datetime of str
standaardwaarde: None

Het tijdstip waarop de Shared Access Signature geldig wordt. Als u dit weglaat, wordt ervan uitgegaan dat de begintijd voor deze aanroep het tijdstip is waarop de opslagservice de aanvraag ontvangt. Azure converteert altijd waarden naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is.

policy_id
str
standaardwaarde: None

Een unieke waarde van maximaal 64 tekens die overeenkomt met een opgeslagen toegangsbeleid. Gebruik om een opgeslagen toegangsbeleid te maken set_queue_access_policy.

ip
str
standaardwaarde: None

Hiermee geeft u een IP-adres of een bereik van IP-adressen van waaruit aanvragen te accepteren. Als het IP-adres waaruit de aanvraag afkomstig is, niet overeenkomt met het IP-adres of adresbereik dat is opgegeven in het SAS-token, wordt de aanvraag niet geverifieerd. Als u bijvoorbeeld sip='168.1.5.65' of sip='168.1.5.60-168.1.5.70' op de SAS opgeeft, wordt de aanvraag beperkt tot deze IP-adressen.

protocol
str

Hiermee geeft u het protocol op dat is toegestaan voor een aanvraag die is gedaan. De standaardwaarde is https.

Retouren

Een Sas-token (Shared Access Signature).

Retourtype

str

Voorbeelden

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