QueueService クラス
これは、キュー リソースを管理するメイン クラスです。
Queue サービスはメッセージを格納します。 キューには無制限の数のメッセージを含めることができます。各メッセージのサイズは最大 64 KB です。 メッセージは通常、キューの末尾に追加され、キューの先頭から取得されます。ただし、先入れ先出し (FIFO: first in, first out) 動作は保証されません。
:type ~azure.storage.common.TokenCredential
- 継承
-
QueueService
コンストラクター
QueueService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None, token_credential=None)パラメーター
- account_name
- str
ストレージ アカウント名。 これは、アカウント キーで署名された要求を認証し、ストレージ エンドポイントを構築するために使用されます。 接続文字列が指定されていない限り、これは必須です。
- sas_token
- str
アカウント キーの代わりに要求を認証するために使用する共有アクセス署名トークン。 アカウント キーと sas トークンの両方が指定されている場合は、アカウント キーを使用して署名します。
- is_emulated
- bool
エミュレーターを使用するかどうか。 既定値は False です。 を指定すると、接続文字列および要求セッション以外の他のすべてのパラメーターがオーバーライドされます。
- endpoint_suffix
- str
URL のホスト ベース コンポーネントからアカウント名を差し引いた値。 既定値は Azure (core.windows.net)。 これをオーバーライドして China クラウド (core.chinacloudapi.cn) を使用します。
- request_session
- <xref:requests.Session>
http 要求に使用するセッション オブジェクト。
- connection_string
- str
指定すると、要求セッション以外の他のすべてのパラメーターがオーバーライドされます。 接続文字列形式については、「」を参照してくださいhttp://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/。
- socket_timeout
- int
指定すると、既定のソケット タイムアウトがオーバーライドされます。 指定されたタイムアウトは秒単位です。 既定値については、「_constants.py のDEFAULT_SOCKET_TIMEOUT」を参照してください。
- token_credential
HTTPS 要求の認証に使用されるトークン資格情報。 トークン値は、有効期限の前に更新する必要があります。
変数
- encode_function
- <xref:function>(<xref:data>)
キュー メッセージをエンコードするために使用される関数。 パラメーターとして、put_message API に渡されたデータを受け取り、エンコードされたメッセージを返します。 既定ではテキストと xml エンコードを受け取りますが、バイトやその他のエンコードを使用できます。 たとえば、異なる言語で複数の Azure Storage ライブラリ間で開発する場合は、base64 が適している場合があります。 QueueMessageFormat xml、base64、およびエンコード メソッドなしとバイナリ同等の については、 を参照してください。
- decode_function
- <xref:function>(<xref:data>)
デコード メッセージをエンコードするために使用される関数。 パラメーターとして、get_messages および peek_messages API によって返されるデータを受け取り、デコードされたメッセージを返します。 既定値はテキストと xml デコードを返しますが、バイトやその他のデコードを使用できます。 たとえば、異なる言語で複数の Azure Storage ライブラリ間で開発する場合は、base64 が適している場合があります。 QueueMessageFormat xml、base64、デコード メソッドなし、バイナリ同等物については、 を参照してください。
- key_encryption_key
- object
ユーザーが必要に応じて提供する key-encryption-key。 指定した場合は、 を使用して、サポートされているメソッドで暗号化/暗号化解除を行います。 復号化を必要とするメソッドの場合は、key_encryption_keyまたはリゾルバーを指定する必要があります。 両方を指定すると、競合回避モジュールが優先されます。 暗号化を必要とする API には、次のメソッドを実装する必要があります。wrap_key(key)、ユーザーが選択したアルゴリズムを使用して、指定したキー (バイト) をラップします。 暗号化されたキーをバイトとして返します。 get_key_wrap_algorithm()は、指定した対称キーをラップするために使用されるアルゴリズムを返します。 get_kid()は、このキー暗号化キーの文字列キー ID を返します。 復号化を必要とする API には、次のメソッドを実装する必要があります。unwrap_key(key, algorithm):文字列指定アルゴリズムを使用して、指定された対称キーのラップされていない形式を返します。 get_kid()は、このキー暗号化キーの文字列キー ID を返します。
- key_resolver_function
- kid) (<xref:function>
必要に応じてユーザーが提供するキーを解決する関数。 指定した場合は、 を使用して、サポートされているメソッドで暗号化を解除します。 復号化を必要とするメソッドの場合は、key_encryption_keyまたはリゾルバーを指定する必要があります。 両方を指定すると、競合回避モジュールが優先されます。 kid 文字列を使用して、上記で定義したインターフェイスを実装するキー暗号化キーを返します。
- require_encryption
- bool
すべてのメッセージがキューに正常にアップロードされ、ダウンロードされ、キューから正常に読み取られるすべてのメッセージが、サーバー上で暗号化されていることを確認するために設定できるフラグ。 このフラグが設定されている場合は、暗号化/暗号化解除に必要なすべてのパラメーターを指定する必要があります。 key_encryption_keyと競合回避モジュールについては、上記のコメントを参照してください。
メソッド
| clear_messages |
指定したキューからすべてのメッセージを削除します。 |
| create_queue |
指定されたアカウントの下にキューを作成します。 |
| delete_message |
指定したメッセージを削除します。 通常、クライアントがget_messages操作でメッセージを取得した後、クライアントはメッセージの処理と削除を行う必要があります。 メッセージを削除するには、id とpop_receiptの 2 つのデータ項目が必要です。 ID は、前のget_messages操作から返されます。 pop_receiptは、最新 get_messages の または update_message 操作から返されます。 delete_message操作を成功させるには、要求で指定されたpop_receiptが、 または update_message 操作からget_messages返されるpop_receiptと一致する必要があります。 |
| delete_queue |
指定したキューとそのキューに含まれるすべてのメッセージを削除します。 キューが正常に削除されると、キューはすぐに削除対象としてマークされ、クライアントからアクセスできなくなります。 このキューは、後でガベージ コレクション中にキュー サービスから削除されます。 キューの削除が完了するまでに少なくとも 40 秒かかる可能性があることに注意してください。 削除中にキューに対して操作が試行されると、 <xref:azure.storage.queue.queueservice.AzureConflictHttpError> がスローされます。 |
| exists |
キューが存在するかどうかを示すブール値を返します。 |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
キュー サービスの共有アクセス署名を生成します。 返されたシグネチャは、QueueService の sas_token パラメーターと共に使用します。 |
| generate_queue_shared_access_signature |
キューの共有アクセス署名を生成します。 返されたシグネチャは、QueueService の sas_token パラメーターと共に使用します。 |
| get_messages |
キューの先頭から 1 つ以上のメッセージを取得します。 メッセージがキューから取得されると、応答にはメッセージの内容とメッセージを削除するために必要なpop_receipt値が含まれます。 メッセージはキューから自動的に削除されませんが、メッセージが取得された後、visibility_timeout パラメーターで指定された時間間隔で他のクライアントに表示されません。 キー暗号化キーまたはリゾルバー フィールドがローカル サービス オブジェクトに設定されている場合、メッセージは返される前に復号化されます。 |
| get_queue_acl |
Shared Access Signature で使用できるキューで指定された格納されているアクセス ポリシーの詳細を返します。 |
| get_queue_metadata |
指定したキューのユーザー定義メタデータとキュー プロパティを取得します。 メタデータは、名前と値のペアとしてキューに関連付けられます。 |
| get_queue_service_properties |
ログ記録、分析、CORS ルールなど、ストレージ アカウントの Queue サービスのプロパティを取得します。 |
| get_queue_service_stats |
キュー サービスのレプリケーションに関連する統計情報を取得します。 これは、ストレージ アカウントに対して読み取りアクセス geo 冗長レプリケーションが有効になっている場合にのみ使用できます。 地理冗長レプリケーションでは、Azure ストレージによって 2 か所でデータの持続性が維持されます。 両方の場所で、Azure ストレージは継続的にデータの複数の正常なレプリカを維持します。 データの読み取り、作成、更新、または削除を行う場所は、1 次ストレージ アカウント拠点です。 プライマリの場所は、Azure Management Azure クラシック ポータル (米国中北部など) を使用してアカウントを作成するときに選択したリージョンに存在します。 データのレプリケート先の場所が、2 次拠点です。 2 次拠点は 1 次拠点の場所に基づいて自動的に決められ、1 次拠点と同じ地域にある 2 つ目のデータ センター内に設定されます。 読み取りアクセスの地理冗長レプリケーションがストレージ アカウントで有効な場合は、2 次拠点から読み取り専用アクセスを使用できます。 |
| list_queues |
キューを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのキューが返されるか、num_resultsに達したときに停止します。 num_resultsが指定され、アカウントにキューの数を超える数が含まれている場合、ジェネレーターには、完了すると、next_marker フィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。 |
| peek_messages |
キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。 表示されているメッセージのみを取得できます。 get_messagesの呼び出しで初めてメッセージを取得すると、そのdequeue_count プロパティは 1 に設定されます。 削除されず、その後再度取得された場合は、dequeue_count プロパティがインクリメントされます。 クライアントはこの値を使用して、メッセージが取得された回数を確認できます。 peek_messagesの呼び出しは DequeueCount の値をインクリメントしませんが、クライアントが読み取るためにこの値を返します。 キー暗号化キーまたはリゾルバー フィールドがローカル サービス オブジェクトに設定されている場合、メッセージは返される前に復号化されます。 |
| put_message |
メッセージ キューの背面に新しいメッセージを追加します。 可視性のタイムアウトは、メッセージが非表示になる時間を指定します。 タイムアウトになったら、メッセージが表示されるようになります。 表示タイムアウトを指定していない場合、既定値の 0 が使用されます。 メッセージの有効期間は、メッセージがキューに残る期間を指定します。 有効期限が切れると、メッセージがキューから削除されます。 key-encryption-key フィールドがローカル サービス オブジェクトに設定されている場合、このメソッドはアップロードする前にコンテンツを暗号化します。 |
| set_proxy |
HTTP CONNECT トンネリングのプロキシ サーバー ホストとポートを設定します。 |
| set_queue_acl |
共有アクセス署名で使用できるキューの保存されているアクセス ポリシーを設定します。 キューのアクセス許可を設定すると、既存のアクセス許可が置き換えられます。 キューのアクセス許可を更新するには、 を呼び出 get_queue_acl して、キューに関連付けられているすべてのアクセス ポリシーをフェッチし、変更するアクセス ポリシーを変更してから、更新を実行するデータの完全なセットでこの関数を呼び出します。 保存されているアクセス ポリシーをキューに設定したときには、有効になるまでに最大で 30 秒かかる場合があります。 この間、格納されているアクセス ポリシーに関連付けられている共有アクセス署名は、アクセス ポリシーがアクティブになるまで を <xref:azure.storage.queue.queueservice.AzureHttpError> スローします。 |
| set_queue_metadata |
指定したキューにユーザー定義メタデータを設定します。 メタデータは、名前と値のペアとしてキューに関連付けられます。 |
| set_queue_service_properties |
Azure Storage Analyticsを含むストレージ アカウントの Queue サービスのプロパティを設定します。 要素 (ログ記録など) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。 Azure Storage Analyticsの詳細については、「」を参照してくださいhttps://msdn.microsoft.com/en-us/library/azure/hh343270.aspx。 |
| update_message |
メッセージの可視性タイムアウトを更新します。 この操作を使用して、メッセージの内容を更新することもできます。 この操作を使用すると、キュー メッセージの非表示を継続的に拡張できます。 この機能は、ワーカー ロールでキュー メッセージを "リース" する場合に便利です。 たとえば、ワーカー ロールが get_messages を呼び出し、メッセージの処理にさらに時間が必要であると認識した場合、処理されるまでメッセージの非表示を継続的に拡張できます。 処理中にワーカー ロールでエラーが発生しても、最終的にはメッセージが再び参照できるようになるため、別のワーカー ロールがその処理を行うことができます。 key-encryption-key フィールドがローカル サービス オブジェクトに設定されている場合、このメソッドはアップロードする前にコンテンツを暗号化します。 |
clear_messages
指定したキューからすべてのメッセージを削除します。
clear_messages(queue_name, timeout=None)パラメーター
create_queue
指定されたアカウントの下にキューを作成します。
create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)パラメーター
- queue_name
- str
作成するキューの名前。 キュー名は 3 から 63 文字の長さにする必要があり、小文字、数字、ダッシュ (-) 文字のみを使用できます。 キューの最初と最後の文字は英数字である必要があります。 ダッシュ (-) 文字は最初の文字にすることも最後の文字にすることもできません。 キュー名で、ダッシュ文字を連続して使用することはできません。
メタデータとしてキューに関連付ける名前と値のペアを含む dict。 メタデータ名の作成時に指定された大文字と小文字の違いは維持されますが、設定時または読み取り時には大文字と小文字は区別されません。
戻り値
キューが作成されたかどうかを示すブール値。 fail_on_existが True に設定されている場合、false を返す代わりに がスローされます。
の戻り値の型 :
delete_message
指定したメッセージを削除します。
通常、クライアントがget_messages操作でメッセージを取得した後、クライアントはメッセージの処理と削除を行う必要があります。 メッセージを削除するには、id とpop_receiptの 2 つのデータ項目が必要です。 ID は、前のget_messages操作から返されます。 pop_receiptは、最新 get_messages の または update_message 操作から返されます。 delete_message操作を成功させるには、要求で指定されたpop_receiptが、 または update_message 操作からget_messages返されるpop_receiptと一致する必要があります。
delete_message(queue_name, message_id, pop_receipt, timeout=None)パラメーター
delete_queue
指定したキューとそのキューに含まれるすべてのメッセージを削除します。
キューが正常に削除されると、キューはすぐに削除対象としてマークされ、クライアントからアクセスできなくなります。 このキューは、後でガベージ コレクション中にキュー サービスから削除されます。
キューの削除が完了するまでに少なくとも 40 秒かかる可能性があることに注意してください。 削除中にキューに対して操作が試行されると、 <xref:azure.storage.queue.queueservice.AzureConflictHttpError> がスローされます。
delete_queue(queue_name, fail_not_exist=False, timeout=None)パラメーター
戻り値
キューが削除されたかどうかを示すブール値。 fail_not_existが True に設定されている場合、false を返す代わりに がスローされます。
の戻り値の型 :
exists
キューが存在するかどうかを示すブール値を返します。
exists(queue_name, timeout=None)パラメーター
戻り値
キューが存在するかどうかを示すブール値。
の戻り値の型 :
extract_date_and_request_id
static extract_date_and_request_id(retry_context)パラメーター
- retry_context
generate_account_shared_access_signature
キュー サービスの共有アクセス署名を生成します。 返されたシグネチャは、QueueService の sas_token パラメーターと共に使用します。
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)パラメーター
- resource_types
- <xref:ResourceTypes>
アカウント SAS でアクセスできるリソースの種類を指定します。
- permission
- <xref:AccountPermissions>
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip=168.1.5.65 または sip=168.1.5.60-168.1.5.70 を指定すると、それらの IP アドレスに要求が制限されます。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_queue_shared_access_signature
キューの共有アクセス署名を生成します。 返されたシグネチャは、QueueService の sas_token パラメーターと共に使用します。
generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)パラメーター
- permission
- QueuePermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- id
- str
格納されているアクセス ポリシーに関連付けられる最大 64 文字の一意の値。 格納されているアクセス ポリシーを作成するには、 を使用します set_queue_acl。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip='168.1.5.65' または sip='168.1.5.60-168.1.5.70' を指定すると、要求はこれらの IP アドレスに制限されます。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
get_messages
キューの先頭から 1 つ以上のメッセージを取得します。
メッセージがキューから取得されると、応答にはメッセージの内容とメッセージを削除するために必要なpop_receipt値が含まれます。 メッセージはキューから自動的に削除されませんが、メッセージが取得された後、visibility_timeout パラメーターで指定された時間間隔で他のクライアントに表示されません。
キー暗号化キーまたはリゾルバー フィールドがローカル サービス オブジェクトに設定されている場合、メッセージは返される前に復号化されます。
get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)パラメーター
- num_messages
- int
キューから取得するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 表示できるメッセージの数が指定された数よりも少ない場合は、表示できるメッセージが返されます。 既定では、この操作によってキューから 1 つのメッセージが取得されます。
- visibility_timeout
- int
サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は 1 秒以上である必要があり、7 日を超えることはできません。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。
戻り値
QueueMessage渡された情報を表す オブジェクト。
の戻り値の型 :
get_queue_acl
Shared Access Signature で使用できるキューで指定された格納されているアクセス ポリシーの詳細を返します。
get_queue_acl(queue_name, timeout=None)パラメーター
戻り値
キューに関連付けられているアクセス ポリシーのディクショナリ。
の戻り値の型 :
get_queue_metadata
指定したキューのユーザー定義メタデータとキュー プロパティを取得します。 メタデータは、名前と値のペアとしてキューに関連付けられます。
get_queue_metadata(queue_name, timeout=None)パラメーター
戻り値
キュー内のメッセージ数を推定する dict の approximate_message_count int プロパティを持つキュー メタデータを表すディクショナリ。
の戻り値の型 :
get_queue_service_properties
ログ記録、分析、CORS ルールなど、ストレージ アカウントの Queue サービスのプロパティを取得します。
get_queue_service_properties(timeout=None)パラメーター
戻り値
Queue サービスのプロパティです。
の戻り値の型 :
get_queue_service_stats
キュー サービスのレプリケーションに関連する統計情報を取得します。 これは、ストレージ アカウントに対して読み取りアクセス geo 冗長レプリケーションが有効になっている場合にのみ使用できます。
地理冗長レプリケーションでは、Azure ストレージによって 2 か所でデータの持続性が維持されます。 両方の場所で、Azure ストレージは継続的にデータの複数の正常なレプリカを維持します。 データの読み取り、作成、更新、または削除を行う場所は、1 次ストレージ アカウント拠点です。 プライマリの場所は、Azure Management Azure クラシック ポータル (米国中北部など) を使用してアカウントを作成するときに選択したリージョンに存在します。 データのレプリケート先の場所が、2 次拠点です。 2 次拠点は 1 次拠点の場所に基づいて自動的に決められ、1 次拠点と同じ地域にある 2 つ目のデータ センター内に設定されます。 読み取りアクセスの地理冗長レプリケーションがストレージ アカウントで有効な場合は、2 次拠点から読み取り専用アクセスを使用できます。
get_queue_service_stats(timeout=None)パラメーター
戻り値
Queue サービスの統計情報です。
の戻り値の型 :
list_queues
キューを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのキューが返されるか、num_resultsに達したときに停止します。
num_resultsが指定され、アカウントにキューの数を超える数が含まれている場合、ジェネレーターには、完了すると、next_marker フィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。
list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)パラメーター
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトのnext_marker フィールドから取得できますnum_resultsが指定され、そのジェネレーターが結果の列挙を完了した場合です。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントから結果の返しを開始します。
- timeout
- int
秒単位で表されるサーバー タイムアウト。 この関数は、サービスに対して複数の呼び出しを行う場合があります。その場合、指定されたタイムアウト値が個々の呼び出しに適用されます。
peek_messages
キューの先頭から 1 つ以上のメッセージを取得しますが、メッセージの可視性は変更しません。
表示されているメッセージのみを取得できます。 get_messagesの呼び出しで初めてメッセージを取得すると、そのdequeue_count プロパティは 1 に設定されます。 削除されず、その後再度取得された場合は、dequeue_count プロパティがインクリメントされます。 クライアントはこの値を使用して、メッセージが取得された回数を確認できます。 peek_messagesの呼び出しは DequeueCount の値をインクリメントしませんが、クライアントが読み取るためにこの値を返します。
キー暗号化キーまたはリゾルバー フィールドがローカル サービス オブジェクトに設定されている場合、メッセージは返される前に復号化されます。
peek_messages(queue_name, num_messages=None, timeout=None)パラメーター
- num_messages
- int
キューから表示するメッセージの数を示すゼロ以外の整数値を指定します (上限は 32 件)。 既定では、この操作でキューから 1 件のメッセージが表示されます。
戻り値
QueueMessage オブジェクトのリスト。 ピークはメッセージをポップせず、既に表示されているメッセージのみを取得できるため、time_next_visibleとpop_receiptは設定されないことに注意してください。
の戻り値の型 :
put_message
メッセージ キューの背面に新しいメッセージを追加します。
可視性のタイムアウトは、メッセージが非表示になる時間を指定します。 タイムアウトになったら、メッセージが表示されるようになります。 表示タイムアウトを指定していない場合、既定値の 0 が使用されます。
メッセージの有効期間は、メッセージがキューに残る期間を指定します。 有効期限が切れると、メッセージがキューから削除されます。
key-encryption-key フィールドがローカル サービス オブジェクトに設定されている場合、このメソッドはアップロードする前にコンテンツを暗号化します。
put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)パラメーター
- content
- <xref:obj>
メッセージの内容。 許可される型は、サービスで設定されたencode_functionによって決まります。 既定値は str です。 エンコードされたメッセージのサイズは最大 64 KB です。
- visibility_timeout
- int
値を指定しない場合は、既定値 0 が使用されます。 サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 値は 0 以上である必要があり、7 日を超えることはできません。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 visibility_timeoutは、有効期間の値より小さい値に設定する必要があります。
- time_to_live
- int
メッセージの有効期限を秒単位で指定します。 有効期間は、任意の正の数、または無限大の場合は -1 にすることができます。 このパラメーターが省略されている場合、既定の有効期限は 7 日です。
戻り値
QueueMessage オブジェクト。 このオブジェクトにはコンテンツも設定されますが、サービスから返されません。
の戻り値の型 :
set_proxy
HTTP CONNECT トンネリングのプロキシ サーバー ホストとポートを設定します。
set_proxy(host, port, user=None, password=None)パラメーター
set_queue_acl
共有アクセス署名で使用できるキューの保存されているアクセス ポリシーを設定します。
キューのアクセス許可を設定すると、既存のアクセス許可が置き換えられます。 キューのアクセス許可を更新するには、 を呼び出 get_queue_acl して、キューに関連付けられているすべてのアクセス ポリシーをフェッチし、変更するアクセス ポリシーを変更してから、更新を実行するデータの完全なセットでこの関数を呼び出します。
保存されているアクセス ポリシーをキューに設定したときには、有効になるまでに最大で 30 秒かかる場合があります。 この間、格納されているアクセス ポリシーに関連付けられている共有アクセス署名は、アクセス ポリシーがアクティブになるまで を <xref:azure.storage.queue.queueservice.AzureHttpError> スローします。
set_queue_acl(queue_name, signed_identifiers=None, timeout=None)パラメーター
- signed_identifiers
- dict(str, AccessPolicy)
キューに関連付けるアクセス ポリシーのディクショナリ。 ディクショナリには、最大 5 つの要素を含めることができます。 空のディクショナリを使用すると、サービスに設定されているアクセス ポリシーがクリアされます。
set_queue_metadata
指定したキューにユーザー定義メタデータを設定します。 メタデータは、名前と値のペアとしてキューに関連付けられます。
set_queue_metadata(queue_name, metadata=None, timeout=None)パラメーター
set_queue_service_properties
Azure Storage Analyticsを含むストレージ アカウントの Queue サービスのプロパティを設定します。 要素 (ログ記録など) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。 Azure Storage Analyticsの詳細については、「」を参照してくださいhttps://msdn.microsoft.com/en-us/library/azure/hh343270.aspx。
set_queue_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)パラメーター
- logging
- <xref:Logging>
ログ設定では、要求ログが提供されます。
- hour_metrics
- <xref:Metrics>
時間メトリック設定では、API 別にグループ化された要求統計の概要が、キューの時間単位の集計で示されます。
- minute_metrics
- <xref:Metrics>
分単位のメトリック設定では、キューの 1 分ごとの要求統計が提供されます。
- cors
- list(CorsRule)
リストには、最大 5 つの CorsRule 要素を含めることができます。 空のリストを指定すると、すべての CORS ルールが削除され、サービスに対して CORS が無効になります。 CORS ルールと評価ロジックの詳細については、「https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx」を参照してください。
update_message
メッセージの可視性タイムアウトを更新します。 この操作を使用して、メッセージの内容を更新することもできます。
この操作を使用すると、キュー メッセージの非表示を継続的に拡張できます。 この機能は、ワーカー ロールでキュー メッセージを "リース" する場合に便利です。 たとえば、ワーカー ロールが get_messages を呼び出し、メッセージの処理にさらに時間が必要であると認識した場合、処理されるまでメッセージの非表示を継続的に拡張できます。 処理中にワーカー ロールでエラーが発生しても、最終的にはメッセージが再び参照できるようになるため、別のワーカー ロールがその処理を行うことができます。
key-encryption-key フィールドがローカル サービス オブジェクトに設定されている場合、このメソッドはアップロードする前にコンテンツを暗号化します。
update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)パラメーター
- visibility_timeout
- int
サーバー時間を基準に、新しい表示タイムアウト値を秒単位で指定します。 新しい値は、0 以上の 7 日を超えない値である必要があります。 メッセージの表示タイムアウト値は、有効期限より後の値に設定できます。 メッセージは、削除されるか有効期限が切れるまで更新できます。
- content
- <xref:obj>
メッセージの内容。 許可される型は、サービスで設定されたencode_functionによって決まります。 既定値は str です。
戻り値
QueueMessage オブジェクトのリスト。 便宜上、このオブジェクトにはコンテンツも設定されますが、サービスからは返されません。
の戻り値の型 :
属性
protocol
request_session
socket_timeout
Azure SDK for Python
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示