Abrufen von Warteschlangendiensteigenschaften

Artikel
06/27/2023

Der Get Queue Service Properties Vorgang ruft die Eigenschaften eines Azure Queue Storage-Kontos ab, einschließlich Eigenschaften für Storage Analytics und CORS-Regeln (Cross-Origin Resource Sharing).

Weitere Informationen zu CORS-Regeln (Cross-Origin Resource Sharing) und zur Auswertungslogik finden Sie unter CORS-Unterstützung für die Azure Storage-Dienste.

Anforderung

Die Get Queue Service Properties-Anforderung kann wie folgt angegeben werden. Es wird empfohlen, HTTPS zu verwenden. Ersetzen Sie <account-name> durch den Namen Ihres Speicherkontos:

Methode	Anforderungs-URI	HTTP-Version
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Hinweis

Der URI muss immer einen Schrägstrich (/) enthalten, um den Hostnamen von den Pfad- und Abfrageabschnitten des URI zu trennen. Bei diesem Vorgang ist der Pfadteil des URI leer.

URI-Parameter

Die folgenden zusätzlichen Parameter können für den Anforderungs-URI angegeben werden:

Parameter	BESCHREIBUNG
`restype=service&comp=properties`	Erforderlich. Zum Abrufen der Speicherdiensteigenschaften ist die Kombination beider Abfragezeichenfolgen erforderlich.
`timeout`	Optional. Der `timeout`-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Azure Queue Storage-Vorgänge.

Anforderungsheader

In der folgenden Tabelle werden erforderliche und optionale Anforderungsheader beschrieben.

Anforderungsheader	BESCHREIBUNG
`Authorization`	Erforderlich. Gibt das Autorisierungsschema, den Namen des Speicherkontos und die Signatur an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage.
`Date` oder `x-ms-date`	Erforderlich. Gibt die koordinierte Weltzeit (Coordinated Universal Time, UTC) für die Anforderung an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage.
`x-ms-version`	Erforderlich für alle autorisierten Anforderungen. Gibt die Version des für die Anforderung zu verwendenden Vorgangs an. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste.
`x-ms-client-request-id`	Optional. Stellt einen vom Client generierten, undurchsichtigen Wert mit einem Zeichenlimit von 1 Kibibyte (KiB) bereit, der in den Protokollen aufgezeichnet wird, wenn die Protokollierung konfiguriert ist. Es wird dringend empfohlen, diesen Header zu verwenden, um clientseitige Aktivitäten mit Anforderungen zu korrelieren, die der Server empfängt. Weitere Informationen finden Sie unter Überwachen von Azure Queue Storage.

Anforderungstext

Keine.

Antwort

Die Antwort enthält den HTTP-Statuscode, einen Satz von Antwortheadern und einen Antworttext.

Statuscode

Bei einem erfolgreichen Vorgang wird der Statuscode 200 (OK) zurückgegeben.

Antwortheader

Die Antwort für diesen Vorgang umfasst die folgenden Header. Die Antwort kann außerdem weitere HTTP-Standardheader enthalten. Alle Standardheader entsprechen der HTTP/1.1-Protokollspezifikation.

Antwortheader	BESCHREIBUNG
`x-ms-request-id`	Identifiziert eindeutig eine Anforderung, die an den Dienst gestellt wird.
`x-ms-version`	Gibt die Version des für die Antwort verwendeten Vorgangs an. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste.
`x-ms-client-request-id`	Kann zur Problembehandlung von Anforderungen und entsprechenden Antworten verwendet werden. Der Wert dieses Headers ist gleich dem Wert des `x-ms-client-request-id` Headers, wenn er in der Anforderung vorhanden ist und der Wert nicht mehr als 1.024 sichtbare ASCII-Zeichen enthält. Wenn der `x-ms-client-request-id` Header in der Anforderung nicht vorhanden ist, ist er in der Antwort nicht vorhanden.

Antworttext

Bei Version 2012-02-12 und früheren Versionen weist der Antworttext folgendes Format auf:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <Metrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Metrics>  
</StorageServiceProperties>

Ab Version 2013-08-15 lautet das Format des Antworttexts wie folgt:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-separated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders> comma-separated-list-of-request-headers </AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

Die folgende Tabelle erläutert die Elemente des Antworttexts:

Elementname	BESCHREIBUNG
Logging	Gruppiert die Storage Analytics Protokollierungseinstellungen.
Metriken	Gruppiert die Einstellungen für Storage Analytics Metriken. Die Metrics-Einstellungen stellen eine Zusammenfassung der Anforderungsstatistiken bereit, die in stündlichen Aggregaten für Warteschlangen nach API gruppiert sind.
HourMetrics	Gruppiert die Storage Analytics HourMetrics-Einstellungen. Die HourMetrics-Einstellungen stellen eine Zusammenfassung der Anforderungsstatistiken bereit, die in stündlichen Aggregaten für Warteschlangen nach API gruppiert sind.
MinuteMetrics	Gruppiert die Storage Analytics MinuteMetrics-Einstellungen. Die MinuteMetrics*-Einstellungen stellen Anforderungsstatistiken für Warteschlangen im Minutentakt bereit.
Version	Die Version von Storage Analytics, die derzeit verwendet wird.
Löschen	Gilt nur für die Protokollierungskonfiguration. Gibt an, ob Löschanforderungen protokolliert werden.
Lesen	Gilt nur für die Protokollierungskonfiguration. Gibt an, ob Leseanforderungen protokolliert werden.
Schreiben	Gilt nur für die Protokollierungskonfiguration. Gibt an, ob Schreibanforderungen protokolliert werden.
Aktiviert	Gibt an, ob Metriken für Azure Queue Storage aktiviert sind. Wenn die georedundante Replikation mit Lesezugriff aktiviert ist, werden sowohl primäre als auch sekundäre Metriken gesammelt. Wenn die georedundante Replikation mit Lesezugriff nicht aktiviert ist, werden nur primäre Metriken gesammelt.
IncludeAPIs	Gilt nur für die Konfiguration von Metriken. Gibt an, ob von einer Metrik eine Zusammenfassungsstatistik für aufgerufene API-Vorgänge generiert wird.
Aufbewahrungsrichtlinie/Aktiviert	Gibt an, ob eine Beibehaltungsrichtlinie für den Speicherdienst aktiviert ist.
Aufbewahrungsrichtlinie/Tage	Gibt die Anzahl von Tagen an, für die Metrik- oder Protokollierungsdaten beibehalten werden. Alle Daten, die älter als dieser Wert sind, werden gelöscht.
Cors	Gruppiert alle CORS-Regeln.
CorsRule	Gruppiert Einstellungen für eine CORS-Regel.
AllowedOrigins	Eine durch Trennzeichen getrennte Liste von Ursprungsdomänen, die über CORS zulässig sind, oder ein Sternchen (*) , wenn alle Domänen zulässig sind.
ExposedHeaders	Eine durch Trennzeichen getrennte Liste mit Antwortheadern, die für CORS-Clients verfügbar gemacht werden sollen.
MaxAgeInSeconds	Die Anzahl der Sekunden, die der Client oder Browser eine Preflightantwort zwischenspeichern soll.
AllowedHeaders	Eine durch Trennzeichen getrennte Liste von Headern, die Teil der ursprungsübergreifenden Anforderung sein dürfen.
AllowedMethods	Eine durch Trennzeichen getrennte Liste von HTTP-Methoden, die vom Ursprung ausgeführt werden dürfen. Für Azure Storage sind DELETE, GET, HEAD, MERGE, POST, OPTIONS oder PUT zulässig.

Authorization

Dieser Vorgang kann nur vom Speicherkontobesitzer aufgerufen werden.

Beispielanforderung und -antwort

Der folgende Beispiel-URI sendet eine Anforderung zum Abrufen der Warteschlangendiensteigenschaften für das fiktive Speicherkonto myaccount:

GET https://myaccount.queue.core.windows.net/?restype=service&comp=properties HTTP/1.1

Die Anforderung wird mit den folgenden Headern gesendet;

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 04:49:03 GMT  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.queue.core.windows.net

Nachdem die Anforderung gesendet wurde, wird die folgende Antwort zurückgegeben:

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: Wed, 23 Oct 2013 04:49:04 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2013-08-15

Der Antworttext ist mit folgendem Beispiel vergleichbar:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>1.0</Version>  
        <Delete>true</Delete>  
        <Read>false</Read>  
        <Write>true</Write>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
        <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins> http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

Weitere Informationen

Speicheranalyse
CORS-Unterstützung für die Azure Storage-Dienste
CORS HTTP-Spezifikation

Freigeben über