@azure/storage-queue package
Sınıflar
| AccountSASPermissions |
YALNıZCA NODE.JS ÇALıŞMA ZAMANıNDA KULLANıLABILIR. Bu, Bir AccountSAS tarafından 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 getirilmelidir ve bir <xref: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 bir yardımcı sınıfıdı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 bir <xref: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 <xref: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, <xref:CredentialPolicyCreator> nesneleri oluşturmak için kullanılan bir <xref:AnonymousCredentialPolicy> üyesi sağlar. <xref: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. |
| Credential |
Kimlik bilgileri, Azure Depolama HTTP isteklerini imzalamaya yönelik soyut bir sınıftır. Bu sınıf CredentialPolicy oluşturan bir credentialPolicyCreator fabrikasını barındıracaktır. |
| CredentialPolicy |
Göndermeden önce HTTP(S) isteklerini imzalamak için kullanılan kimlik bilgisi ilkesi. Bu soyut bir sınıftır. |
| Pipeline |
HTTP istek ilkelerini içeren bir İşlem Hattı 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 newPipeline() ve sağlanan ilkelere başvuru olarak başvurun. |
| 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 <xref: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. |
| 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 <xref:AccountSASSignatureValues> ve <xref:QueueSASSignatureValues> türleri tarafından oluşturulur. Oluşturulduktan sonra bir <xref:String> kodlanabilir ve doğrudan url'ye eklenebilir (ancak mevcut sorgu parametreleri olması durumunda bu sorgu parametrelerini eklemenin uygun araçlarını etkileyebilecek şekilde burada dikkatli olunmalıdır). 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:
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory, <xref:StorageBrowserPolicy> nesneleri oluşturmaya yardımcı olan bir fabrika sınıfıdır. |
| StorageClient |
StorageClient, <xref:QueueServiceClient>, <xref:QueueClient> vb. için tabanlı bir istemci sınıfını temsil eder. |
| StorageClientContext | |
| StorageRetryPolicy |
Üstel yeniden deneme ve doğrusal yeniden deneme uygulanarak yeniden deneme ilkesi. |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory, <xref:StorageRetryPolicy> nesneleri oluşturmaya 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. |
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 generateSASQueryParameters() öğesini çağırarak kuyruk url'lerine uygulanabilecek SAS'nin bir gösterimini elde edin. Not: hem bu sınıfın hem de <xref:SASQueryParameters> mevcut olduğunu çünkü ilkinin sabit 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. |
| CommonOptions |
Her uzak işlem için ortak seçenekler için bir arabirim. |
| CorsRule |
CORS, bir etki alanı altında çalışan bir web uygulamasının başka bir etki alanındaki kaynaklara erişmesini sağlayan bir HTTP özelliğidir. Web tarayıcıları, 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 |
| 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 |
Kuyrukta İletilere Göz Atma çağrılırken QueueMessageList dizisinde döndürülen nesne |
| PipelineOptions |
İşlem hattı oluşturucu için seçenek arabirimi. |
| QueueClearMessagesOptions |
<xref:QueueClient.clearMessages> işlemini yapılandırma seçenekleri |
| QueueCreateHeaders |
Queue_create işlemi için üst bilgileri tanımlar. |
| QueueCreateIfNotExistsResponse |
<xref:QueueClient.createIfNotExists> işlemi için yanıt verilerini içerir. |
| QueueCreateOptions |
<xref:QueueClient.create> işlemini yapılandırma seçenekleri |
| QueueDeleteHeaders |
Queue_delete işlemi için üst bilgileri tanımlar. |
| QueueDeleteIfExistsResponse |
<xref:QueueClient.deleteIfExists> işlemi için yanıt verilerini içerir. |
| QueueDeleteMessageOptions |
<xref:QueueClient.deleteMessage> işlemini yapılandırma seçenekleri |
| QueueDeleteOptions |
<xref:QueueClient.delete> işlemini yapılandırma seçenekleri |
| QueueExistsOptions |
<xref:QueueClient.exists> işlemini yapılandırma seçenekleri |
| QueueGenerateSasUrlOptions |
<xref:QueueClient.generateSasUrl> işlemini yapılandırma seçenekleri. |
| QueueGetAccessPolicyHeaders |
Queue_getAccessPolicy işlemi için üst bilgileri tanımlar. |
| QueueGetAccessPolicyOptions |
<xref:QueueClient.getAccessPolicy> işlemini yapılandırma seçenekleri |
| QueueGetPropertiesHeaders |
Queue_getProperties işlemi için üst bilgileri tanımlar. |
| QueueGetPropertiesOptions |
<xref:QueueClient.getProperties> işlemini yapılandırma seçenekleri |
| QueueItem |
Azure Depolama Kuyruğu. |
| QueuePeekMessagesOptions |
<xref:QueueClient.peekMessages> işlemini yapılandırma seçenekleri |
| QueueReceiveMessageOptions |
<xref:QueueClient.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 |
<xref:QueueClient.sendMessage> işlemini yapılandırma seçenekleri |
| QueueServiceProperties |
Depolama Hizmeti Özellikleri. |
| QueueServiceStatistics |
Depolama hizmeti için istatistikler. |
| QueueSetAccessPolicyHeaders |
Queue_setAccessPolicy işlemi için üst bilgileri tanımlar. |
| QueueSetAccessPolicyOptions |
<xref:QueueClient.setAccessPolicy> işlemini yapılandırma seçenekleri |
| QueueSetMetadataHeaders |
Queue_setMetadata işlemi için üst bilgileri tanımlar. |
| QueueSetMetadataOptions |
<xref:QueueClient.setMetadata> işlemini yapılandırma seçenekleri |
| QueueUpdateMessageOptions |
<xref:QueueClient.updateMessage> işlemini yapılandırma seçenekleri |
| RetentionPolicy |
bekletme ilkesi |
| SasIPRange |
SAS için izin verilen IP aralığı. |
| ServiceGenerateAccountSasUrlOptions |
<xref:QueueServiceClient.generateAccountSasUrl> işlemini yapılandırma seçenekleri. |
| ServiceGetPropertiesHeaders |
Service_getProperties işlemi için üst bilgileri tanımlar. |
| ServiceGetPropertiesOptions |
<xref:QueueServiceClient.getProperties> işlemini yapılandırma seçenekleri |
| ServiceGetStatisticsHeaders |
Service_getStatistics işlemi için üst bilgileri tanımlar. |
| ServiceGetStatisticsOptions |
<xref:QueueServiceClient.getStatistics> işlemini yapılandırma seçenekleri |
| ServiceListQueuesOptions |
<xref:QueueServiceClient.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 |
<xref:QueueServiceClient.setProperties> işlemini yapılandırma seçenekleri |
| SignedIdentifier |
İmzalı tanımlayıcı. |
| SignedIdentifierModel |
imzalı tanımlayıcı |
| StorageClientOptionalParams |
İsteğe bağlı parametreler. |
| 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. |
| 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 |
<xref:QueueClient.clearMessages> işlemi için yanıt verilerini içerir. |
| QueueCreateResponse |
Oluşturma işlemi için yanıt verilerini içerir. |
| QueueDeleteMessageResponse |
<xref:QueueClient.deleteMessage> işlemi için yanıt verilerini içerir. |
| QueueDeleteResponse |
Silme işlemi için yanıt verilerini içerir. |
| QueueGetAccessPolicyResponse |
<xref:QueueClient.getAccessPolicy> işlemi için yanıt verilerini içerir. |
| QueueGetPropertiesResponse |
getProperties işlemi için yanıt verilerini içerir. |
| QueuePeekMessagesResponse |
<xref:QueueClient.peekMessages> işleminin yanıt verilerini içerir. |
| QueueReceiveMessageResponse |
<xref:QueueClient.receiveMessages> işleminin yanıt verilerini içerir. |
| QueueSendMessageResponse |
<xref:QueueClient.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 |
<xref:QueueClient.updateMessage> işlemi için yanıt verilerini içerir. |
| ReceivedMessageItem |
|
| 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şlemi için yanıt verilerini içerir. |
| ServiceSetPropertiesResponse |
setProperties işleminin yanıt verilerini içerir. |
Numaralandırmalar
| SASProtocol |
Oluşturulan SAS için protokoller. |
| StorageRetryPolicyType |
RetryPolicy türleri. |
İşlevler
| generate |
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 <xref:SASQueryParameters> nesnesi oluşturur. |
| generate |
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 lütfen izinler, startsOn ve tanımlayıcı gibi ilgili özellikleri doğrudan ayarlayın. UYARI: Tanımlayıcı sağlanmadığında izinler ve süre sonuOn gereklidir. Tanımlayıcıya değer atamanız veya süre sonuBu oluşturucuyla başlarsanız & izinleri için el ile atamanız gerekir. |
| new |
Kimlik bilgileri sağlanan yeni bir İşlem Hattı nesnesi oluşturur. |
İşlev Ayrıntıları
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 <xref:SASQueryParameters> nesnesi oluşturur.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
Parametreler
- accountSASSignatureValues
- AccountSASSignatureValues
Hesabın SAS İmzası değerleri
- sharedKeyCredential
- StorageSharedKeyCredential
Paylaşılan anahtar kimlik bilgileri.
Döndürülenler
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 lütfen izinler, startsOn ve tanımlayıcı gibi ilgili özellikleri doğrudan ayarlayın.
UYARI: Tanımlayıcı sağlanmadığında izinler ve süre sonuOn gereklidir. Tanımlayıcıya değer atamanız veya süre sonuBu oluşturucuyla başlarsanız & izinleri için el ile atamanız gerekir.
function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
Parametreler
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Döndürülenler
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Kimlik bilgileri sağlanan yeni bir İşlem Hattı nesnesi oluşturur.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
Parametreler
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential, StorageSharedKeyCredential gibi veya hizmete yönelik isteklerin kimliğini doğrulamak için @azure/identity paketindeki herhangi bir kimlik bilgisi. TokenCredential arabirimini uygulayan bir nesne de sağlayabilirsiniz. Belirtilmezse, AnonymousCredential kullanılır.
- pipelineOptions
- StoragePipelineOptions
Seçenekler.
Döndürülenler
Yeni bir İşlem Hattı nesnesi.