@azure/storage-queue package

Klasy

AccountSASPermissions	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika do konstruowania ciągu reprezentującego uprawnienia przyznane przez accountSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą parametru toString i ustawić jako pole uprawnień w obiekcie AccountSASSignatureValues . Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
AccountSASResourceTypes	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika do konstruowania ciągu reprezentującego zasoby dostępne w usłudze AccountSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna dostęp do tego typu zasobu. Po ustawieniu wszystkich wartości należy je serializować za pomocą parametru toString i ustawić jako pole zasobów w obiekcie AccountSASSignatureValues . Można utworzyć ciąg zasobów bez tej klasy, ale kolejność zasobów jest określona, a ta klasa gwarantuje poprawność.
AccountSASServices	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika do konstruowania ciągu reprezentującego usługi dostępne w usłudze AccountSAS. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna dostęp do tej usługi. Po ustawieniu wszystkich wartości należy je serializować za pomocą parametru toString i ustawić jako pole usług w obiekcie AccountSASSignatureValues . Można skonstruować ciąg usług bez tej klasy, ale kolejność usług jest określona, a ta klasa gwarantuje poprawność.
AnonymousCredential	AnonymousCredential udostępnia element członkowski credentialPolicyCreator używany do tworzenia obiektów AnonymousCredentialPolicy. Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
AnonymousCredentialPolicy	Funkcja AnonymousCredentialPolicy jest używana z żądaniami HTTP(S), które odczytują zasoby publiczne lub są używane z sygnaturami dostępu współdzielonego (SAS).
BaseRequestPolicy	Klasa bazowa, z której pochodzą wszystkie zasady żądań.
Credential	Credential to abstrakcyjna klasa podpisywania żądań HTTP usługi Azure Storage. Ta klasa będzie hostować fabrykę credentialPolicyCreator, która generuje credentialPolicy.
CredentialPolicy	Zasady poświadczeń używane do podpisywania żądań HTTP przed wysłaniem. Jest to abstrakcyjna klasa.
Pipeline	Klasa Potok zawierająca zasady żądań HTTP. Możesz utworzyć domyślny potok, wywołując polecenie newPipeline. Możesz też utworzyć potok z własnymi zasadami za pomocą konstruktora potoku. Przed zaimplementowaniem dostosowanego potoku zapoznaj się z nowymi zasadamiPipeline i podanymi zasadami.
QueueClient	Obiekt QueueClient reprezentuje adres URL komunikatów kolejki usługi Azure Storage, co umożliwia manipulowanie jego komunikatami.
QueueSASPermissions	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Jest to klasa pomocnika do konstruowania ciągu reprezentującego uprawnienia przyznane przez usługę ServiceSAS do kolejki. Ustawienie wartości true oznacza, że każda sygnatura dostępu współdzielonego korzystająca z tych uprawnień przyzna uprawnienia dla tej operacji. Po ustawieniu wszystkich wartości należy je serializować za pomocą parametru toString i ustawić jako pole uprawnień w obiekcie QueueSASSignatureValues . Można utworzyć ciąg uprawnień bez tej klasy, ale kolejność uprawnień jest określona, a ta klasa gwarantuje poprawność.
QueueServiceClient	Obiekt QueueServiceClient reprezentuje adres URL usługi Azure Storage Queue, umożliwiając manipulowanie kolejkami.
RestError	Niestandardowy typ błędu dla żądań potoku, które zakończyły się niepowodzeniem.
SASQueryParameters	Reprezentuje składniki tworzące parametry zapytania sygnatury dostępu współdzielonego usługi Azure Storage. Ten typ nie jest konstruowany bezpośrednio przez użytkownika; Jest on generowany tylko przez typy AccountSASSignatureValues i QueueSASSignatureValues . Po wygenerowaniu można je kodować bezpośrednio do toString() adresu URL i dołączać do niego (należy zachować ostrożność w przypadku, gdy istnieją parametry zapytania, które mogą mieć wpływ na odpowiednie sposoby dołączania tych parametrów zapytania). UWAGA: Wystąpienia tej klasy są niezmienne.
StorageBrowserPolicy	StorageBrowserPolicy będzie obsługiwać różnice między Node.js i środowiskiem uruchomieniowym przeglądarki, w tym: Przeglądarki buforuje żądania GET/HEAD, dodając nagłówki warunkowe, takie jak "IF_MODIFIED_SINCE". StorageBrowserPolicy to zasady służące do dodawania zapytania sygnatury czasowej do adresu URL żądania GET/HEAD, co pozwala uniknąć pamięci podręcznej przeglądarki. Usuwanie nagłówka pliku cookie na potrzeby zabezpieczeń Usuń nagłówek zawartości, aby uniknąć ostrzeżenia przeglądarki
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageBrowserPolicy.
StorageRetryPolicy	Zasady ponawiania prób z ponawianiami wykładniczymi i zaimplementowanymi ponawianiami liniowymi.
StorageRetryPolicyFactory	StorageRetryPolicyFactory to klasa fabryki ułatwiająca generowanie obiektów StorageRetryPolicy .
StorageSharedKeyCredential	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. StorageSharedKeyCredential na potrzeby autoryzacji klucza konta usługi Azure Storage.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy to zasady używane do podpisywania żądania HTTP przy użyciu klucza współużytkowanego.

Interfejsy

AccessPolicy	Zasady dostępu
AccountSASSignatureValues	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Wartość AccountSASSignatureValues służy do generowania sygnatury dostępu współdzielonego (SAS) dla konta usługi Azure Storage. Po odpowiednim ustawieniu wszystkich wartości wywołaj metodę generateSASQueryParameters(), aby uzyskać reprezentację sygnatury dostępu współdzielonego, która może być faktycznie stosowana do adresów URL kolejki. Uwaga: ta klasa i parametr SASQueryParameters istnieją, ponieważ pierwsza jest modyfikowalna i logiczna reprezentacja, podczas gdy ta ostatnia jest niezmienna i używana do generowania rzeczywistych żądań REST. Aby https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 uzyskać więcej informacji koncepcyjnych na temat sygnatury dostępu współdzielonego, zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas opisy parametrów, w tym wymagane
CommonOptions	Interfejs dla opcji wspólnych dla każdej operacji zdalnej.
CorsRule	Mechanizm CORS (udostępnianie zasobów między źródłami) to funkcja protokołu HTTP, która umożliwia aplikacji internetowej działającej w ramach jednej domeny dostęp do zasobów w innej domenie. Przeglądarki internetowe implementują ograniczenie zabezpieczeń znane jako zasady o tym samym pochodzeniu, które uniemożliwia stronie internetowej wywoływanie interfejsów API w innej domenie; Mechanizm CORS zapewnia bezpieczny sposób zezwalania jednej domenie (domenie pochodzenia) na wywoływanie interfejsów API w innej domenie
DequeuedMessageItem	Obiekt zwrócony w tablicy QueueMessageList podczas wywoływania funkcji Get Messages w kolejce.
EnqueuedMessage	Obiekt zwrócony w tablicy QueueMessageList podczas wywoływania metody Put Message on a Queue
GeoReplication	Geo-Replication informacji dotyczących pomocniczej usługi storage
HttpHeaders	Kolekcja par klucz/wartość nagłówka HTTP.
HttpOperationResponse	Odpowiedź HTTP zgodna z rdzeniem v1 (core-http).
HttpResponse	Reprezentacja odpowiedzi HTTP, która zawiera odwołanie do żądania, które je pochodzi.
IHttpClient	Zgodny interfejs dla zasad żądań core-http
ListQueuesSegmentResponse	Obiekt zwracany podczas wywoływania kolejek listy w usłudze kolejki.
Logging	Ustawienia rejestrowania usługi Azure Analytics.
MessageIdDeleteHeaders	Definiuje nagłówki dla operacji MessageId_delete.
MessageIdUpdateHeaders	Definiuje nagłówki dla operacji MessageId_update.
MessagesClearHeaders	Definiuje nagłówki dla operacji Messages_clear.
MessagesDequeueHeaders	Definiuje nagłówki dla operacji Messages_dequeue.
MessagesDequeueOptionalParams	Parametry opcjonalne.
MessagesEnqueueHeaders	Definiuje nagłówki dla operacji Messages_enqueue.
MessagesEnqueueOptionalParams	Parametry opcjonalne.
MessagesPeekHeaders	Definiuje nagłówki dla operacji Messages_peek.
MessagesPeekOptionalParams	Parametry opcjonalne.
Metadata	Kolekcja par ciągów klucz-wartość.
Metrics	Interfejs reprezentujący metryki.
PeekedMessageItem	Obiekt zwrócony w tablicy QueueMessageList podczas wywoływania funkcji Podgląd komunikatów w kolejce
PipelineLike	Interfejs klasy Pipeline zawierający zasady żądań HTTP. Możesz utworzyć domyślny potok, wywołując polecenie newPipeline. Możesz też utworzyć potok z własnymi zasadami za pomocą konstruktora potoku. Przed zaimplementowaniem dostosowanego potoku zapoznaj się z nowymi zasadamiPipeline i podanymi zasadami.
PipelineOptions	Interfejs opcji konstruktora potoku.
QueueClearMessagesOptions	Opcje konfigurowania operacji clearMessages
QueueCreateHeaders	Definiuje nagłówki dla operacji Queue_create.
QueueCreateIfNotExistsResponse	Zawiera dane odpowiedzi dla operacji createIfNotExists .
QueueCreateOptions	Opcje konfigurowania operacji tworzenia
QueueDeleteHeaders	Definiuje nagłówki dla operacji Queue_delete.
QueueDeleteIfExistsResponse	Zawiera dane odpowiedzi dla operacji deleteIfExists .
QueueDeleteMessageOptions	Opcje konfigurowania operacji deleteMessage
QueueDeleteOptions	Opcje konfigurowania operacji usuwania
QueueExistsOptions	Opcje konfigurowania operacji istnieje
QueueGenerateSasUrlOptions	Opcje konfigurowania operacji generateSasUrl .
QueueGetAccessPolicyHeaders	Definiuje nagłówki dla operacji Queue_getAccessPolicy.
QueueGetAccessPolicyOptions	Opcje konfigurowania operacji getAccessPolicy
QueueGetPropertiesHeaders	Definiuje nagłówki dla operacji Queue_getProperties.
QueueGetPropertiesOptions	Opcje konfigurowania operacji getProperties
QueueItem	Kolejka usługi Azure Storage.
QueuePeekMessagesOptions	Opcje konfigurowania operacji peekMessages
QueueReceiveMessageOptions	Opcje konfigurowania operacji receiveMessages
QueueSASSignatureValues	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Funkcja QueueSASSignatureValues służy do generowania tokenów SAS usługi kolejki dla kolejek.
QueueSendMessageOptions	Opcje konfigurowania operacji sendMessage
QueueServiceProperties	Właściwości usługi Storage.
QueueServiceStatistics	Statystyki usługi magazynu.
QueueSetAccessPolicyHeaders	Definiuje nagłówki dla operacji Queue_setAccessPolicy.
QueueSetAccessPolicyOptions	Opcje konfigurowania operacji setAccessPolicy
QueueSetMetadataHeaders	Definiuje nagłówki dla operacji Queue_setMetadata.
QueueSetMetadataOptions	Opcje konfigurowania operacji setMetadata
QueueUpdateMessageOptions	Opcje konfigurowania operacji updateMessage
RequestPolicyFactory	Interfejs umożliwiający zgodność z elementem RequestPolicyFactory core-http
RequestPolicyOptions	Interfejs umożliwiający zgodność z zasadami RequestPolicy
ResponseLike	Obiekt z prostą właściwością _response.
ResponseWithBody	Obiekt z właściwością _response, która ma już treść i nagłówki analizowane w znanych typach.
ResponseWithHeaders	Obiekt z właściwością _response, która ma już nagłówki analizowane w typowanym obiekcie.
RetentionPolicy	zasady przechowywania
SasIPRange	Dozwolony zakres adresów IP dla sygnatury dostępu współdzielonego.
ServiceClientOptions	Podzestaw elementu @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Opcje konfigurowania operacji generateAccountSasUrl .
ServiceGetPropertiesHeaders	Definiuje nagłówki dla operacji Service_getProperties.
ServiceGetPropertiesOptions	Opcje konfigurowania operacji getProperties
ServiceGetStatisticsHeaders	Definiuje nagłówki dla operacji Service_getStatistics.
ServiceGetStatisticsOptions	Opcje konfigurowania operacji getStatistics
ServiceListQueuesOptions	Opcje konfigurowania operacji listQueues
ServiceListQueuesSegmentHeaders	Definiuje nagłówki dla operacji Service_listQueuesSegment.
ServiceSetPropertiesHeaders	Definiuje nagłówki dla operacji Service_setProperties.
ServiceSetPropertiesOptions	Opcje konfigurowania operacji setProperties
SignedIdentifier	Podpisany identyfikator.
SignedIdentifierModel	podpisany identyfikator
StoragePipelineOptions	Interfejs opcji dla nowej funkcjiPipeline .
StorageRetryOptions	Interfejs opcji ponawiania prób obiektu blob usługi Storage.
WebResource	Opis żądania HTTP, który ma zostać złożony na serwerze zdalnym.

Aliasy typu

CredentialPolicyCreator	Funkcja fabryki, która tworzy nową funkcję CredentialPolicy, która używa podanej metody nextPolicy.
GeoReplicationStatusType	Definiuje wartości parametru GeoReplicationStatusType.
HttpRequestBody	Typy ciał obsługiwanych na żądanie. NodeJS.ReadableStream i () => NodeJS.ReadableStream jest tylko węzłem. Obiekty blob, ReadableStream i () => ReadableStream są tylko przeglądarką.
ListQueuesIncludeType	Definiuje wartości parametru ListQueuesIncludeType. Możliwe wartości to: "metadata"
MessageIdDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
MessageIdUpdateResponse	Zawiera dane odpowiedzi dla operacji aktualizacji.
MessagesClearResponse	Zawiera dane odpowiedzi dla operacji czyszczenia.
QueueClearMessagesResponse	Zawiera dane odpowiedzi dla operacji clearMessages .
QueueCreateResponse	Zawiera dane odpowiedzi dla operacji tworzenia.
QueueDeleteMessageResponse	Zawiera dane odpowiedzi dla operacji deleteMessage .
QueueDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
QueueGetAccessPolicyResponse	Zawiera dane odpowiedzi dla operacji getAccessPolicy .
QueueGetPropertiesResponse	Zawiera dane odpowiedzi dla operacji getProperties.
QueuePeekMessagesResponse	Zawiera dane odpowiedzi dla operacji peekMessages .
QueueReceiveMessageResponse	Zawiera dane odpowiedzi dla operacji receiveMessages .
QueueSendMessageResponse	Zawiera dane odpowiedzi dla operacji sendMessage .
QueueSetAccessPolicyResponse	Zawiera dane odpowiedzi dla operacji setAccessPolicy.
QueueSetMetadataResponse	Zawiera dane odpowiedzi dla operacji setMetadata.
QueueUpdateMessageResponse	Zawiera dane odpowiedzi dla operacji updateMessage .
ReceivedMessageItem	Obiekt zwrócony w tablicy receivedMessageItems podczas wywoływania funkcji receiveMessages. Zobacz: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	Zawiera dane odpowiedzi dla operacji getProperties.
ServiceGetStatisticsResponse	Zawiera dane odpowiedzi dla operacji getStatistics.
ServiceListQueuesSegmentResponse	Zawiera dane odpowiedzi dla operacji listQueuesSegment.
ServiceSetPropertiesResponse	Zawiera dane odpowiedzi dla operacji setProperties.
WithResponse	Typ reprezentujący wynik operacji ze znaną właściwością _response.

Wyliczenia

SASProtocol	Protokoły dla wygenerowanej sygnatury dostępu współdzielonego.
StorageQueueAudience	Definiuje znanych odbiorców chmury dla usługi Storage.
StorageRetryPolicyType	Typy RetryPolicy.

Funkcje

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Generuje obiekt SASQueryParameters zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Tworzy wystąpienie parametrów SASQueryParameters. Akceptuje tylko wymagane ustawienia wymagane do utworzenia sygnatury dostępu współdzielonego. W przypadku ustawień opcjonalnych ustaw odpowiednie właściwości bezpośrednio, takie jak uprawnienia, startsOn i identyfikator. OSTRZEŻENIE: Jeśli identyfikator nie zostanie podany, wymagane są uprawnienia i wygaśnięcieWłaściwej. Musisz przypisać wartość do identyfikatora lub wygaśnieW & uprawnienia ręcznie, jeśli zostanie zainicjowany przy użyciu tego konstruktora.
getQueueServiceAccountAudience(string)	Aby uzyskać odbiorców protokołu OAuth dla konta magazynu dla usługi kolejki.
isPipelineLike(unknown)	Pomocnik do podjęcia decyzji, czy dany argument spełnia kontrakt potoku
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Tworzy nowy obiekt Pipeline z podanym poświadczenie.

Szczegóły funkcji

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Generuje obiekt SASQueryParameters zawierający wszystkie parametry zapytania SAS potrzebne do utworzenia rzeczywistego żądania REST.

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

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

Parametry

accountSASSignatureValues

AccountSASSignatureValues

Wartości sygnatury sygnatury dostępu współdzielonego konta

sharedKeyCredential

StorageSharedKeyCredential

Poświadczenia klucza wspólnego.

Zwraca

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy wystąpienie parametrów SASQueryParameters.

Akceptuje tylko wymagane ustawienia wymagane do utworzenia sygnatury dostępu współdzielonego. W przypadku ustawień opcjonalnych ustaw odpowiednie właściwości bezpośrednio, takie jak uprawnienia, startsOn i identyfikator.

OSTRZEŻENIE: Jeśli identyfikator nie zostanie podany, wymagane są uprawnienia i wygaśnięcieWłaściwej. Musisz przypisać wartość do identyfikatora lub wygaśnieW & uprawnienia ręcznie, jeśli zostanie zainicjowany przy użyciu tego konstruktora.

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

Parametry

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Zwraca

SASQueryParameters

getQueueServiceAccountAudience(string)

Aby uzyskać odbiorców protokołu OAuth dla konta magazynu dla usługi kolejki.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parametry

storageAccountName

string

Zwraca

string

isPipelineLike(unknown)

Pomocnik do podjęcia decyzji, czy dany argument spełnia kontrakt potoku

function isPipelineLike(pipeline: unknown): pipeline

Parametry

pipeline

unknown

Argument, który może być potokiem

Zwraca

pipeline

true, gdy argument spełnia kontrakt potoku

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy nowy obiekt Pipeline z podanym poświadczenie.

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

Parametry

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

pipelineOptions

StoragePipelineOptions

Opcjonalny. Opcje.

Zwraca

Pipeline

Nowy obiekt Pipeline.