Üzenetsor-szolgáltatás tulajdonságainak beállítása

Cikk
08/05/2023

A Set Queue Service Properties művelet beállítja a tárfiók Queue szolgáltatásvégpontjának tulajdonságait, beleértve a Storage Analytics és a különböző eredetű erőforrások megosztására (CORS) vonatkozó szabályokat. A CORS-szabályokkal kapcsolatos további információkért lásd : CORS-támogatás a Storage-szolgáltatásokhoz .

Kérés

A kérést az Set Queue Service Properties alábbiak szerint adhatja meg. Javasoljuk, hogy HTTPS-t használjon. Cserélje le a fióknevet a tárfiók nevére:

Metódus	Kérés URI-ja	HTTP-verzió
PUT	`https://account-name.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Megjegyzés

Az URI-nak mindig tartalmaznia kell perjel karaktert (/), hogy elkülönítse az állomásnevet az URI elérési útjától és lekérdezési részeitől. Ebben a műveletben az URI elérési útja üres.

URI-paraméterek

Paraméter	Leírás
`restype=service&comp=properties`	Kötelező. Az Azure Storage szolgáltatás tulajdonságainak beállításához mindkét lekérdezési sztring kombinációja szükséges.
`timeout`	Választható. A `timeout` paraméter másodpercben van kifejezve. További információ: Időtúllépések beállítása a Queue szolgáltatás műveleteihez.

Kérésfejlécek

A szükséges és nem kötelező kérésfejléceket az alábbi táblázat ismerteti:

Kérelem fejléce	Leírás
`Authorization`	Kötelező. Megadja az engedélyezési sémát, a tárfiók nevét és az aláírást. További információ: Kérelmek engedélyezése az Azure Storage-ba.
`Date` vagy `x-ms-date`	Kötelező. Megadja a kérés egyezményes világidő (UTC) formátumban kifejezett időpontját. További információ: Kérelmek engedélyezése az Azure Storage-ba.
`x-ms-version`	Minden engedélyezett kéréshez szükséges. A kérelemhez használandó művelet verzióját adja meg. További információ: Az Azure Storage-szolgáltatások verziószámozása.
`x-ms-client-request-id`	Választható. Ügyfél által generált, átlátszatlan értéket biztosít egy 1 kibibyte (KiB) karakterkorláttal, amelyet a naplózás konfigurálásakor rögzít a naplókban. Javasoljuk, hogy ezt a fejlécet használva korrelálja az ügyféloldali tevékenységeket a kiszolgáló által kapott kérésekkel. További információ: Az Azure Queue Storage monitorozása.

A kérés törzse

A 2012-02-12-es és korábbi verziók esetében a kérelemtörzs formátuma a következő:

<?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>

A 2013-08-15-ös és újabb verziók esetében a kérelem törzsének formátuma a következő:

<?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-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders> comma-seperated-list-of-request-headers </AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

A 2013-08-15-ös verziótól a kérés törzsében megadott egy vagy több gyökérelem használatával hívható Set Queue Service Properties meg. A gyökérelemek a következők:

Logging
HourMetrics
MinuteMetrics
Cors

Már nem szükséges megadni a kérés összes gyökérelemét. Ha kihagy egy gyökérelemet, a szolgáltatás meglévő beállításai megmaradnak az adott funkcióhoz. Ha azonban megad egy megadott gyökérelemet, az elem minden gyermekelemét meg kell adnia.

A kérelem törzsének elemeit a következő táblázat ismerteti:

Elem neve	Leírás
Logging	A 2013-08-15-ös verziótól nem kötelező. A korábbi verziókhoz szükséges. Csoportosítja a Storage Analytics naplózási beállításait.
Metrikák	A 2012-02-12-es és korábbi verziókhoz szükséges. Nem alkalmazható a 2013-08-15-ös és újabb verziókra. Csoportosítja a Storage Analytics Metrikák beállításait. A Metrikák beállításai az API-k szerint csoportosított kérelemstatisztikák összegzését biztosítják óránkénti összesítésekben az üzenetsorokhoz.
HourMetrics	Nem kötelező a 2013-08-15-ös és újabb verziókhoz. A korábbi verziókra nem alkalmazható. Csoportosítja a Storage Analytics HourMetrics beállításait. A HourMetrics beállításai az API-k szerint csoportosított kérésstatisztikák összegzését biztosítják óránkénti összesítésekben az üzenetsorokhoz.
MinuteMetrics	Nem kötelező a 2013-08-15-ös és újabb verziókhoz. A korábbi verziókra nem alkalmazható. Csoportosítja a Storage Analytics MinuteMetrics beállításait. A MinuteMetrics beállításai kérésstatisztikákat biztosítanak az üzenetsorok egyes perceihez. A 2013-08-15-nél korábbi verziók esetében a MinuteMetrics nem szerepel a válasz törzsében.
Verzió	A Naplózás, a Metrikák, a HourMetrics vagy a MinuteMetrics beállítások megadása esetén kötelező megadni. A konfigurálni kívánt Storage Analytics verziója.
Törlés	A Naplózás, a Metrikák, a HourMetrics vagy a MinuteMetrics beállítások megadása esetén kötelező megadni. Csak a naplózási konfigurációra vonatkozik. Azt jelzi, hogy minden törlési kérést naplózni kell-e.
Olvasás	A Naplózás, a Metrikák, a HourMetrics vagy a MinuteMetrics beállítások megadása esetén kötelező megadni. Csak a naplózási konfigurációra vonatkozik. Azt jelzi, hogy az összes olvasási kérést naplózni kell-e.
Írni	A Naplózás, a Metrikák, a HourMetrics vagy a MinuteMetrics beállítások megadása esetén kötelező megadni. Csak a naplózási konfigurációra vonatkozik. Azt jelzi, hogy minden írási kérést naplózni kell-e.
Engedélyezve	Kötelező. Azt jelzi, hogy engedélyezve vannak-e a metrikák a Queue szolgáltatásban. Ha az olvasási hozzáférés georedundáns replikációja engedélyezve van, az elsődleges és a másodlagos metrikákat is összegyűjti a rendszer. Ha az olvasási hozzáférés georedundáns replikációja nincs engedélyezve, csak az elsődleges metrikák lesznek összegyűjtve.
IncludeAPI-k	Csak akkor szükséges, ha a metrikák engedélyezve vannak. Csak a metrikák konfigurálására vonatkozik. Azt jelzi, hogy a metrikáknak létre kell-e hozniuk az úgynevezett API-műveletek összefoglaló statisztikáit.
RetentionPolicy/Enabled	Kötelező. Azt jelzi, hogy engedélyezve van-e adatmegőrzési szabályzat a tárolási szolgáltatáshoz.
RetentionPolicy/Days	Csak akkor szükséges, ha engedélyezve van egy adatmegőrzési szabályzat. Azt jelzi, hogy hány napig kell megőrizni a metrikákat vagy a naplózási adatokat. Az ennél az értéknél régebbi adatok törlődnek. A megadható minimális érték a `1`, a maximális érték `365` pedig (egy év).
Cors	Választható. A Cors elem a 2013-08-15-ös és újabb verziókban támogatott. Az összes CORS-szabály csoportosítása. Ha kihagyja ezt az elemcsoportot, az nem írja felül a meglévő CORS-beállításokat.
CorsRule	Választható. CorS-szabályt ad meg a Queue szolgáltatáshoz. Legfeljebb öt CorsRule-elemet vehet fel a kérelembe. Ha a kérelemtörzs nem tartalmaz CorsRule-elemeket , az összes CORS-szabály törlődik, és a CORS le lesz tiltva a Queue szolgáltatásban.
Engedélyezettorigins	Kötelező, ha CorsRule elem van jelen. A CORS-on keresztül engedélyezett forrástartományok vesszővel tagolt listája, vagy "*" az összes tartomány engedélyezéséhez. A forrástartományok helyettesítő karaktert is tartalmazhatnak az altartományban, amely lehetővé teszi a CORS-on keresztüli kéréseket a tartomány összes altartományához. Legfeljebb 64 forrástartományra korlátozva. Minden engedélyezett forrás legfeljebb 256 karakterből állhat.
ExposedHeaders	Kötelező, ha a CorsRule elem jelen van. A CORS-ügyfelek számára közzéteendő válaszfejlécek vesszővel tagolt listája. Legfeljebb 64 definiált fejléc és két előtagú fejléc. Minden fejléc legfeljebb 256 karakterből állhat.
MaxAgeInSeconds	Kötelező, ha a CorsRule elem jelen van. Azon másodpercek száma, amikor az ügyfélnek/böngészőnek gyorsítótáraznia kell az elővizsgálati választ.
AllowedHeaders	Kötelező, ha a CorsRule elem létezik. A forrásközi kérelem részét képező fejlécek vesszővel tagolt listája. Legfeljebb 64 definiált fejléc és 2 előtagú fejléc lehet. Minden fejléc legfeljebb 256 karakterből állhat.
Engedélyezettmethodok	Kötelező, ha a CorsRule elem létezik. A forrás által végrehajtható HTTP-metódusok vesszővel tagolt listája. Az Azure Storage esetében a megengedett módszerek a következők `DELETE`: , `GET`, `HEAD`, `MERGE`, `POST`, , `OPTIONS`vagy `PUT`.

Reagálás

A válasz tartalmaz egy HTTP-állapotkódot és egy válaszfejléceket.

Állapotkód

A sikeres művelet a 202-s állapotkódot adja vissza (Elfogadva).

Válaszfejlécek

A műveletre adott válasz a következő fejléceket tartalmazza. A válasz további szabványos HTTP-fejléceket is tartalmazhat. Minden szabványos fejléc megfelel a HTTP/1.1 protokoll specifikációjának.

Válaszfejléc	Description
`x-ms-request-id`	Egyedileg azonosítja a szolgáltatással szemben benyújtott kérést.
`x-ms-version`	A művelet válaszhoz használt verzióját adja meg. További információ: Az Azure Storage-szolgáltatások verziószámozása.
`x-ms-client-request-id`	A kérések és a kapcsolódó válaszok hibaelhárítására használható. A fejléc értéke megegyezik a `x-ms-client-request-id` fejléc értékével, ha az szerepel a kérelemben, és az érték legfeljebb 1024 látható ASCII-karaktert tartalmaz. Ha a `x-ms-client-request-id` fejléc nem szerepel a kérelemben, az nem jelenik meg a válaszban.

Választörzs

Nincsenek.

Engedélyezés

Ezt a műveletet csak a fióktulajdonos hívhatja meg.

Megjegyzések

Az alábbi korlátozások és korlátozások vonatkoznak az Azure Storage CORS-szabályaira:

Legfeljebb öt szabály tárolható.
A kérelem cors-szabálybeállításainak maximális mérete – az XML-címkék kivételével – nem haladhatja meg a 2 kib-ot.
Az engedélyezett fejléc, a közzétett fejléc vagy az engedélyezett forrás hossza nem haladhatja meg a 256 karaktert.
Az engedélyezett fejlécek és a közzétett fejlécek a következők lehetnek:
- Literális fejlécek, ahol meg van adva a fejléc pontos neve, például x-ms-meta-processed: . A kérelemben legfeljebb 64 literális fejléc adható meg.
- Előtaggal rendelkező fejlécek, ahol meg van adva a fejléc előtagja, például x-ms-meta-data*: . Az előtag ilyen módon történő megadása lehetővé teszi vagy elérhetővé teszi a megadott előtaggal kezdődő fejléceket. A kérelemben legfeljebb két előtagú fejléc adható meg.
Az elemben AllowedMethods megadott metódusoknak (vagy HTTP-parancsoknak) meg kell felelniük az Azure Storage szolgáltatás API-jai által támogatott metódusoknak. A támogatott módszerek a következők DELETE: , GET, HEAD, MERGE, POST, OPTIONSés PUT.

A CORS-szabályok megadása a kérelemben nem kötelező. Ha a kéréstörzs Cors elemének megadása nélkül hívSet Queue Service Properties, a meglévő CORS-szabályok megmaradnak.

A CORS letiltásához hívjon Set Queue Service Properties üres CORS-szabályokkal (azaz*</Cors>), és ne használjon belső CORS-szabályokat. Ez a hívás törli a meglévő szabályokat, és letiltja a CORS-t a Queue szolgáltatásban.

Minden CORS-szabályelemre szükség van, ha a CorsRule elem meg van adva. A kérés 400-os hibakóddal (Bad Request) meghiúsul, ha valamelyik elem hiányzik.

A 2013-08-15-ös verziótól az XML-beállítások elemei nem kötelezőek, így egy adott elemet frissíthet egy olyan XML elküldésével, amely csak a frissített elemet tartalmazza. A többi beállításra nincs hatással.

A CORS-szabályokkal és a kiértékelési logikával kapcsolatos részletes információkért lásd: CORS-támogatás az Azure Storage-szolgáltatásokhoz.

Mintakérés és válasz

Az alábbi URI-minta kérést küld a myaccount nevű fiktív tárfiók Queue-szolgáltatás tulajdonságainak módosítására:

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

A kérést a rendszer a következő fejlécekkel küldi el:

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

A kérést a rendszer a következő XML-törzstel küldi el:

<?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>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> 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>

A kérés elküldése után a rendszer a következő választ adja vissza:

HTTP/1.1 202 Accepted  
Connection: Keep-Alive  
Transfer-Encoding: chunked  
Date: Wed, 23 Oct 2013 04:28:20 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

Lásd még

CORS-támogatás az Azure Storage-szolgáltatásokhoz
CORS HTTP-specifikáció