QueueServiceClient Classe

Questo metodo consiste nel chiudere i socket aperti dal client. Non è necessario usare quando si usa con un gestore di contesto.

close()

Crea una nuova coda nell'account specificato.

Se esiste già una coda con lo stesso nome, l'operazione ha esito negativo. Restituisce un client con cui interagire con la coda appena creata.

create_queue(name: str, metadata: Dict[str, str] | None = None, **kwargs: Any) -> QueueClient

Parametri

Restituisce

QueueClient per la coda appena creata.

Tipo restituito

Esempio

Creare una coda nel servizio.

   queue_service.create_queue("myqueue1")

Elimina la coda specificata e tutti i messaggi contenuti.

Quando una coda viene eliminata correttamente, viene contrassegnata immediatamente per l'eliminazione e non è più accessibile ai client. La coda verrà rimossa in seguito dal servizio di accodamento durante un'operazione di Garbage Collection.

Si noti che l'eliminazione di una coda richiede almeno 40 secondi per completare. Se un'operazione viene tentata rispetto alla coda durante l'eliminazione, verrà generata un'operazione <xref:azure.storage.queue.HttpResponseError> .

delete_queue(queue: QueueProperties | str, **kwargs: Any) -> None

Parametri

Tipo restituito

Esempio

Eliminare una coda nel servizio.

   queue_service.delete_queue("myqueue1")

Creare QueueServiceClient da una stringa di connessione.

from_connection_string(conn_str: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametri

Restituisce

Client del servizio code.

Tipo restituito

Esempio

Creazione di QueueServiceClient con un stringa di connessione.

   from azure.storage.queue import QueueServiceClient
   queue_service = QueueServiceClient.from_connection_string(conn_str=self.connection_string)

Ottenere un client per interagire con la coda specificata.

La coda non esiste già.

get_queue_client(queue: QueueProperties | str, **kwargs: Any) -> QueueClient

Parametri

Restituisce

Un oggetto QueueClient.

Tipo restituito

Esempio

Ottenere il client della coda.

   # Get the queue client to interact with a specific queue
   queue = queue_service.get_queue_client(queue="myqueue2")

Ottiene le proprietà del servizio Code di un account di archiviazione, tra cui Azure Analisi archiviazione.

get_service_properties(**kwargs: Any) -> Dict[str, Any]

Parametri

Restituisce

Oggetto contenente le proprietà del servizio code, ad esempio la registrazione dell'analisi, le metriche ora/minuto, le regole cors e così via.

Tipo restituito

Esempio

Recupero delle proprietà del servizio code.

   properties = queue_service.get_service_properties()

Recupera le statistiche correlate alla replica per il servizio di accodamento.

È disponibile solo quando la replica con ridondanza geografica di accesso in lettura è abilitata per l'account di archiviazione.

Con la replica geograficamente ridondante, Archiviazione di Azure mantiene i dati durevoli in due posizioni. In entrambe le posizioni Archiviazione di Azure gestisce costantemente più repliche integre dei dati. La posizione in cui si leggono, creano, aggiornano o eliminano i dati è la posizione dell'account di archiviazione primaria. La posizione primaria esiste nell'area scelta al momento della creazione di un account tramite il portale di Azure Management Azure classico, ad esempio Stati Uniti centro-settentrionali. La posizione in cui i dati vengono replicati è la posizione secondaria. La posizione secondaria viene determinata automaticamente in base alla posizione primaria. Si tratta di un secondo data center che risiede nella stessa area geografica della posizione primaria. Dalla posizione secondaria è disponibile l'accesso in sola lettura se la replica geograficamente ridondante con accesso in lettura è abilitata per l'account di archiviazione.

get_service_stats(**kwargs: Any) -> Dict[str, Any]

Parametri

Restituisce

Statistiche del servizio di accodamento.

Tipo restituito

Restituisce un generatore per elencare le code nell'account specificato.

Il generatore seguirà i token di continuazione restituiti dal servizio e arresterà quando tutte le code sono state restituite.

list_queues(name_starts_with: str | None = None, include_metadata: bool | None = False, **kwargs: Any) -> ItemPaged[QueueProperties]

Parametri

Restituisce

Iterabile (paging automatico) di QueueProperties.

Tipo restituito

Esempio

Elencare le code nel servizio.

   # List all the queues in the service
   list_queues = queue_service.list_queues()
   for queue in list_queues:
       print(queue)

   # List the queues in the service that start with the name "my"
   list_my_queues = queue_service.list_queues(name_starts_with="my")
   for queue in list_my_queues:
       print(queue)

Imposta le proprietà del servizio Code di un account di archiviazione, tra cui Azure Analisi archiviazione.

Se un elemento (ad esempio, analytics_logging) viene lasciato come Nessuno, le impostazioni esistenti nel servizio per tale funzionalità vengono mantenute.

set_service_properties(analytics_logging: QueueAnalyticsLogging | None = None, hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, **kwargs: Any) -> None

Parametri

Esempio

Impostazione delle proprietà del servizio code.

   # Create service properties
   from azure.storage.queue import QueueAnalyticsLogging, Metrics, CorsRule, RetentionPolicy

   # Create logging settings
   logging = QueueAnalyticsLogging(read=True, write=True, delete=True, retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create metrics for requests statistics
   hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
   minute_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create CORS rules
   cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
   allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
   allowed_methods = ['GET', 'PUT']
   max_age_in_seconds = 500
   exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
   allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
   cors_rule2 = CorsRule(
       allowed_origins,
       allowed_methods,
       max_age_in_seconds=max_age_in_seconds,
       exposed_headers=exposed_headers,
       allowed_headers=allowed_headers
   )

   cors = [cors_rule1, cors_rule2]

   # Set the service properties
   queue_service.set_service_properties(logging, hour_metrics, minute_metrics, cors)

Versione dell'API di archiviazione usata per le richieste.

Tipo restituito

Modalità percorso attualmente usata dal client.

Per impostazione predefinita, questo sarà "primario". Le opzioni includono "primary" e "secondary".

Tipo restituito

URL dell'endpoint primario completo.

Tipo restituito

Nome host dell'endpoint primario.

Tipo restituito

URL dell'endpoint secondario completo se configurato.

Se non è disponibile, verrà generato un valore ValueError. Per specificare in modo esplicito un nome host secondario, usare l'argomento della parola chiave facoltativo secondary_hostname nell'istanza.

Tipo restituito

Eccezioni

Nome host dell'endpoint secondario.

Se non è disponibile, questo sarà Nessuno. Per specificare in modo esplicito un nome host secondario, usare l'argomento della parola chiave facoltativo secondary_hostname nell'istanza.

Tipo restituito

URL completo dell'endpoint per questa entità, incluso il token di firma di accesso condiviso se usato.

Questo potrebbe essere l'endpoint primario o l'endpoint secondario a seconda dell'oggetto corrente location_mode. :restituisce: URL completo dell'endpoint per questa entità, incluso il token di firma di accesso condiviso se usato. :rtype: str