@azure/storage-queue package

  • Başvuru

Sınıflar

AccountSASPermissions

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Bu, AccountSAS tarafından verilen izinleri temsil eden bir dize oluşturmak için yardımcı bir sınıftır. Değeri true olarak ayarlamak, bu izinleri kullanan tüm SAS'lerin bu işlem için izinler vermesi anlamına gelir. Tüm değerler ayarlandıktan sonra, bu toString ile seri hale getirilmeli ve AccountSASSignatureValues nesnesinde izinler alanı olarak ayarlanmalıdır. Bu sınıf olmadan izin dizesi oluşturmak mümkündür, ancak izinlerin sırası belirlidir ve bu sınıf doğruluğu garanti eder.
AccountSASResourceTypes

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Bu, AccountSAS tarafından erişilebilen kaynakları temsil eden bir dize oluşturmak için yardımcı bir sınıftır. Değeri true olarak ayarlamak, bu izinleri kullanan tüm SAS'lerin bu kaynak türüne erişim izni vermesi anlamına gelir. Tüm değerler ayarlandıktan sonra, bu toString ile seri hale getirilmeli ve AccountSASSignatureValues nesnesinde kaynaklar alanı olarak ayarlanmalıdır. Bu sınıf olmadan kaynak dizesini oluşturmak mümkündür, ancak kaynakların sırası belirlidir ve bu sınıf doğruluğu garanti eder.
AccountSASServices

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Bu, AccountSAS tarafından erişilebilen hizmetleri temsil eden bir dize oluşturmak için yardımcı bir sınıftır. Değeri true olarak ayarlamak, bu izinleri kullanan tüm SAS'lerin söz konusu hizmete erişim izni vermesi anlamına gelir. Tüm değerler ayarlandıktan sonra, bu toString ile seri hale getirilmeli ve AccountSASSignatureValues nesnesinde hizmetler alanı olarak ayarlanmalıdır. Bu sınıf olmadan hizmet dizesini oluşturmak mümkündür, ancak hizmetlerin sırası belirlidir ve bu sınıf doğruluğu garanti eder.
AnonymousCredential

AnonymousCredential, AnonymousCredentialPolicy nesneleri oluşturmak için kullanılan bir CredentialPolicyCreator üyesi sağlar. AnonymousCredentialPolicy , ortak kaynakları okuyan HTTP(S) istekleriyle veya Paylaşılan Erişim İmzaları (SAS) ile kullanılmak üzere kullanılır.
AnonymousCredentialPolicy

AnonymousCredentialPolicy, ortak kaynakları okuyan HTTP(S) istekleriyle veya Paylaşılan Erişim İmzaları (SAS) ile kullanılmak üzere kullanılır.
BaseRequestPolicy

Tüm istek ilkelerinin türetildiği temel sınıf.
Credential

Kimlik bilgisi, Azure Depolama HTTP istekleri imzalama için soyut bir sınıftır. Bu sınıf CredentialPolicy'yi oluşturan bir credentialPolicyCreator fabrikasını barındıracak.
CredentialPolicy

Göndermeden önce HTTP(S) isteklerini imzalamak için kullanılan kimlik bilgisi ilkesi. Bu soyut bir sınıftır.
HttpHeaders

HTTP üst bilgi anahtarı/değer çiftleri koleksiyonu.
Pipeline

HTTP istek ilkelerini içeren bir pipeline sınıfı. newPipeline() öğesini çağırarak varsayılan bir İşlem Hattı oluşturabilirsiniz. Alternatif olarak, İşlem Hattı oluşturucusunun kendi ilkelerinizle bir İşlem Hattı oluşturabilirsiniz. Özelleştirilmiş İşlem Hattınızı uygulamadan önce başvuru olarak newPipeline() ve sağlanan ilkelere bakın.
QueueClient

QueueClient, Azure Depolama Kuyruğu'nun iletilerini işlemenize olanak sağlayan bir URL'yi temsil eder.
QueueSASPermissions

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Bu, ServiceSAS tarafından kuyruğa verilen izinleri temsil eden bir dize oluşturmak için bir yardımcı sınıfıdır. Değeri true olarak ayarlamak, bu izinleri kullanan tüm SAS'lerin bu işlem için izinler vermesi anlamına gelir. Tüm değerler ayarlandıktan sonra, bu toString ile seri hale getirilmeli ve QueueSASSignatureValues nesnesinde izinler alanı olarak ayarlanmalıdır. Bu sınıf olmadan izin dizesi oluşturmak mümkündür, ancak izinlerin sırası belirlidir ve bu sınıf doğruluğu garanti eder.
QueueServiceClient

QueueServiceClient, kuyrukları işlemenize olanak sağlayan Azure Depolama Kuyruğu hizmetinin URL'sini temsil eder.
RequestPolicyOptions

RequestPolicy oluştururken kullanılabilecek isteğe bağlı özellikler.
RestError

Hizmet uç noktasına http isteğinden kaynaklanan bir hata.
SASQueryParameters

Azure Depolama SAS'sinin sorgu parametrelerini oluşturan bileşenleri temsil eder. Bu tür doğrudan kullanıcı tarafından yapılandırılmaz; yalnızca AccountSASSignatureValues ve QueueSASSignatureValues türleri tarafından oluşturulur. Oluşturulduktan sonra, bir içine toString() kodlanabilir ve doğrudan url'ye eklenebilir (ancak mevcut sorgu parametreleri olması durumunda burada dikkatli olunmalıdır ve bu da bu sorgu parametrelerini eklemenin uygun araçlarını etkileyebilir).

NOT: Bu sınıfın örnekleri sabittir.
StorageBrowserPolicy

StorageBrowserPolicy, Node.js ve tarayıcı çalışma zamanı arasındaki farkları işler; örneğin:

  1. Tarayıcılar, 'IF_MODIFIED_SINCE' gibi koşullu üst bilgiler ekleyerek GET/HEAD isteklerini önbelleğe alır. StorageBrowserPolicy, GET/HEAD istek URL'sine zaman damgası sorgusu eklemek için kullanılan bir ilkedir ve bu nedenle tarayıcı önbelleğinden kaçınır.

  2. Güvenlik için tanımlama bilgisi üst bilgisini kaldırma

  3. Tarayıcıların uyarısını önlemek için içerik uzunluğu üst bilgisini kaldırma
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory, StorageBrowserPolicy nesnelerinin oluşturulmasına yardımcı olan bir fabrika sınıfıdır.
StorageRetryPolicy

Üstel yeniden deneme ve doğrusal yeniden deneme uygulanarak yeniden deneme ilkesi.
StorageRetryPolicyFactory

StorageRetryPolicyFactory, StorageRetryPolicy nesnelerinin oluşturulmasına yardımcı olan bir fabrika sınıfıdır.
StorageSharedKeyCredential

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Azure Depolama hizmetinin hesap anahtarı yetkilendirmesi için StorageSharedKeyCredential.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy, HTTP isteğini paylaşılan anahtarla imzalamak için kullanılan bir ilkedir.
WebResource

Yeni bir WebResource nesnesi oluşturur.

Bu sınıf, kitaplık/uygulamadan bağımsız olarak ve istek başlatmak için gerekli özellikleri sarmalayarak REST çağrısı üzerinde soyutlama sağlar.

Arabirimler

AccessPolicy

Erişim ilkesi
AccountSASSignatureValues

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

AccountSASSignatureValues, bir Azure Depolama hesabı için Paylaşılan Erişim İmzası (SAS) oluşturmak için kullanılır. Buradaki tüm değerler uygun şekilde ayarlandıktan sonra, kuyruk URL'lerine gerçekten uygulanabilen SAS'nin bir gösterimini almak için generateSASQueryParameters() çağrısı yapın. Not: hem bu sınıfın hem de SASQueryParameters'ın mevcut olduğunu çünkü ilkinin değişebilir ve mantıksal bir gösterimi olduğunu, ikincisinin sabit olduğunu ve gerçek REST istekleri oluşturmak için kullanıldığını unutmayın.

SAS hakkında daha fazla kavramsal bilgi için bkz https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 . Gerekli olan parametreler dahil olmak üzere parametrelerin açıklamaları için bkz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas .
CommonOptions

Her uzak işlem için ortak seçenekler için bir arabirim.
CorsRule

CORS, başka bir etki alanındaki kaynaklara erişmek için bir etki alanı altında çalışan bir web uygulamasını etkinleştiren bir HTTP özelliğidir. Web tarayıcıları, bir web sayfasının farklı bir etki alanındaki API'leri çağırmasını engelleyen, aynı kaynak ilkesi olarak bilinen bir güvenlik kısıtlaması uygular; CORS, bir etki alanının (kaynak etki alanı) başka bir etki alanındaki API'leri çağırmasına izin vermek için güvenli bir yol sağlar
DequeuedMessageItem

Kuyrukta İleti Al çağrılırken QueueMessageList dizisinde döndürülen nesne.
EnqueuedMessage

Kuyruğa İleti Koy çağrılırken QueueMessageList dizisinde döndürülen nesne
GeoReplication

İkincil Depolama Hizmeti için Geo-Replication bilgileri
HttpOperationResponse

Http isteği ve yanıtı için sarmalayıcı nesnesi. Seri durumdan çıkarılmış nesne, yanıt gövdesi JSON veya XML olarak alındığında özelliğinde depolanır parsedBody .
IHttpClient

HttpRequests gönderebilen ve vaat edilen HttpResponses'i alabilen bir arabirim.
ListQueuesSegmentResponse

Bir Kuyruk Hizmetinde Liste Kuyrukları çağrılırken döndürülen nesne.
Logging

Azure Analytics Günlük ayarları.
MessageIdDeleteHeaders

MessageId_delete işlemi için üst bilgileri tanımlar.
MessageIdUpdateHeaders

MessageId_update işlemi için üst bilgileri tanımlar.
MessagesClearHeaders

Messages_clear işlemi için üst bilgileri tanımlar.
MessagesDequeueHeaders

Messages_dequeue işlemi için üst bilgileri tanımlar.
MessagesDequeueOptionalParams

İsteğe bağlı parametreler.
MessagesEnqueueHeaders

Messages_enqueue işlemi için üst bilgileri tanımlar.
MessagesEnqueueOptionalParams

İsteğe bağlı parametreler.
MessagesPeekHeaders

Messages_peek işlemi için üst bilgileri tanımlar.
MessagesPeekOptionalParams

İsteğe bağlı parametreler.
Metadata

Anahtar-değer dize çiftleri koleksiyonu.
Metrics

Ölçümleri temsil eden bir arabirim.
PeekedMessageItem

Kuyruktaki Gözatma İletileri çağrılırken QueueMessageList dizisinde döndürülen nesne
PipelineOptions

İşlem hattı oluşturucu için seçenek arabirimi.
QueueClearMessagesOptions

clearMessages işlemini yapılandırma seçenekleri
QueueCreateHeaders

Queue_create işlemi için üst bilgileri tanımlar.
QueueCreateIfNotExistsResponse

createIfNotExists işlemi için yanıt verilerini içerir.
QueueCreateOptions

Oluşturma işlemini yapılandırma seçenekleri
QueueDeleteHeaders

Queue_delete işlemi için üst bilgileri tanımlar.
QueueDeleteIfExistsResponse

deleteIfExists işleminin yanıt verilerini içerir.
QueueDeleteMessageOptions

deleteMessage işlemini yapılandırma seçenekleri
QueueDeleteOptions

Silme işlemini yapılandırma seçenekleri
QueueExistsOptions

Yapılandırma seçenekleri var işlemi
QueueGenerateSasUrlOptions

generateSasUrl işlemini yapılandırma seçenekleri.
QueueGetAccessPolicyHeaders

Queue_getAccessPolicy işlemi için üst bilgileri tanımlar.
QueueGetAccessPolicyOptions

getAccessPolicy işlemini yapılandırma seçenekleri
QueueGetPropertiesHeaders

Queue_getProperties işlemi için üst bilgileri tanımlar.
QueueGetPropertiesOptions

getProperties işlemini yapılandırma seçenekleri
QueueItem

Azure Depolama Kuyruğu.
QueuePeekMessagesOptions

peekMessages işlemini yapılandırma seçenekleri
QueueReceiveMessageOptions

receiveMessages işlemini yapılandırma seçenekleri
QueueSASSignatureValues

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

QueueSASSignatureValues, kuyruklar için Kuyruk hizmeti SAS belirteçleri oluşturmaya yardımcı olmak için kullanılır.
QueueSendMessageOptions

sendMessage işlemini yapılandırma seçenekleri
QueueServiceProperties

Depolama Hizmeti Özellikleri.
QueueServiceStatistics

Depolama hizmetinin istatistikleri.
QueueSetAccessPolicyHeaders

Queue_setAccessPolicy işlemi için üst bilgileri tanımlar.
QueueSetAccessPolicyOptions

setAccessPolicy işlemini yapılandırma seçenekleri
QueueSetMetadataHeaders

Queue_setMetadata işlemi için üst bilgileri tanımlar.
QueueSetMetadataOptions

setMetadata işlemini yapılandırma seçenekleri
QueueUpdateMessageOptions

updateMessage işlemini yapılandırma seçenekleri
RequestPolicy

İstek ilkesinin temel yapısı.
RetentionPolicy

bekletme ilkesi
SasIPRange

SAS için izin verilen IP aralığı.
ServiceGenerateAccountSasUrlOptions

generateAccountSasUrl işlemini yapılandırma seçenekleri.
ServiceGetPropertiesHeaders

Service_getProperties işlemi için üst bilgileri tanımlar.
ServiceGetPropertiesOptions

getProperties işlemini yapılandırma seçenekleri
ServiceGetStatisticsHeaders

Service_getStatistics işlemi için üst bilgileri tanımlar.
ServiceGetStatisticsOptions

getStatistics işlemini yapılandırma seçenekleri
ServiceListQueuesOptions

listQueues işlemini yapılandırma seçenekleri
ServiceListQueuesSegmentHeaders

Service_listQueuesSegment işlemi için üst bilgileri tanımlar.
ServiceSetPropertiesHeaders

Service_setProperties işlemi için üst bilgileri tanımlar.
ServiceSetPropertiesOptions

setProperties işlemini yapılandırma seçenekleri
SignedIdentifier

İmzalı tanımlayıcı.
SignedIdentifierModel

imzalı tanımlayıcı
StoragePipelineOptions

newPipeline() yöntemi için seçenek arabirimi.
StorageRetryOptions

Depolama Kuyruğu yeniden deneme seçenekleri arabirimi.

Tür Diğer Adları

CredentialPolicyCreator

Sağlanan nextPolicy kullanan yeni bir CredentialPolicy oluşturan fabrika işlevi.
GeoReplicationStatusType

GeoReplicationStatusType değerlerini tanımlar.
HttpRequestBody

Olası HTTP isteği gövde türleri
ListQueuesIncludeType

ListQueuesIncludeType değerlerini tanımlar. Olası değerler şunlardır: 'metadata'
MessageIdDeleteResponse

Silme işlemi için yanıt verilerini içerir.
MessageIdUpdateResponse

Güncelleştirme işlemi için yanıt verilerini içerir.
MessagesClearResponse

Temizleme işlemi için yanıt verilerini içerir.
QueueClearMessagesResponse

clearMessages işlemi için yanıt verilerini içerir.
QueueCreateResponse

Oluşturma işlemi için yanıt verilerini içerir.
QueueDeleteMessageResponse

deleteMessage işleminin yanıt verilerini içerir.
QueueDeleteResponse

Silme işleminin yanıt verilerini içerir.
QueueGetAccessPolicyResponse

getAccessPolicy işlemi için yanıt verilerini içerir.
QueueGetPropertiesResponse

getProperties işlemi için yanıt verilerini içerir.
QueuePeekMessagesResponse

peekMessages işleminin yanıt verilerini içerir.
QueueReceiveMessageResponse

receiveMessages işleminin yanıt verilerini içerir.
QueueSendMessageResponse

sendMessage işleminin yanıt verilerini içerir.
QueueSetAccessPolicyResponse

setAccessPolicy işleminin yanıt verilerini içerir.
QueueSetMetadataResponse

setMetadata işlemi için yanıt verilerini içerir.
QueueUpdateMessageResponse

updateMessage işlemi için yanıt verilerini içerir.
ReceivedMessageItem

receiveMessages çağrılırken dizide receivedMessageItems döndürülen nesne.

Bkz. QueueReceiveMessageResponse
RequestPolicyFactory

Sağlanan nextPolicy'yi kullanan istek başına yeni bir RequestPolicy oluşturur.
ServiceGetPropertiesResponse

getProperties işlemi için yanıt verilerini içerir.
ServiceGetStatisticsResponse

getStatistics işlemi için yanıt verilerini içerir.
ServiceListQueuesSegmentResponse

listQueuesSegment işleminin yanıt verilerini içerir.
ServiceSetPropertiesResponse

setProperties işlemi için yanıt verilerini içerir.

Numaralandırmalar

SASProtocol

Oluşturulan SAS için protokoller.
StorageQueueAudience

Depolama için bilinen bulut hedef kitlelerini tanımlar.
StorageRetryPolicyType

RetryPolicy türleri.

İşlevler

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

HTTP işlem hattından geçerken HTTP istek gövdelerini seri hale getiren yeni bir serileştirme RequestPolicyCreator oluşturun.
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Gerçek bir REST isteği yapmak için gereken tüm SAS sorgu parametrelerini içeren bir SASQueryParameters nesnesi oluşturur.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

SASQueryParameters örneğini oluşturur.

Yalnızca SAS oluşturmak için gereken ayarları kabul eder. İsteğe bağlı ayarlar için izinler, startsOn ve identifier gibi ilgili özellikleri doğrudan ayarlayın.

UYARI: Tanımlayıcı sağlanmadığında izinler ve expiresOn gereklidir. Tanımlayıcıya değer atamanız veya expiresOn & izinleri, bu oluşturucuyla başlarsanız el ile atamanız gerekir.
getQueueServiceAccountAudience(string)
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Kimlik bilgileri sağlanmış yeni bir İşlem Hattı nesnesi oluşturur.

İşlev Ayrıntıları

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

HTTP işlem hattından geçerken HTTP istek gövdelerini seri hale getiren yeni bir serileştirme RequestPolicyCreator oluşturun.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parametreler

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Döndürülenler

RequestPolicyFactory

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

Gerçek bir REST isteği yapmak için gereken tüm SAS sorgu parametrelerini içeren bir SASQueryParameters nesnesi oluşturur.

Bkz. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

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

Parametreler

accountSASSignatureValues
AccountSASSignatureValues

Hesabın SAS İmzası değerleri

sharedKeyCredential
StorageSharedKeyCredential

Paylaşılan anahtar kimlik bilgileri.

Döndürülenler

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR.

SASQueryParameters örneğini oluşturur.

Yalnızca SAS oluşturmak için gereken ayarları kabul eder. İsteğe bağlı ayarlar için izinler, startsOn ve identifier gibi ilgili özellikleri doğrudan ayarlayın.

UYARI: Tanımlayıcı sağlanmadığında izinler ve expiresOn gereklidir. Tanımlayıcıya değer atamanız veya expiresOn & izinleri, bu oluşturucuyla başlarsanız el ile atamanız gerekir.

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

Parametreler

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Döndürülenler

SASQueryParameters

getQueueServiceAccountAudience(string) 

function getQueueServiceAccountAudience(storageAccountName: string): string

Parametreler

storageAccountName

string

Döndürülenler

string

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Kimlik bilgileri sağlanmış yeni bir İşlem Hattı nesnesi oluşturur.

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

Parametreler

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential, StorageSharedKeyCredential veya hizmete yönelik isteklerin @azure/identity kimliğini doğrulamak için paketten herhangi bir kimlik bilgisi gibi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.

pipelineOptions
StoragePipelineOptions

Seçenekler’i seçin.

Döndürülenler

Pipeline

Yeni bir İşlem Hattı nesnesi.