Dela via

queue Paket

  • Referens

Paket

aio

Klasser

AccessPolicy

Access Policy-klass som används av uppsättningen och få åtkomstprincipmetoder.

En lagrad åtkomstprincip kan ange starttid, förfallotid och behörigheter för signaturer för delad åtkomst som den är associerad med. Beroende på hur du vill styra åtkomsten till resursen kan du ange alla dessa parametrar i den lagrade åtkomstprincipen och utelämna dem från URL:en för signaturen för delad åtkomst. På så sätt kan du när som helst ändra den associerade signaturens beteende och återkalla den. Eller så kan du ange en eller flera av åtkomstprincipparametrarna i den lagrade åtkomstprincipen och de andra på URL:en. Slutligen kan du ange alla parametrar på URL:en. I det här fallet kan du använda den lagrade åtkomstprincipen för att återkalla signaturen, men inte för att ändra dess beteende.

Tillsammans måste signaturen för delad åtkomst och den lagrade åtkomstprincipen innehålla alla fält som krävs för att autentisera signaturen. Om obligatoriska fält saknas misslyckas begäran. På samma sätt misslyckas begäran med statuskoden 400 (felaktig begäran) om ett fält anges både i url:en för signatur för delad åtkomst och i principen för lagrad åtkomst.
AccountSasPermissions

ResourceTypes klass som ska användas med funktionen generate_account_sas och för AccessPolicies som används med set_*_acl. Det finns två typer av SAS som kan användas för att bevilja resursåtkomst. Ett är att bevilja åtkomst till en specifik resurs (resursspecifik). En annan är att bevilja åtkomst till hela tjänsten för ett visst konto och tillåta vissa åtgärder baserat på de perms som finns här.
BinaryBase64DecodePolicy

Meddelandeavkodningsprincip för grundläggande 64-kodade meddelanden i byte.

Avkodar base64-kodade meddelanden till byte. Om indatainnehållet inte är giltigt bas 64 aktiveras en DecodeError.
BinaryBase64EncodePolicy

Grundläggande 64-meddelandekodningsprincip för binära meddelanden.

Kodar binära meddelanden till bas 64. Om indatainnehållet inte är byte utlöses en TypeError.
CorsRule

CORS är en HTTP-funktion som gör det möjligt för ett webbprogram som körs i en domän att komma åt resurser i en annan domän. Webbläsare implementerar en säkerhetsbegränsning som har samma ursprungsprincip som förhindrar att en webbsida anropar API:er i en annan domän. CORS är ett säkert sätt att tillåta en domän (ursprungsdomänen) att anropa API:er i en annan domän.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.
ExponentialRetry

Exponentiellt återförsök.

Skapar ett exponentiellt återförsöksobjekt. Initial_backoff används för det första återförsöket. Efterföljande återförsök görs på nytt efter initial_backoff + increment_power^retry_count sekunder.
LinearRetry

Linjärt återförsök.

Skapar ett linjärt återförsöksobjekt.
LocationMode

Anger den plats som begäran ska skickas till. Det här läget gäller endast för RA-GRS-konton som tillåter sekundär läsåtkomst. Alla andra kontotyper måste använda PRIMARY.
Metrics

En sammanfattning av begärandestatistik grupperad efter API i tim- eller minutaggregeringar.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.
QueueAnalyticsLogging

Loggningsinställningar för Azure Analytics.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.
QueueClient

En klient för att interagera med en specifik kö.

Klicka här om du vill ha mer valfri konfiguration.
QueueMessage

Representerar ett kömeddelande.
QueueProperties

Köegenskaper.
QueueSasPermissions

QueueSasPermissions-klassen som ska användas med generate_queue_sas funktionen och för AccessPolicies som används med set_queue_access_policy.
QueueServiceClient

En klient som ska interagera med kötjänsten på kontonivå.

Den här klienten tillhandahåller åtgärder för att hämta och konfigurera kontoegenskaper samt lista, skapa och ta bort köer i kontot. För åtgärder som rör en specifik kö kan en klient för den här entiteten hämtas med hjälp av get_queue_client funktionen .

Klicka här om du vill ha mer valfri konfiguration.
ResourceTypes

Anger de resurstyper som är tillgängliga med kontots SAS.
RetentionPolicy

Kvarhållningsprincipen som avgör hur länge de associerade data ska sparas.

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.
TextBase64DecodePolicy

Meddelandeavkodningsprincip för grundläggande 64-kodade meddelanden i text.

Avkodar base64-kodade meddelanden till text (unicode). Om indatainnehållet inte är giltigt bas 64 aktiveras en DecodeError. Meddelandedata måste ha stöd för UTF-8.
TextBase64EncodePolicy

Grundläggande 64-meddelandekodningsprincip för textmeddelanden.

Kodar textmeddelanden (unicode) till bas 64. Om indatainnehållet inte är text utlöses en TypeError. Indatatext måste ha stöd för UTF-8.

Uppräkningar

StorageErrorCode

Funktioner

generate_account_sas

Genererar en signatur för delad åtkomst för kötjänsten.

Använd den returnerade signaturen med parametern autentiseringsuppgifter för valfri kötjänst.

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

Parametrar

account_name
str
Obligatorisk

Lagringskontonamnet som används för att generera signaturen för delad åtkomst.

account_key
str
Obligatorisk

Kontonyckeln, även kallad delad nyckel eller åtkomstnyckel, för att generera signaturen för delad åtkomst.

resource_types
ResourceTypes
Obligatorisk

Anger de resurstyper som är tillgängliga med kontots SAS.

permission
AccountSasPermissions eller str
Obligatorisk

De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna.

expiry
datetime eller str
Obligatorisk

Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Azure konverterar alltid värden till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC.

start
datetime eller str
standardvärde: None

Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC.

ip
str
standardvärde: None

Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om DEN IP-adress som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges på SAS-token autentiseras inte begäran. Om du till exempel anger sip=168.1.5.65 eller sip=168.1.5.60-168.1.5.70 på SAS begränsas begäran till dessa IP-adresser.

protocol
str

Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https.

Returer

En sas-token (signatur för delad åtkomst).

Returtyp

str

generate_queue_sas

Genererar en signatur för delad åtkomst för en kö.

Använd den returnerade signaturen med autentiseringsparametern för valfri kötjänst.

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

Parametrar

account_name
str
Obligatorisk

Lagringskontonamnet som används för att generera signaturen för delad åtkomst.

queue_name
str
Obligatorisk

Namnet på kön.

account_key
str
Obligatorisk

Kontonyckeln, även kallad delad nyckel eller åtkomstnyckel, för att generera signaturen för delad åtkomst.

permission
QueueSasPermissions eller str
standardvärde: None

De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna. Krävs om inte en policy_id anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip.

expiry
datetime eller str
standardvärde: None

Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Krävs om inte en policy_id anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip. Azure konverterar alltid värden till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC.

start
datetime eller str
standardvärde: None

Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC.

policy_id
str
standardvärde: None

Ett unikt värde på upp till 64 tecken som korrelerar med en lagrad åtkomstprincip. Om du vill skapa en lagrad åtkomstprincip använder du set_queue_access_policy.

ip
str
standardvärde: None

Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om DEN IP-adress som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges på SAS-token autentiseras inte begäran. Om du till exempel anger sip='168.1.5.65' eller sip='168.1.5.60-168.1.5.70' på SAS begränsas begäran till dessa IP-adresser.

protocol
str

Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https.

Returer

En sas-token (signatur för delad åtkomst).

Returtyp

str

Exempel

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