@azure/storage-queue package

Előkelő társaság

AccountSASPermissions	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály, amely egy AccountSAS által megadott engedélyeket képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy AccountSASSignatureValues objektum engedélymezőjeként kell beállítani. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.
AccountSASResourceTypes	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály egy, az AccountSAS által elérhető erőforrásokat képviselő sztring létrehozásához. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó sasok hozzáférést biztosítanak az adott erőforrástípushoz. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy AccountSASSignatureValues objektum erőforrásmezőjeként kell beállítani. Az erőforrás-sztring ezen osztály nélkül is felépíthető, de az erőforrások sorrendje különleges, és ez az osztály garantálja a helyességet.
AccountSASServices	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály, amely egy, az AccountSAS által elérhető szolgáltatásokat képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az engedélyeket használó SAS hozzáférést biztosít az adott szolgáltatáshoz. Miután az összes érték be van állítva, ezt a toString használatával kell szerializálni, és egy AccountSASSignatureValues objektum szolgáltatásmezőjeként kell beállítani. A szolgáltatási sztring ezen osztály nélkül is felépíthető, de a szolgáltatások sorrendje különleges, és ez az osztály garantálja a helyességet.
AnonymousCredential	Az AnonymousCredential egy hitelesítőadatPolicyCreator-tagot biztosít, amellyel AnonymousCredentialPolicy objektumokat hozhat létre. Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.
AnonymousCredentialPolicy	Az AnonymousCredentialPolicy olyan HTTP-kérésekkel használható, amelyek nyilvános erőforrásokat olvasnak, vagy közös hozzáférésű jogosultságkódokkal (SAS) használják.
BaseRequestPolicy	Az az alaposztály, amelyből az összes kérelemszabályzat származik.
Credential	A hitelesítő adatok az Azure Storage HTTP-kérések aláírásának absztrakt osztályai. Ez az osztály egy credentialPolicyCreator gyárat fog üzemeltetni, amely credentialPolicy-t hoz létre.
CredentialPolicy	A HTTP(S) kérések elküldése előtt történő aláírásához használt hitelesítőadat-szabályzat. Ez egy absztrakt osztály.
Pipeline	HTTP-kérési szabályzatokat tartalmazó folyamatosztály. Létrehozhat egy alapértelmezett folyamatot newPipelinemeghívásával. Vagy létrehozhat egy saját szabályzatokkal rendelkező folyamatot a Pipeline konstruktorával. A testreszabott folyamat implementálása előtt tekintse meg newPipeline és a megadott szabályzatokat.
QueueClient	A QueueClient egy Azure Storage-üzenetsor üzeneteinek URL-címe, amely lehetővé teszi az üzenetek manipulálását.
QueueSASPermissions	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Ez egy segédosztály, amely egy serviceSAS által az üzenetsorhoz adott engedélyeket képviselő sztringet hoz létre. Az érték igaz értékre állítása azt jelenti, hogy az ezen engedélyeket használó SAS engedélyeket ad a művelethez. Miután az összes érték be van állítva, ezt a toStringgel kell szerializálni, és egy QueueSASSignatureValues objektum engedélymezőjeként kell beállítani. Az engedélysztring az osztály nélkül is felépíthető, de az engedélyek sorrendje különleges, és ez az osztály garantálja a helyességet.
QueueServiceClient	A QueueServiceClient az Azure Storage Queue szolgáltatás URL-címét jelöli, amely lehetővé teszi az üzenetsorok manipulálását.
SASQueryParameters	Az Azure Storage SAS lekérdezési paramétereit alkotó összetevőket jelöli. Ezt a típust nem közvetlenül a felhasználó készíti el; csak a AccountSASSignatureValues és QueueSASSignatureValues típusok generálják. A létrehozás után kódolható egy toString(), és közvetlenül hozzáfűzhető egy URL-címhez (itt azonban körültekintően kell eljárni, ha vannak meglévő lekérdezési paraméterek, amelyek befolyásolhatják a lekérdezési paraméterek hozzáfűzésének megfelelő módját). MEGJEGYZÉS: Az osztály példányai nem módosíthatók.
StorageBrowserPolicyFactory	A StorageBrowserPolicyFactory egy olyan gyári osztály, amely segít a StorageBrowserPolicy objektumok létrehozásában.
StorageRetryPolicy	Újrapróbálkozási szabályzat exponenciális újrapróbálkozással és lineáris újrapróbálkozással.
StorageRetryPolicyFactory	A StorageRetryPolicyFactory egy olyan gyári osztály, amely segít StorageRetryPolicy objektumok létrehozásában.
StorageSharedKeyCredential	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. StorageSharedKeyCredential az Azure Storage szolgáltatás fiókkulcs-engedélyezéséhez.
StorageSharedKeyCredentialPolicy	A StorageSharedKeyCredentialPolicy egy olyan szabályzat, amellyel HTTP-kéréseket írhat alá megosztott kulccsal.

Felületek

AccessPolicy	Hozzáférési szabályzat
AccountSASSignatureValues	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Az AccountSASSignatureValues használatával közös hozzáférésű jogosultságkód (SAS) jön létre egy Azure Storage-fiókhoz. Miután az összes érték megfelelően be van állítva, hívja meg a generateSASQueryParameters() metódust, hogy lekérje az SAS-t, amely ténylegesen alkalmazható az üzenetsor URL-címére. Vegye figyelembe, hogy ez az osztály és SASQueryParameters létezik, mert az előbbi nem módosítható és logikai ábrázolás, míg az utóbbi nem módosítható, és a tényleges REST-kérések létrehozására szolgál. Az SAS-ről a https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 további fogalmi információkért lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas a paraméterek leírását, beleértve azokat is, amelyek szükségesek
CommonOptions	Minden távoli művelethez gyakran használt lehetőségek felülete.
CorsRule	A CORS egy HTTP-funkció, amely lehetővé teszi, hogy az egyik tartomány alatt futó webalkalmazás hozzáférjen egy másik tartomány erőforrásaihoz. A webböngészők olyan, azonos eredetű szabályzatként ismert biztonsági korlátozást implementálnak, amely megakadályozza, hogy egy weblap más tartományban hívja meg az API-kat; A CORS biztonságos módot biztosít arra, hogy az egyik tartomány (a forrástartomány) meghívhassa az API-kat egy másik tartományban
DequeuedMessageItem	A QueueMessageList tömbben visszaadott objektum, amikor üzenetsoron hívja meg az Üzenetek lekérése parancsot.
EnqueuedMessage	A QueueMessageList tömbben visszaadott objektum, amikor üzenetsoron hívja meg az Üzenetet
GeoReplication	Geo-Replication másodlagos tárolási szolgáltatással kapcsolatos információk
HttpHeaders	HTTP-fejléckulcs/érték párok gyűjteménye.
HttpOperationResponse	Http-válasz, amely kompatibilis a core-v1 (core-http).
HttpResponse	EGY HTTP-válasz ábrázolása, amely az azt létrehozó kérésre mutató hivatkozást tartalmaz.
ListQueuesSegmentResponse	A várólisták várólistáinak hívása során visszaadott objektum egy üzenetsor-szolgáltatásban.
Logging	Az Azure Analytics naplózási beállításai.
MessageIdDeleteHeaders	A MessageId_delete művelet fejléceit határozza meg.
MessageIdUpdateHeaders	A MessageId_update művelet fejléceit határozza meg.
MessagesClearHeaders	A Messages_clear művelet fejléceit határozza meg.
MessagesDequeueHeaders	A Messages_dequeue művelet fejléceit határozza meg.
MessagesDequeueOptionalParams	Nem kötelező paraméterek.
MessagesEnqueueHeaders	A Messages_enqueue művelet fejléceit határozza meg.
MessagesEnqueueOptionalParams	Nem kötelező paraméterek.
MessagesPeekHeaders	A Messages_peek művelet fejléceit határozza meg.
MessagesPeekOptionalParams	Nem kötelező paraméterek.
Metadata	Kulcs-érték sztringpárok gyűjteménye.
Metrics	Metrikákat képviselő felület.
PeekedMessageItem	A QueueMessageList tömbben visszaadott objektum, amikor üzenetsoron hívja meg a Betekintő üzeneteket
PipelineLike	A HTTP-kérési szabályzatokat tartalmazó folyamat osztály felülete. Létrehozhat egy alapértelmezett folyamatot newPipelinemeghívásával. Vagy létrehozhat egy saját szabályzatokkal rendelkező folyamatot a Pipeline konstruktorával. A testreszabott folyamat implementálása előtt tekintse meg newPipeline és a megadott szabályzatokat.
PipelineOptions	A Folyamatkonstruktor beállítási felülete.
QueueClearMessagesOptions	A clearMessages művelet konfigurálási lehetőségei
QueueCreateHeaders	A Queue_create művelet fejléceit határozza meg.
QueueCreateIfNotExistsResponse	A createIfNotExists művelet válaszadatait tartalmazza.
QueueCreateOptions	-művelet konfigurálásához szükséges beállítások
QueueDeleteHeaders	A Queue_delete művelet fejléceit határozza meg.
QueueDeleteIfExistsResponse	A deleteIfExists művelet válaszadatait tartalmazza.
QueueDeleteMessageOptions	A deleteMessage művelet konfigurálására vonatkozó beállítások
QueueDeleteOptions	törlési művelet konfigurálására vonatkozó beállítások
QueueExistsOptions	A konfigurálására művelet beállításai léteznek
QueueGenerateSasUrlOptions	A generateSasUrl művelet konfigurálásához szükséges beállítások.
QueueGetAccessPolicyHeaders	A Queue_getAccessPolicy művelet fejléceit határozza meg.
QueueGetAccessPolicyOptions	A getAccessPolicy művelet konfigurálásához szükséges beállítások
QueueGetPropertiesHeaders	A Queue_getProperties művelet fejléceit határozza meg.
QueueGetPropertiesOptions	A getProperties művelet konfigurálási lehetőségei
QueueItem	Egy Azure Storage-üzenetsor.
QueuePeekMessagesOptions	A peekMessages művelet konfigurálási lehetőségei
QueueReceiveMessageOptions	A receiveMessages művelet konfigurálási lehetőségei
QueueSASSignatureValues	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. A QueueSASSignatureValues a queue-szolgáltatás SAS-jogkivonatainak létrehozására szolgál az üzenetsorokhoz.
QueueSendMessageOptions	A sendMessage művelet konfigurálási lehetőségei
QueueServiceProperties	Tárolási szolgáltatás tulajdonságai.
QueueServiceStatistics	A tárolási szolgáltatás statisztikái.
QueueSetAccessPolicyHeaders	A Queue_setAccessPolicy művelet fejléceit határozza meg.
QueueSetAccessPolicyOptions	A setAccessPolicy művelet konfigurálására irányuló beállítások
QueueSetMetadataHeaders	A Queue_setMetadata művelet fejléceit határozza meg.
QueueSetMetadataOptions	A setMetadata művelet konfigurálási lehetőségei
QueueUpdateMessageOptions	Az updateMessage művelet konfigurálásához szükséges beállítások
RequestPolicy	A core-http kérési szabályzatok kompatibilis felülete
RequestPolicyFactory	A core-http RequestPolicyFactory-jával való kompatibilitási felület
RequestPolicyOptions	A RequestPolicyval való kompatibilitást biztosító felület
ResponseLike	Egy egyszerű _response tulajdonsággal rendelkező objektum.
ResponseWithBody	Egy _response tulajdonsággal rendelkező objektum, amelynek törzse és fejlécei már ismert típusokba vannak elemezve.
ResponseWithHeaders	Egy _response tulajdonsággal rendelkező objektum, amelynek fejlécei már beírt objektumba vannak elemezve.
RetentionPolicy	az adatmegőrzési szabályzat
SasIPRange	SAS-hez engedélyezett IP-címtartomány.
ServiceClientOptions	A ServiceClientOptions @azure/core-http részhalmaza
ServiceGenerateAccountSasUrlOptions	Az generateAccountSasUrl művelet konfigurálásához szükséges beállítások.
ServiceGetPropertiesHeaders	A Service_getProperties művelet fejléceit határozza meg.
ServiceGetPropertiesOptions	A getProperties művelet konfigurálási lehetőségei
ServiceGetStatisticsHeaders	A Service_getStatistics művelet fejléceit határozza meg.
ServiceGetStatisticsOptions	A getStatistics művelet konfigurálási lehetőségei
ServiceGetUserDelegationKeyHeaders	Definiálja a fejléceket Service_getUserDelegationKey művelethez.
ServiceGetUserDelegationKeyOptions	A szolgáltatás konfigurálásának lehetőségei – Szerezd meg a Felhasználói Delegációs Kulcsot.
ServiceListQueuesOptions	Az listQueues művelet konfigurálási lehetőségei
ServiceListQueuesSegmentHeaders	A Service_listQueuesSegment művelet fejléceit határozza meg.
ServiceSetPropertiesHeaders	A Service_setProperties művelet fejléceit határozza meg.
ServiceSetPropertiesOptions	A setProperties művelet konfigurálási lehetőségei
SignedIdentifier	Aláírt azonosító.
SignedIdentifierModel	aláírt azonosító
StoragePipelineOptions	Az newPipeline függvény beállítási felülete.
StorageRetryOptions	A Storage Blob újrapróbálkozési beállításainak felülete.
UserDelegationKey	Egy felhasználói delegációs kulcs.
UserDelegationKeyModel	Egy felhasználói delegációs kulcs
WebResource	A távoli kiszolgálóra irányuló HTTP-kérés leírása.

Típus-aliasok

CredentialPolicyCreator	Egy gyári függvény, amely létrehoz egy új CredentialPolicy-t, amely a megadott nextPolicy-t használja.
GeoReplicationStatusType	A GeoReplicationStatusType értékeit határozza meg.
HttpRequestBody	A kérelemben támogatott szervek típusai. NodeJS.ReadableStream és () => NodeJS.ReadableStream csak csomópont. A Blob, a ReadableStream<Uint8Array> és a () => ReadableStream<Uint8Array> csak böngésző.
ListQueuesIncludeType	A ListQueuesIncludeType értékeit határozza meg. A lehetséges értékek a következők: "metaadatok"
MessageIdDeleteResponse	A törlési művelet válaszadatait tartalmazza.
MessageIdUpdateResponse	A frissítési művelet válaszadatait tartalmazza.
MessagesClearResponse	A törlési művelet válaszadatait tartalmazza.
QueueClearMessagesResponse	A clearMessages művelet válaszadatait tartalmazza.
QueueCreateResponse	A létrehozási művelet válaszadatait tartalmazza.
QueueDeleteMessageResponse	A deleteMessage művelet válaszadatait tartalmazza.
QueueDeleteResponse	A törlési művelet válaszadatait tartalmazza.
QueueGetAccessPolicyResponse	A getAccessPolicy művelet válaszadatait tartalmazza.
QueueGetPropertiesResponse	A getProperties művelet válaszadatait tartalmazza.
QueuePeekMessagesResponse	A peekMessages művelet válaszadatait tartalmazza.
QueueReceiveMessageResponse	A receiveMessages művelet válaszadatait tartalmazza.
QueueSendMessageResponse	A sendMessage művelet válaszadatait tartalmazza.
QueueSetAccessPolicyResponse	A setAccessPolicy művelet válaszadatait tartalmazza.
QueueSetMetadataResponse	A setMetadata művelet válaszadatait tartalmazza.
QueueUpdateMessageResponse	A updateMessage művelet válaszadatait tartalmazza.
ReceivedMessageItem	A receivedMessageItems tömbben visszaadott objektum receiveMessageshívásakor. Lásd: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	A getProperties művelet válaszadatait tartalmazza.
ServiceGetStatisticsResponse	A getStatistics művelet válaszadatait tartalmazza.
ServiceGetUserDelegationKeyResponse	Tartalmazza a getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) művelet válaszadatait.
ServiceListQueuesSegmentResponse	A listQueuesSegment művelet válaszadatait tartalmazza.
ServiceSetPropertiesResponse	A setProperties művelet válaszadatait tartalmazza.
WithResponse	Olyan típus, amely egy ismert _response tulajdonsággal rendelkező műveleteredményt jelöl.

Enums

SASProtocol	A létrehozott SAS protokolljai.
StorageQueueAudience	Meghatározza a Storage ismert felhőbeli célközönségeit.
StorageRetryPolicyType	RetryPolicy típusok.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy SASQueryParameters objektumot, amely tartalmazza a tényleges REST-kérés létrehozásához szükséges ÖSSZES SAS-lekérdezési paramétert. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, UserDelegationKey, string)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy SASQueryParameters-példányt. Csak az SAS létrehozásához szükséges beállításokat fogadja el. Az opcionális beállításokhoz adja meg közvetlenül a megfelelő tulajdonságokat, például az engedélyeket, a startsOnt és az azonosítót. FIGYELMEZTETÉS: Ha az azonosító nincs megadva, engedélyekre és lejáratokra van szükség. A konstruktor első használatakor manuálisan kell értéket hozzárendelnie az azonosítóhoz vagy a expiresOn & engedélyekhez.
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)
getQueueServiceAccountAudience(string)	OAuth-célközönség lekérése egy tárfiókhoz a várólistás szolgáltatáshoz.
isPipelineLike(unknown)	Segéd annak eldöntéséhez, hogy egy adott argumentum megfelel-e a folyamatszerződésnek
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Létrehoz egy új folyamatobjektumot a hitelesítő adatok megadva.

Változók

RestError	A sikertelen folyamatkérések egyéni hibatípusa.
StorageOAuthScopes	Az OAuth hatókör Azure Storage-hez használható.
logger	A @azure/logger csomag konfigurációja.

Funkciók részletei

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters objektumot, amely tartalmazza a tényleges REST-kérés létrehozásához szükséges ÖSSZES SAS-lekérdezési paramétert.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Paraméterek

accountSASSignatureValues

AccountSASSignatureValues

A fiók SAS-aláírási értékei

sharedKeyCredential

StorageSharedKeyCredential

Megosztott kulcs hitelesítő adatai.

Visszatér

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, UserDelegationKey, string)

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy SASQueryParameters-példányt.

Csak az SAS létrehozásához szükséges beállításokat fogadja el. Az opcionális beállításokhoz adja meg közvetlenül a megfelelő tulajdonságokat, például az engedélyeket, a startsOnt és az azonosítót.

FIGYELMEZTETÉS: Ha az azonosító nincs megadva, engedélyekre és lejáratokra van szükség. A konstruktor első használatakor manuálisan kell értéket hozzárendelnie az azonosítóhoz vagy a expiresOn & engedélyekhez.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Paraméterek

queueSASSignatureValues

QueueSASSignatureValues

userDelegationKey

UserDelegationKey

accountName

string

Visszatér

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Paraméterek

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Visszatér

SASQueryParameters

getQueueServiceAccountAudience(string)

OAuth-célközönség lekérése egy tárfiókhoz a várólistás szolgáltatáshoz.

function getQueueServiceAccountAudience(storageAccountName: string): string

Paraméterek

storageAccountName

string

Visszatér

string

isPipelineLike(unknown)

Segéd annak eldöntéséhez, hogy egy adott argumentum megfelel-e a folyamatszerződésnek

function isPipelineLike(pipeline: unknown): pipeline

Paraméterek

pipeline

unknown

Egy olyan argumentum, amely lehet folyamat

Visszatér

pipeline

igaz, ha az argumentum megfelel a folyamatszerződésnek

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehoz egy új folyamatobjektumot a hitelesítő adatok megadva.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Paraméterek

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

pipelineOptions

StoragePipelineOptions

Optional. Options.

Visszatér

Pipeline

Egy új folyamatobjektum.

Variable Details

RestError

A sikertelen folyamatkérések egyéni hibatípusa.

RestError: RestErrorConstructor

Típus

RestErrorConstructor

StorageOAuthScopes

Az OAuth hatókör Azure Storage-hez használható.

StorageOAuthScopes: string | string[]

Típus

string | string[]

logger

A @azure/logger csomag konfigurációja.

logger: AzureLogger

Típus

AzureLogger