queue Pacchetto

Pacchetti

aio

Classi

AccessPolicy	Classe Criteri di accesso usata dal set e ottenere i metodi dei criteri di accesso. I criteri di accesso archiviati possono specificare l'ora di inizio, l'ora di scadenza e le autorizzazioni per le firme di accesso condiviso a cui sono associati. A seconda del modo in cui si vuole controllare l'accesso alla risorsa, è possibile specificare tutti questi parametri all'interno dei criteri di accesso archiviati e ometterli dall'URL per la firma di accesso condiviso. In questo modo, è possibile modificare il comportamento della firma associata in qualsiasi momento, nonché revocarla. In alternativa, è possibile specificare uno o più parametri dei criteri di accesso nei criteri di accesso archiviati e gli altri nell'URL. Infine, è possibile specificare tutti i parametri nell'URL. In questo caso, è possibile usare i criteri di accesso archiviati per revocare la firma, ma non per modificarne il comportamento. Insieme, la firma di accesso condiviso e i criteri di accesso archiviati devono includere tutti i campi necessari per autenticare la firma. Se uno o più campi obbligatori sono mancanti, la richiesta avrà esito negativo. Analogamente, se un campo è specificato sia nell'URL della firma di accesso condiviso sia nei criteri di accesso archiviati, la richiesta avrà esito negativo e verrà restituito il codice di stato 400 (Richiesta non valida).
AccountSasPermissions	ResourceTypes classe da usare con la funzione generate_account_sas e per gli AccessPolicies usati con set_*_acl. Esistono due tipi di firma di accesso condiviso che possono essere usati per concedere l'accesso alle risorse. Uno consiste nel concedere l'accesso a una risorsa specifica (specifica della risorsa). Un altro consiste nel concedere l'accesso all'intero servizio per un account specifico e consentire determinate operazioni basate su perms disponibili qui.
BinaryBase64DecodePolicy	Criterio di decodifica dei messaggi per i messaggi con codifica base 64 in byte. Decodifica i messaggi con codifica base64 in byte. Se il contenuto di input non è valido base 64, verrà generato un DecodeError.
BinaryBase64EncodePolicy	Criterio di codifica dei messaggi di base 64 per i messaggi binari. Codifica i messaggi binari in base 64. Se il contenuto di input non è byte, verrà generato un typeError.
CorsRule	CORS è una funzionalità HTTP che consente a un'applicazione Web in esecuzione in un dominio di accedere alle risorse in un altro dominio. Nei browser web è implementata una restrizione di sicurezza detta regola della stessa origine che impedisce a una pagina web di chiamare API in un dominio diverso. La condivisione CORS offre una modalità sicura per consentire a un dominio (quello di origine) di chiamare API in un altro dominio. Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.
ExponentialRetry	Ripetizione esponenziale dei tentativi. Costruisce un oggetto ripetizione dei tentativi esponenziale. Il initial_backoff viene usato per il primo tentativo. I tentativi successivi vengono riprovati dopo initial_backoff + increment_power^retry_count secondi.
LinearRetry	Ripetizione lineare. Costruisce un oggetto di ripetizione dei tentativi lineare.
LocationMode	Specifica il percorso a cui deve essere inviata la richiesta. Questa modalità si applica solo agli account RA-GRS che consentono l'accesso in lettura secondario. Tutti gli altri tipi di account devono usare PRIMARY.
Metrics	Riepilogo delle statistiche richieste raggruppate dall'API in aggregazioni orarie o minuti. Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.
QueueAnalyticsLogging	Impostazioni di registrazione di Analisi di Azure. Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.
QueueClient	Un client da interagire con una coda specifica. Per altre configurazioni facoltative, fare clic qui.
QueueMessage	Rappresenta un messaggio di coda.
QueueProperties	Proprietà della coda.
QueueSasPermissions	Classe QueueSasPermissions da usare con la generate_queue_sas funzione e per gli AccessPolicies usati con set_queue_access_policy.
QueueServiceClient	Un client per interagire con il servizio code a livello di account. Questo client fornisce operazioni per recuperare e configurare le proprietà dell'account e l'elenco, creare ed eliminare code all'interno dell'account. Per le operazioni relative a una coda specifica, è possibile recuperare un client per questa entità usando la get_queue_client funzione. Per altre configurazioni facoltative, fare clic qui.
ResourceTypes	Specifica i tipi di risorse accessibili con la firma di accesso condiviso dell'account.
RetentionPolicy	I criteri di conservazione che determinano il tempo di conservazione dei dati associati devono essere persistenti. Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.
TextBase64DecodePolicy	Criterio di decodifica dei messaggi per i messaggi con codifica base 64 nel testo. Decodifica i messaggi con codifica base64 al testo (unicode). Se il contenuto di input non è valido base 64, verrà generato un DecodeError. I dati dei messaggi devono supportare UTF-8.
TextBase64EncodePolicy	Criteri di codifica dei messaggi di base 64 per i messaggi di testo. Codifica i messaggi di testo (unicode) alla base 64. Se il contenuto di input non è testo, verrà generato un TypeError. Il testo di input deve supportare UTF-8.

Enumerazioni

StorageErrorCode

Funzioni

generate_account_sas

Genera una firma di accesso condiviso per il servizio code.

Usare la firma restituita con il parametro credenziale di qualsiasi servizio code.

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

Parametri

account_name

str

Necessario

Nome dell'account di archiviazione usato per generare la firma di accesso condiviso.

account_key

str

Necessario

La chiave dell'account, chiamata anche chiave di accesso o chiave di accesso condivisa, per generare la firma di accesso condiviso.

resource_types

ResourceTypes

Necessario

Specifica i tipi di risorse accessibili con la firma di accesso condiviso dell'account.

permission

AccountSasPermissions oppure str

Necessario

Le autorizzazioni associate alla firma di accesso condiviso. L'utente può eseguire solo le operazioni consentite dalle autorizzazioni.

expiry

datetime oppure str

Necessario

Ora in cui la firma di accesso condiviso non è valida. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.

start

datetime oppure str

valore predefinito: None

Ora in cui la firma di accesso condiviso diventa valida. Se omesso, come ora di inizio di questa chiamata verrà considerata l'ora in cui il servizio di archiviazione riceve la richiesta. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.

ip

str

valore predefinito: None

Specifica un indirizzo IP o un intervallo di indirizzi IP da cui accettare le richieste. Se l'indirizzo IP da cui proviene la richiesta non corrisponde all'indirizzo IP o all'intervallo di indirizzi specificato nel token di firma di accesso condiviso, la richiesta non viene autenticata. Ad esempio, specificando sip=168.1.5.65 o sip=168.1.5.60-168.1.5.70 sulla firma di accesso condiviso limita la richiesta a tali indirizzi IP.

protocol

str

Specifica il protocollo consentito per una richiesta effettuata. Il valore predefinito è https.

Restituisce

Token firma di accesso condiviso (sas).

Tipo restituito

str

generate_queue_sas

Genera una firma di accesso condiviso per una coda.

Usare la firma restituita con il parametro delle credenziali di qualsiasi servizio di accodamento.

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

Parametri

account_name

str

Necessario

Nome dell'account di archiviazione usato per generare la firma di accesso condiviso.

queue_name

str

Necessario

Nome della coda.

account_key

str

Necessario

La chiave dell'account, chiamata anche chiave di accesso o chiave di accesso condivisa, per generare la firma di accesso condiviso.

permission

QueueSasPermissions oppure str

valore predefinito: None

Le autorizzazioni associate alla firma di accesso condiviso. L'utente può eseguire solo le operazioni consentite dalle autorizzazioni. Obbligatorio a meno che non venga specificato un policy_id che fa riferimento a un criterio di accesso archiviato che contiene questo campo. Questo campo deve essere omesso se è stato specificato nei criteri di accesso archiviati associati.

expiry

datetime oppure str

valore predefinito: None

Ora in cui la firma di accesso condiviso non è valida. Obbligatorio a meno che non venga specificato un policy_id che fa riferimento a un criterio di accesso archiviato che contiene questo campo. Questo campo deve essere omesso se è stato specificato nei criteri di accesso archiviati associati. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.

start

datetime oppure str

valore predefinito: None

Ora in cui la firma di accesso condiviso diventa valida. Se omesso, come ora di inizio di questa chiamata verrà considerata l'ora in cui il servizio di archiviazione riceve la richiesta. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.

policy_id

str

valore predefinito: None

Valore univoco fino a 64 caratteri di lunghezza che correla a un criterio di accesso archiviato. Per creare criteri di accesso archiviati, usare set_queue_access_policy.

ip

str

valore predefinito: None

Specifica un indirizzo IP o un intervallo di indirizzi IP da cui accettare le richieste. Se l'indirizzo IP da cui proviene la richiesta non corrisponde all'indirizzo IP o all'intervallo di indirizzi specificato nel token di firma di accesso condiviso, la richiesta non viene autenticata. Ad esempio, specificando sip='168.1.5.65' o sip='168.1.5.60-168.1.5.70' nella firma di accesso condiviso limita la richiesta a tali indirizzi IP.

protocol

str

Specifica il protocollo consentito per una richiesta effettuata. Il valore predefinito è https.

Restituisce

Token di firma di accesso condiviso (sas).

Tipo restituito

str

Esempio

Generare un token di firma di accesso condiviso.

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