@azure/storage-queue package

クラス

AccountSASPermissions	NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によって付与されるアクセス許可を表す文字列を作成するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、その操作に対するアクセス許可が付与されます。 すべての値が設定されたら、これを toString でシリアル化し、 AccountSASSignatureValues オブジェクトのアクセス許可フィールドとして設定する必要があります。 このクラスを使用せずにアクセス許可文字列を作成することはできますが、アクセス許可の順序は特定であり、このクラスは正確性を保証します。
AccountSASResourceTypes	NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なリソースを表す文字列を構築するためのヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのリソースの種類へのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、 AccountSASSignatureValues オブジェクトの resources フィールドとして設定する必要があります。 このクラスを使用せずにリソース文字列を構築することはできますが、リソースの順序は特定であり、このクラスは正確性を保証します。
AccountSASServices	NODE.JS ランタイムでのみ使用できます。 これは、AccountSAS によってアクセス可能なサービスを表す文字列を作成するヘルパー クラスです。 値を true に設定すると、これらのアクセス許可を使用するすべての SAS によって、そのサービスへのアクセスが許可されます。 すべての値が設定されたら、これを toString でシリアル化し、 AccountSASSignatureValues オブジェクトのサービス フィールドとして設定する必要があります。 このクラスを使用せずにサービス文字列を構築することはできますが、サービスの順序は特定であり、このクラスは正確性を保証します。
AnonymousCredential	AnonymousCredential には、 AnonymousCredentialPolicy オブジェクトの作成に使用 される CredentialPolicyCreator メンバーが用意されています 。 AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求、または Shared Access Signature (SAS) で使用するために使用されます。
AnonymousCredentialPolicy	AnonymousCredentialPolicy は、パブリック リソースを読み取る HTTP(S) 要求、または Shared Access Signature (SAS) で使用するために使用されます。
BaseRequestPolicy	すべての要求ポリシーの派生元となる基本クラス。
Credential	資格情報は、Azure Storage HTTP 要求署名の抽象クラスです。 このクラスは、CredentialPolicy を生成する credentialPolicyCreator ファクトリをホストします。
CredentialPolicy	送信前に HTTP(S) 要求に署名するために使用される資格情報ポリシー。 これは抽象クラスです。
HttpHeaders	HTTP ヘッダーのキーと値のペアのコレクション。
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 を表します。
RequestPolicyOptions	RequestPolicy の作成時に使用できる省略可能なプロパティ。
RestError	サービス エンドポイントへの HTTP 要求の結果として発生するエラー。
SASQueryParameters	Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されません。 AccountSASSignatureValues 型と QueueSASSignatureValues 型によってのみ生成されます。 生成されると、 に toString() エンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これは、これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは変更できません。
StorageBrowserPolicy	StorageBrowserPolicy は、Node.js とブラウザー ランタイムの違いを処理します。これには次が含まれます。 ブラウザーは、"IF_MODIFIED_SINCE" などの条件付きヘッダーを追加することで、GET/HEAD 要求をキャッシュします。 StorageBrowserPolicy は、GET/HEAD 要求 URL にタイムスタンプ クエリを追加するために使用されるポリシーであるため、ブラウザー キャッシュを回避します。 セキュリティのために Cookie ヘッダーを削除する ブラウザーの警告を回避するためにコンテンツ長ヘッダーを削除する
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory は、 StorageBrowserPolicy オブジェクトの生成を支援するファクトリ クラスです。
StorageRetryPolicy	指数再試行と線形再試行が実装された再試行ポリシー。
StorageRetryPolicyFactory	StorageRetryPolicyFactory は、 StorageRetryPolicy オブジェクトの生成を支援するファクトリ クラスです。
StorageSharedKeyCredential	NODE.JS ランタイムでのみ使用できます。 Azure Storage サービスのアカウント キー承認用の StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy は、共有キーを使用して HTTP 要求に署名するために使用されるポリシーです。
WebResource	新しい WebResource オブジェクトを作成します。 このクラスは、ライブラリ/実装に依存せず、要求を開始するために必要なプロパティをラップすることで、REST 呼び出しを抽象化します。

インターフェイス

AccessPolicy	アクセス ポリシー
AccountSASSignatureValues	NODE.JS ランタイムでのみ使用できます。 AccountSASSignatureValues は、Azure Storage アカウントの Shared Access Signature (SAS) を生成するために使用されます。 ここでのすべての値が適切に設定されたら、 を呼び出して generateSASQueryParameters() を呼び出して、実際にキュー URL に適用できる SAS の表現を取得します。 注: 前者は変更可能であり、論理表現であるのに対し、後者は不変であり、実際の REST 要求を生成するために使用されるため、このクラスと SASQueryParameters の両方が存在します。 https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 SAS の概念の詳細については、パラメーターの説明 (必須を含む) を参照してください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	Queue で Put Message を呼び出すときに QueueMessageList 配列で返されるオブジェクト
GeoReplication	セカンダリ ストレージ サービスの Geo-Replication 情報
HttpOperationResponse	http 要求と応答のラッパー オブジェクト。 逆シリアル化されたオブジェクトは、応答本文が JSON または XML で parsedBody 受信されると、 プロパティに格納されます。
IHttpClient	HttpRequests を送信し、約束された HttpResponses を受信できるインターフェイス。
ListQueuesSegmentResponse	Queue Service で 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 でメッセージを呼び出すときに QueueMessageList 配列プレビュー返されるオブジェクト
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 操作を構成するためのオプション
RequestPolicy	要求ポリシーの基になる構造。
RetentionPolicy	アイテム保持ポリシー
SasIPRange	SAS に対して許可される IP 範囲。
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	ストレージ キューの再試行オプション インターフェイス。

型エイリアス

CredentialPolicyCreator	指定された nextPolicy を使用する新しい CredentialPolicy を作成するファクトリ関数。
GeoReplicationStatusType	GeoReplicationStatusType の値を定義します。
HttpRequestBody	使用可能な HTTP 要求本文の種類
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
RequestPolicyFactory	指定された nextPolicy を使用する要求ごとに新しい RequestPolicy を作成します。
ServiceGetPropertiesResponse	getProperties 操作の応答データを格納します。
ServiceGetStatisticsResponse	getStatistics 操作の応答データを格納します。
ServiceListQueuesSegmentResponse	listQueuesSegment 操作の応答データを格納します。
ServiceSetPropertiesResponse	setProperties 操作の応答データを格納します。

列挙型

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

機能

deserializationPolicy(DeserializationContentTypes, SerializerOptions)	HTTP パイプラインを通過する際に HTTP 要求本文をシリアル化する新しいシリアル化 RequestPolicyCreator を作成します。
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 が必要です。 このコンストラクターを最初に使用する場合は、値を identifier または expiresOn & アクセス許可に手動で割り当てる必要があります。
getQueueServiceAccountAudience(string)
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	資格情報が指定された新しい Pipeline オブジェクトを作成します。

関数の詳細

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

HTTP パイプラインを通過する際に HTTP 要求本文をシリアル化する新しいシリアル化 RequestPolicyCreator を作成します。

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

パラメーター

deserializationContentTypes

DeserializationContentTypes

parsingOptions

SerializerOptions

戻り値

RequestPolicyFactory

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 が必要です。 このコンストラクターを最初に使用する場合は、値を identifier または expiresOn & アクセス許可に手動で割り当てる必要があります。

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

パラメーター

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

戻り値

SASQueryParameters

getQueueServiceAccountAudience(string)

function getQueueServiceAccountAudience(storageAccountName: string): string

パラメーター

storageAccountName

string

戻り値

string

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

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

パラメーター

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions

StoragePipelineOptions

オプション。

戻り値

Pipeline

新しい Pipeline オブジェクト。