@azure/storage-queue package

クラス

AccountSASPermissions	NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によって付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、その操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、 AccountSASSignatureValues オブジェクトのアクセス許可フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
AccountSASResourceTypes	NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なリソースを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのリソースの種類へのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、 AccountSASSignatureValues オブジェクトのリソース フィールドとして設定する必要があります。 このクラスを使用せずにリソース文字列を構築することはできますが、リソースの順序は特定であり、このクラスは正確性を保証します。
AccountSASServices	NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なサービスを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのサービスへのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、 AccountSASSignatureValues オブジェクトのサービス フィールドとして設定する必要があります。 このクラスを使用せずにサービス文字列を構築することはできますが、サービスの順序は特定であり、このクラスは正確性を保証します。
AnonymousCredential	AnonymousCredential は、AnonymousCredentialPolicy オブジェクトの作成に使用される credentialPolicyCreator メンバーを提供します。 AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求、または Shared Access Signatures (SAS) で使用するために使用されます。
AnonymousCredentialPolicy	AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求、または Shared Access Signatures (SAS) で使用するために使用されます。
BaseRequestPolicy	すべての要求ポリシーの派生元となる基底クラス。
Credential	資格情報は、Azure Storage HTTP 要求の署名のための抽象クラスです。 このクラスは、CredentialPolicy を生成する credentialPolicyCreator ファクトリをホストします。
CredentialPolicy	送信前に HTTP(S) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。
Pipeline	HTTP 要求ポリシーを含む Pipeline クラス。 newPipeline を呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターを使用して、独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプラインを実装する前に、 newPipeline と指定されたポリシーを参照してください。
QueueClient	QueueClient は、Azure Storage キューのメッセージへの URL を表し、メッセージを操作できます。
QueueSASPermissions	NODE.JS ランタイムでのみ使用できます。 これは、ServiceSAS によって Queue に付与されるアクセス許可を表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、その操作のアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、 QueueSASSignatureValues オブジェクトのアクセス許可フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を構築することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
QueueServiceClient	QueueServiceClient は、キューを操作できる Azure Storage Queue サービスへの URL を表します。
RestError	失敗したパイプライン要求のカスタム エラーの種類。
SASQueryParameters	Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されません。 AccountSASSignatureValues 型と QueueSASSignatureValues 型によってのみ生成されます。 生成後は、 に toString() エンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これは、これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは不変です。
StorageBrowserPolicy	StorageBrowserPolicy は、Node.js とブラウザー ランタイムの違いを処理します。次に示します。 ブラウザーは、"IF_MODIFIED_SINCE" などの条件付きヘッダーを追加して、GET/HEAD 要求をキャッシュします。 StorageBrowserPolicy は、GET/HEAD 要求 URL にタイムスタンプ クエリを追加するために使用されるポリシーであるため、ブラウザーキャッシュを回避します。 セキュリティのために Cookie ヘッダーを削除する ブラウザーの警告を回避するために content-length ヘッダーを削除する
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory は、StorageBrowserPolicy オブジェクトの生成を支援するファクトリ クラスです。
StorageRetryPolicy	指数再試行と線形再試行が実装された再試行ポリシー。
StorageRetryPolicyFactory	StorageRetryPolicyFactory は、 StorageRetryPolicy オブジェクトの生成を支援するファクトリ クラスです。
StorageSharedKeyCredential	NODE.JS ランタイムでのみ使用できます。 Azure Storage サービスのアカウント キー承認用の StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy は、共有キーを使用して HTTP 要求に署名するために使用されるポリシーです。

インターフェイス

AccessPolicy	アクセス ポリシー
AccountSASSignatureValues	NODE.JS ランタイムでのみ使用できます。 AccountSASSignatureValues は、Azure Storage アカウントの Shared Access Signature (SAS) を生成するために使用されます。 ここでのすべての値が適切に設定されたら、generateSASQueryParameters() を呼び出して、実際にキュー URL に適用できる SAS の表現を取得します。 注: このクラスと SASQueryParameters の両方が存在するのは、前者が変更可能であり論理表現であるのに対し、後者は不変であり、実際の REST 要求を生成するために使用されるためです。 SAS の詳細な概念情報についてはhttps://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1、必要なパラメーターを含むパラメーターの説明に関するページを参照してくださいhttps://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
CommonOptions	すべてのリモート操作に共通するオプションのインターフェイス。
CorsRule	CORS は、あるドメインで実行されている Web アプリケーションが別のドメイン内にあるリソースにアクセスできるようにする HTTP 機能です。 Web ブラウザーは、Web ページが別のドメイン内の API を呼び出すのを防ぐ、同じ配信元ポリシーと呼ばれるセキュリティ制限を実装します。CORS は、あるドメイン (配信元ドメイン) が別のドメインの API を呼び出せるようにするための安全な方法を提供します
DequeuedMessageItem	Queue でメッセージの取得を呼び出すときに QueueMessageList 配列で返されるオブジェクト。
EnqueuedMessage	キューにメッセージを配置するを呼び出すときに QueueMessageList 配列で返されるオブジェクト
GeoReplication	セカンダリ ストレージ サービスの Geo-Replication 情報
HttpHeaders	HTTP ヘッダーのキーと値のペアのコレクション。
HttpOperationResponse	core-v1(core-http) と互換性のある Http 応答。
HttpResponse	生成された要求への参照を含む HTTP 応答の表現。
IHttpClient	core-http 要求ポリシーの互換性のあるインターフェイス
ListQueuesSegmentResponse	キュー サービスで List Queues を呼び出すときに返される オブジェクト。
Logging	Azure Analytics のログ設定。
MessageIdDeleteHeaders	MessageId_delete操作のヘッダーを定義します。
MessageIdUpdateHeaders	MessageId_update操作のヘッダーを定義します。
MessagesClearHeaders	Messages_clear操作のヘッダーを定義します。
MessagesDequeueHeaders	Messages_dequeue操作のヘッダーを定義します。
MessagesDequeueOptionalParams	省略可能なパラメーター。
MessagesEnqueueHeaders	Messages_enqueue操作のヘッダーを定義します。
MessagesEnqueueOptionalParams	省略可能なパラメーター。
MessagesPeekHeaders	Messages_peek操作のヘッダーを定義します。
MessagesPeekOptionalParams	省略可能なパラメーター。
Metadata	キーと値の文字列のペアのコレクション。
Metrics	メトリックを表すインターフェイス。
PeekedMessageItem	Queue で Peek Messages を呼び出すときに QueueMessageList 配列で返されるオブジェクト
PipelineLike	HTTP 要求ポリシーを含む Pipeline クラスのインターフェイス。 newPipeline を呼び出すことで、既定のパイプラインを作成できます。 または、Pipeline のコンストラクターを使用して、独自のポリシーを使用してパイプラインを作成することもできます。 カスタマイズしたパイプラインを実装する前に、 newPipeline と指定されたポリシーを参照してください。
PipelineOptions	パイプライン コンストラクターのオプション インターフェイス。
QueueClearMessagesOptions	clearMessages 操作を構成するためのオプション
QueueCreateHeaders	Queue_create操作のヘッダーを定義します。
QueueCreateIfNotExistsResponse	createIfNotExists 操作の応答データが含まれます。
QueueCreateOptions	作成操作を構成するためのオプション
QueueDeleteHeaders	Queue_delete操作のヘッダーを定義します。
QueueDeleteIfExistsResponse	deleteIfExists 操作の応答データが含まれます。
QueueDeleteMessageOptions	deleteMessage 操作を構成するためのオプション
QueueDeleteOptions	削除操作を構成するためのオプション
QueueExistsOptions	構成するオプション が存在する 操作
QueueGenerateSasUrlOptions	generateSasUrl 操作を構成するためのオプション。
QueueGetAccessPolicyHeaders	Queue_getAccessPolicy操作のヘッダーを定義します。
QueueGetAccessPolicyOptions	getAccessPolicy 操作を構成するためのオプション
QueueGetPropertiesHeaders	Queue_getProperties操作のヘッダーを定義します。
QueueGetPropertiesOptions	getProperties 操作を構成するためのオプション
QueueItem	Azure Storage キュー。
QueuePeekMessagesOptions	peekMessages 操作を構成するためのオプション
QueueReceiveMessageOptions	receiveMessages 操作を構成するためのオプション
QueueSASSignatureValues	NODE.JS ランタイムでのみ使用できます。 QueueSASSignatureValues は、キューのキュー サービス SAS トークンの生成に使用されます。
QueueSendMessageOptions	sendMessage 操作を構成するためのオプション
QueueServiceProperties	ストレージ サービスのプロパティ。
QueueServiceStatistics	ストレージ サービスの統計。
QueueSetAccessPolicyHeaders	Queue_setAccessPolicy操作のヘッダーを定義します。
QueueSetAccessPolicyOptions	setAccessPolicy 操作を構成するためのオプション
QueueSetMetadataHeaders	Queue_setMetadata操作のヘッダーを定義します。
QueueSetMetadataOptions	setMetadata 操作を構成するためのオプション
QueueUpdateMessageOptions	updateMessage 操作を構成するためのオプション
RequestPolicyFactory	core-http の RequestPolicyFactory との互換性のためのインターフェイス
RequestPolicyOptions	RequestPolicy との互換性のためのインターフェイス
ResponseLike	単純な_response プロパティを持つ オブジェクト。
ResponseWithBody	本文とヘッダーが既に既知の型に解析されている_response プロパティを持つ オブジェクト。
ResponseWithHeaders	ヘッダーが既に型指定されたオブジェクトに解析されている_response プロパティを持つ オブジェクト。
RetentionPolicy	アイテム保持ポリシー
SasIPRange	SAS に対して許可される IP 範囲。
ServiceClientOptions	ServiceClientOptions の @azure/core-http サブセット
ServiceGenerateAccountSasUrlOptions	generateAccountSasUrl 操作を構成するためのオプション。
ServiceGetPropertiesHeaders	Service_getProperties操作のヘッダーを定義します。
ServiceGetPropertiesOptions	getProperties 操作を構成するためのオプション
ServiceGetStatisticsHeaders	Service_getStatistics操作のヘッダーを定義します。
ServiceGetStatisticsOptions	getStatistics 操作を構成するためのオプション
ServiceListQueuesOptions	listQueues 操作を構成するためのオプション
ServiceListQueuesSegmentHeaders	Service_listQueuesSegment操作のヘッダーを定義します。
ServiceSetPropertiesHeaders	Service_setProperties操作のヘッダーを定義します。
ServiceSetPropertiesOptions	setProperties 操作を構成するためのオプション
SignedIdentifier	署名付き識別子。
SignedIdentifierModel	署名付き識別子
StoragePipelineOptions	newPipeline 関数のオプション インターフェイス。
StorageRetryOptions	ストレージ BLOB 再試行オプション インターフェイス。
WebResource	リモート サーバーに対して行われる HTTP 要求の説明。

型エイリアス

CredentialPolicyCreator	提供された nextPolicy を使用する新しい CredentialPolicy を作成するファクトリ関数。
GeoReplicationStatusType	GeoReplicationStatusType の値を定義します。
HttpRequestBody	要求でサポートされる本文の種類。 NodeJS.ReadableStream と () => NodeJS.ReadableStream は Node のみです。 BLOB、ReadableStream、および () => ReadableStream はブラウザーのみです。
ListQueuesIncludeType	ListQueuesIncludeType の値を定義します。 使用可能な値は次のとおりです: 'metadata'
MessageIdDeleteResponse	削除操作の応答データが含まれます。
MessageIdUpdateResponse	更新操作の応答データが含まれます。
MessagesClearResponse	クリア操作の応答データが含まれます。
QueueClearMessagesResponse	clearMessages 操作の応答データを格納します。
QueueCreateResponse	作成操作の応答データが含まれます。
QueueDeleteMessageResponse	deleteMessage 操作の応答データが含まれます。
QueueDeleteResponse	削除操作の応答データが含まれます。
QueueGetAccessPolicyResponse	getAccessPolicy 操作の応答データが含まれます。
QueueGetPropertiesResponse	getProperties 操作の応答データが含まれます。
QueuePeekMessagesResponse	peekMessages 操作の応答データを格納します。
QueueReceiveMessageResponse	receiveMessages 操作の応答データを格納します。
QueueSendMessageResponse	sendMessage 操作の応答データを格納します。
QueueSetAccessPolicyResponse	setAccessPolicy 操作の応答データが含まれます。
QueueSetMetadataResponse	setMetadata 操作の応答データが含まれます。
QueueUpdateMessageResponse	updateMessage 操作の応答データが含まれます。
ReceivedMessageItem	receiveMessages を呼び出すときにreceivedMessageItems配列で返される オブジェクト。 参照: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	getProperties 操作の応答データが含まれます。
ServiceGetStatisticsResponse	getStatistics 操作の応答データが含まれます。
ServiceListQueuesSegmentResponse	listQueuesSegment 操作の応答データが含まれます。
ServiceSetPropertiesResponse	setProperties 操作の応答データを格納します。
WithResponse	既知の _response プロパティを持つ操作結果を表す型。

列挙型

SASProtocol	生成された SAS のプロトコル。
StorageQueueAudience	Storage の既知のクラウド 対象ユーザーを定義します。
StorageRetryPolicyType	RetryPolicy 型。

機能

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	NODE.JS ランタイムでのみ使用できます。 実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む SASQueryParameters オブジェクトを生成します。 「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas」を参照してください。
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	NODE.JS ランタイムでのみ使用できます。 SASQueryParameters のインスタンスを作成します。 SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、identifier などの対応するプロパティを直接設定してください。 警告: 識別子が指定されていない場合は、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、識別子または expiresOn & アクセス許可に値を割り当てる必要があります。
getQueueServiceAccountAudience(string)	キュー サービスのストレージ アカウントの OAuth 対象ユーザーを取得するには。
isPipelineLike(unknown)	指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Credential が指定された新しい Pipeline オブジェクトを作成します。

関数の詳細

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

NODE.JS ランタイムでのみ使用できます。

実際の REST 要求を行うために必要なすべての SAS クエリ パラメーターを含む SASQueryParameters オブジェクトを生成します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas」を参照してください。

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

パラメーター

accountSASSignatureValues

AccountSASSignatureValues

アカウントの SAS 署名値

sharedKeyCredential

StorageSharedKeyCredential

共有キーの資格情報。

戻り値

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

NODE.JS ランタイムでのみ使用できます。

SASQueryParameters のインスタンスを作成します。

SAS の作成に必要な設定のみを受け入れます。 オプションの設定については、アクセス許可、startsOn、identifier などの対応するプロパティを直接設定してください。

警告: 識別子が指定されていない場合は、アクセス許可と expiresOn が必要です。 このコンストラクターを最初に使用する場合は、識別子または expiresOn & アクセス許可に値を割り当てる必要があります。

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

パラメーター

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

戻り値

SASQueryParameters

getQueueServiceAccountAudience(string)

キュー サービスのストレージ アカウントの OAuth 対象ユーザーを取得するには。

function getQueueServiceAccountAudience(storageAccountName: string): string

パラメーター

storageAccountName

string

戻り値

string

isPipelineLike(unknown)

指定された引数がパイプライン コントラクトを満たすかどうかを判断するヘルパー

function isPipelineLike(pipeline: unknown): pipeline

パラメーター

pipeline

unknown

パイプラインである可能性がある引数

戻り値

pipeline

引数がパイプライン コントラクトを満たす場合は true

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Credential が指定された新しい Pipeline オブジェクトを作成します。

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

パラメーター

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential、StorageSharedKeyCredential、またはサービスへの要求を @azure/identity 認証するためのパッケージからの任意の資格情報など。 TokenCredential インターフェイスを実装する オブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

pipelineOptions

StoragePipelineOptions

省略可能。 オプション。

戻り値

Pipeline

新しい Pipeline オブジェクト。