QueueServiceClient Klas

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.

Overname

azure.storage.queue._shared.base_client.StorageAccountHostsMixin

QueueServiceClient

azure.storage.queue._encryption.StorageEncryptionMixin

QueueServiceClient

Constructor

QueueServiceClient(account_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parameters

account_url

str

Vereist

De URL naar het service-eindpunt van de wachtrij. Alle andere entiteiten die zijn opgenomen in het URL-pad (bijvoorbeeld wachtrij), worden verwijderd. Deze URL kan optioneel worden geverifieerd met een SAS-token.

credential

standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie

• behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

api_version

str

De storage-API-versie die moet worden gebruikt voor aanvragen. De standaardwaarde is de meest recente serviceversie die compatibel is met de huidige SDK. Instellen op een oudere versie kan leiden tot verminderde compatibiliteit van functies.

secondary_hostname

str

De hostnaam van het secundaire eindpunt.

audience

str

De doelgroep die moet worden gebruikt bij het aanvragen van tokens voor Azure Active Directory-verificatie. Heeft alleen een effect wanneer referentie van het type TokenCredential is. De waarde kan (standaard) of https://.queue.core.windows.net zijn https://storage.azure.com/ .

Voorbeelden

De QueueServiceClient maken met een account-URL en referentie.

   from azure.storage.queue import QueueServiceClient
   queue_service = QueueServiceClient(account_url=self.account_url, credential=self.access_key)

De QueueServiceClient maken met Azure Identity-referenties.

   # Get a token credential for authentication
   from azure.identity import ClientSecretCredential
   token_credential = ClientSecretCredential(
       self.active_directory_tenant_id,
       self.active_directory_application_id,
       self.active_directory_application_secret
   )

   # Instantiate a QueueServiceClient using a token credential
   from azure.storage.queue import QueueServiceClient
   queue_service = QueueServiceClient(account_url=self.account_url, credential=token_credential)

Methoden

close	Deze methode is om de sockets te sluiten die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met contextbeheer.
create_queue	Hiermee maakt u een nieuwe wachtrij onder het opgegeven account. Als er al een wachtrij met dezelfde naam bestaat, mislukt de bewerking. Retourneert een client waarmee moet worden gecommuniceerd met de zojuist gemaakte wachtrij.
delete_queue	Hiermee verwijdert u de opgegeven wachtrij en alle berichten die deze bevat. Wanneer een wachtrij is verwijderd, wordt deze onmiddellijk gemarkeerd voor verwijdering en is deze niet meer toegankelijk voor clients. De wachtrij wordt later tijdens de garbagecollection verwijderd uit de Queue-service. Houd er rekening mee dat het verwijderen van een wachtrij waarschijnlijk ten minste 40 seconden duurt. Als er een bewerking wordt uitgevoerd op de wachtrij terwijl deze werd verwijderd, wordt er een <xref:azure.storage.queue.HttpResponseError> gegenereerd.
from_connection_string	Maak QueueServiceClient op basis van een verbindingsreeks.
get_queue_client	Vraag een client om te communiceren met de opgegeven wachtrij. De wachtrij hoeft nog niet te bestaan.
get_service_properties	Hiermee haalt u de eigenschappen op van de Queue-service van een opslagaccount, waaronder Azure Opslaganalyse.
get_service_stats	Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Queue-service. Deze is alleen beschikbaar wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount. Met geografisch redundante replicatie houdt Azure Storage uw gegevens duurzaam op twee locaties. Op beide locaties onderhoudt Azure Storage voortdurend meerdere goede replica's van uw gegevens. De locatie waar u gegevens leest, maakt, bijwerkt of verwijdert, is de locatie van het primaire opslagaccount. De primaire locatie bestaat in de regio die u kiest op het moment dat u een account maakt via de klassieke Azure-portal van Azure Management, bijvoorbeeld VS - noord-centraal. De locatie waarnaar uw gegevens worden gerepliceerd, is de secundaire locatie. De secundaire locatie wordt automatisch bepaald op basis van de locatie van de primaire; het bevindt zich in een tweede datacenter dat zich in dezelfde regio bevindt als de primaire locatie. Alleen-lezentoegang is beschikbaar vanaf de secundaire locatie, als geografisch redundante replicatie met leestoegang is ingeschakeld voor uw opslagaccount.
list_queues	Retourneert een generator om de wachtrijen onder het opgegeven account weer te geven. De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle wachtrijen zijn geretourneerd.
set_service_properties	Hiermee stelt u de eigenschappen van de Queue-service van een opslagaccount in, waaronder Azure Opslaganalyse. Als een element (bijvoorbeeld analytics_logging) op Geen blijft staan, blijven de bestaande instellingen in de service voor die functionaliteit behouden.

close

Deze methode is om de sockets te sluiten die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met contextbeheer.

close()

create_queue

Hiermee maakt u een nieuwe wachtrij onder het opgegeven account.

Als er al een wachtrij met dezelfde naam bestaat, mislukt de bewerking. Retourneert een client waarmee moet worden gecommuniceerd met de zojuist gemaakte wachtrij.

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

Parameters

name

str

Vereist

De naam van de wachtrij die moet worden gemaakt.

metadata

Dict[str, str]

Vereist

Een dicteerfunctie met name_value paren om als metagegevens aan de wachtrij te koppelen. Voorbeeld: {'Category': 'test'}

timeout

int

De time-outparameter wordt uitgedrukt in seconden.

Retouren

Een QueueClient voor de zojuist gemaakte wachtrij.

Retourtype

QueueClient

Voorbeelden

Maak een wachtrij in de service.

   queue_service.create_queue("myqueue1")

delete_queue

Hiermee verwijdert u de opgegeven wachtrij en alle berichten die deze bevat.

Wanneer een wachtrij is verwijderd, wordt deze onmiddellijk gemarkeerd voor verwijdering en is deze niet meer toegankelijk voor clients. De wachtrij wordt later tijdens de garbagecollection verwijderd uit de Queue-service.

Houd er rekening mee dat het verwijderen van een wachtrij waarschijnlijk ten minste 40 seconden duurt. Als er een bewerking wordt uitgevoerd op de wachtrij terwijl deze werd verwijderd, wordt er een <xref:azure.storage.queue.HttpResponseError> gegenereerd.

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

Parameters

queue

str of QueueProperties

Vereist

De wachtrij die moet worden verwijderd. Dit kan de naam van de wachtrij zijn of een exemplaar van QueueProperties.

timeout

int

De time-outparameter wordt uitgedrukt in seconden.

Retourtype

None

Voorbeelden

Verwijder een wachtrij in de service.

   queue_service.delete_queue("myqueue1")

from_connection_string

Maak QueueServiceClient op basis van een verbindingsreeks.

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

Parameters

conn_str

str

Vereist

Een verbindingsreeks naar een Azure Storage-account.

credential

standaardwaarde: None

De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft of als de verbindingsreeks al waarden voor gedeelde toegangssleutels heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een account of een exemplaar van een TokenCredentials-klasse van azure.identity. Referenties die hier worden opgegeven, hebben voorrang op de referenties in de verbindingsreeks. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.

audience

str

De doelgroep die moet worden gebruikt bij het aanvragen van tokens voor Azure Active Directory-verificatie. Heeft alleen een effect wanneer referentie van het type TokenCredential is. De waarde kan (standaard) of https://.queue.core.windows.net zijn https://storage.azure.com/ .

Retouren

Een Queue-serviceclient.

Retourtype

QueueClient

Voorbeelden

De QueueServiceClient maken met een verbindingsreeks.

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

get_queue_client

Vraag een client om te communiceren met de opgegeven wachtrij.

De wachtrij hoeft nog niet te bestaan.

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

Parameters

queue

str of QueueProperties

Vereist

De wachtrij. Dit kan de naam van de wachtrij zijn of een exemplaar van QueueProperties.

Retouren

Een QueueClient object.

Retourtype

QueueClient

Voorbeelden

Haal de wachtrijclient op.

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

get_service_properties

Hiermee haalt u de eigenschappen op van de Queue-service van een opslagaccount, waaronder Azure Opslaganalyse.

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

Parameters

timeout

int

De time-outparameter wordt uitgedrukt in seconden.

Retouren

Een object met eigenschappen van de wachtrijservice, zoals logboekregistratie van analyses, metrische gegevens over uren/minuten, cors-regels, enzovoort.

Retourtype

Dict[str, Any]

Voorbeelden

Eigenschappen van wachtrijservice ophalen.

   properties = queue_service.get_service_properties()

get_service_stats

Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Queue-service.

Deze is alleen beschikbaar wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount.

Met geografisch redundante replicatie houdt Azure Storage uw gegevens duurzaam op twee locaties. Op beide locaties onderhoudt Azure Storage voortdurend meerdere goede replica's van uw gegevens. De locatie waar u gegevens leest, maakt, bijwerkt of verwijdert, is de locatie van het primaire opslagaccount. De primaire locatie bestaat in de regio die u kiest op het moment dat u een account maakt via de klassieke Azure-portal van Azure Management, bijvoorbeeld VS - noord-centraal. De locatie waarnaar uw gegevens worden gerepliceerd, is de secundaire locatie. De secundaire locatie wordt automatisch bepaald op basis van de locatie van de primaire; het bevindt zich in een tweede datacenter dat zich in dezelfde regio bevindt als de primaire locatie. Alleen-lezentoegang is beschikbaar vanaf de secundaire locatie, als geografisch redundante replicatie met leestoegang is ingeschakeld voor uw opslagaccount.

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

Parameters

timeout

int

De time-outparameter wordt uitgedrukt in seconden.

Retouren

De statistieken van de wachtrijservice.

Retourtype

Dict[str, Any]

list_queues

Retourneert een generator om de wachtrijen onder het opgegeven account weer te geven.

De generator volgt lui de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle wachtrijen zijn geretourneerd.

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

Parameters

name_starts_with

str

Vereist

Filtert de resultaten om alleen wachtrijen te retourneren waarvan de naam begint met het opgegeven voorvoegsel.

include_metadata

bool

Vereist

Hiermee geeft u op dat de metagegevens van de wachtrij worden geretourneerd in het antwoord.

results_per_page

int

Het maximum aantal wachtrijnamen dat per API-aanroep moet worden opgehaald. Als de aanvraag niet opgeeft, retourneert de server maximaal 5000 items.

timeout

int

Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren. Deze functie kan meerdere aanroepen naar de service doen. In dat geval wordt de opgegeven time-outwaarde toegepast op elke afzonderlijke aanroep.

Retouren

Een iterable (automatisch paging) van QueueProperties.

Retourtype

ItemPaged[QueueProperties]

Voorbeelden

Wachtrijen in de service weergeven.

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

set_service_properties

Hiermee stelt u de eigenschappen van de Queue-service van een opslagaccount in, waaronder Azure Opslaganalyse.

Als een element (bijvoorbeeld analytics_logging) op Geen blijft staan, blijven de bestaande instellingen in de service voor die functionaliteit behouden.

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

Parameters

analytics_logging

QueueAnalyticsLogging

Vereist

Hiermee worden de azure analytics-instellingen voor logboekregistratie gegroepeerd.

hour_metrics

Metrics

Vereist

De instellingen voor metrische uurgegevens bieden een overzicht van aanvraagstatistieken gegroepeerd per API in aggregaties per uur voor wachtrijen.

minute_metrics

Metrics

Vereist

De instellingen voor metrische minuutgegevens bieden aanvraagstatistieken voor elke minuut voor wachtrijen.

cors

Optional[List[CorsRule]]

Vereist

U kunt maximaal vijf CorsRule-elementen in de lijst opnemen. Als er een lege lijst is opgegeven, worden alle CORS-regels verwijderd en CORS uitgeschakeld voor de service.

timeout

int

De time-outparameter wordt uitgedrukt in seconden.

Voorbeelden

Eigenschappen van wachtrijservice instellen.

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

Kenmerken

api_version

De versie van de Storage-API die wordt gebruikt voor aanvragen.

Retourtype

str

location_mode

De locatiemodus die de client momenteel gebruikt.

Dit is standaard 'primair'. Opties zijn 'primair' en 'secundair'.

Retourtype

str

primary_endpoint

De volledige URL van het primaire eindpunt.

Retourtype

str

primary_hostname

De hostnaam van het primaire eindpunt.

Retourtype

str

secondary_endpoint

De volledige URL van het secundaire eindpunt, indien geconfigureerd.

Als dit niet beschikbaar is, wordt er een ValueError gegenereerd. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname sleutelwoordargument bij instantiëring.

Retourtype

str

Uitzonderingen

ValueError

secondary_hostname

De hostnaam van het secundaire eindpunt.

Als dit niet beschikbaar is, is dit Geen. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname sleutelwoordargument bij instantiëring.

Retourtype

Optional[str]

url

De volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt.

Dit kan het primaire eindpunt of het secundaire eindpunt zijn, afhankelijk van de huidige location_mode. :retourneert: de volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt. :rtype: str