queue パッケージ

  • リファレンス

パッケージ

aio

クラス

AccessPolicy

set メソッドと get アクセス ポリシー メソッドで使用されるアクセス ポリシー クラス。

保存されているアクセス ポリシーでは、関連付けられている共有アクセス署名の開始時刻、有効期限、およびアクセス許可を指定できます。 リソースへのアクセスを制御する方法に応じて、格納されているアクセス ポリシー内でこれらのパラメーターをすべて指定し、Shared Access Signature の URL から省略できます。 これにより、関連付けられた署名の動作をいつでも変更または取り消しできます。 また、保存されているアクセス ポリシー内で 1 つ以上のアクセス ポリシー パラメーターを指定し、残りのパラメーターを URL で指定することもできます。 すべてのパラメーターを URL で指定することもできます。 この場合、保存されているアクセス ポリシーを使用して署名を取り消すことができますが、署名の動作を変更することはできません。

共有アクセス署名と保存されているアクセス ポリシーの組み合わせには、署名を認証するために必要なすべてのフィールドが含まれている必要があります。 必須フィールドが欠落している場合、要求は失敗します。 同様に、共有アクセス署名の URL と保存されているアクセス ポリシーの両方で同じフィールドが指定されている場合、ステータス コード 400 (Bad Request) が返されて要求は失敗します。
AccountSasPermissions

ResourceTypes set_*_aclで使用される AccessPolicies とgenerate_account_sas関数で使用される クラス。 リソース へのアクセスを許可するために使用できる SAS には 2 種類あります。 1 つは、特定のリソース (リソース固有) へのアクセス権を付与することです。 もう 1 つは、特定のアカウントのサービス全体へのアクセスを許可し、ここで見つかったパームに基づいて特定の操作を許可することです。
BinaryBase64DecodePolicy

Base 64 でエンコードされたメッセージのメッセージデコード ポリシーをバイト単位で取得します。

base64 でエンコードされたメッセージをバイトにデコードします。 入力コンテンツが有効な base 64 でない場合は、DecodeError が発生します。
BinaryBase64EncodePolicy

バイナリ メッセージの基本 64 メッセージ エンコード ポリシー。

バイナリ メッセージを base 64 にエンコードします。 入力コンテンツがバイトでない場合は、TypeError が発生します。
CorsRule

CORS は、あるドメインで実行されている Web アプリケーションが別のドメイン内にあるリソースにアクセスできるようにする HTTP 機能です。 Web ブラウザーには、Web ページで別のドメインの API を呼び出すことができないようにする同一呼び出し元ポリシーと呼ばれるセキュリティ制限が実装されています。CORS を使用すると、あるドメイン (元のドメイン) から別のドメインの API を安全に呼び出すことができます。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ExponentialRetry

指数再試行。

指数再試行オブジェクトを構築します。 initial_backoffは、最初の再試行に使用されます。 以降の再試行は、initial_backoff + increment_power^retry_count 秒後に再試行されます。
LinearRetry

線形再試行。

Linear 再試行オブジェクトを構築します。
LocationMode

要求の送信先となる場所を指定します。 このモードは、セカンダリ読み取りアクセスを許可する RA-GRS アカウントにのみ適用されます。 他のすべてのアカウントの種類では PRIMARY を使用する必要があります。
Metrics

API 別にグループ化された要求統計の要約 (時間または分単位)。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
QueueAnalyticsLogging

Azure Analytics のログ設定。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
QueueClient

特定のキューと対話するクライアント。

その他のオプション構成については、 こちらをクリックしてください。
QueueMessage

キュー メッセージを表します。
QueueProperties

Queue プロパティ。
QueueSasPermissions

関数で使用される QueueSasPermissions クラスと、 で generate_queue_sas 使用される set_queue_access_policyAccessPolicies 用。
QueueServiceClient

アカウント レベルで Queue Service と対話するクライアント。

このクライアントは、アカウントのプロパティの取得と構成、およびアカウント内のキューの一覧表示、作成、削除を行う操作を提供します。 特定のキューに関連する操作の場合は、 関数を使用してこのエンティティのクライアントを get_queue_client 取得できます。

その他のオプション構成については、 こちらをクリックしてください。
ResourceTypes

アカウント SAS でアクセスできるリソースの種類を指定します。
RetentionPolicy

関連付けられているデータを保持する期間を決定するアイテム保持ポリシー。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
TextBase64DecodePolicy

Base 64 でエンコードされたメッセージのテキストへのメッセージ デコード ポリシー。

base64 でエンコードされたメッセージをテキスト (Unicode) にデコードします。 入力コンテンツが有効な base 64 でない場合は、DecodeError が発生します。 メッセージ データは UTF-8 をサポートしている必要があります。
TextBase64EncodePolicy

テキスト メッセージの基本 64 メッセージ エンコード ポリシー。

テキスト (Unicode) メッセージを base 64 にエンコードします。 入力コンテンツがテキストでない場合は、TypeError が発生します。 入力テキストは UTF-8 をサポートしている必要があります。

列挙型

StorageErrorCode

機能

generate_account_sas

キュー サービスの共有アクセス署名を生成します。

返された署名を、Queue Service の資格情報パラメーターと共に使用します。

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str, start: datetime | str | None = None, ip: str | None = None, **kwargs: Any) -> str

パラメーター

account_name
str
必須

共有アクセス署名の生成に使用されるストレージ アカウント名。

account_key
str
必須

共有アクセス署名を生成するためのアカウント キー (共有キーまたはアクセス キーとも呼ばれます)。

resource_types
ResourceTypes
必須

アカウント SAS でアクセスできるリソースの種類を指定します。

permission
AccountSasPermissions または str
必須

共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。

expiry
datetime または str
必須

共有アクセス署名が無効になる時刻。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。

start
datetime または str
既定値: None

共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。

ip
str
既定値: None

要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip=168.1.5.65 または sip=168.1.5.60-168.1.5.70 を指定すると、要求はこれらの IP アドレスに制限されます。

protocol
str

要求に対して許可されるプロトコルを指定します。 既定値は https です。

戻り値

Shared Access Signature (sas) トークン。

の戻り値の型 :

str

generate_queue_sas

キューの共有アクセス署名を生成します。

返された署名は、任意の Queue Service の credential パラメーターと共に使用します。

generate_queue_sas(account_name: str, queue_name: str, account_key: str, permission: QueueSasPermissions | str | None = None, expiry: datetime | str | None = None, start: datetime | str | None = None, policy_id: str | None = None, ip: str | None = None, **kwargs: Any) -> str

パラメーター

account_name
str
必須

共有アクセス署名の生成に使用されるストレージ アカウント名。

queue_name
str
必須

キューの名前。

account_key
str
必須

共有アクセス署名を生成するためのアカウント キー (共有キーまたはアクセス キーとも呼ばれます)。

permission
QueueSasPermissions または str
既定値: None

共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 このフィールドを含む格納されているアクセス ポリシーを参照するpolicy_idが指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。

expiry
datetime または str
既定値: None

共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照するpolicy_idが指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。

start
datetime または str
既定値: None

共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。

policy_id
str
既定値: None

格納されているアクセス ポリシーに関連付けられる最大 64 文字の一意の値。 格納されているアクセス ポリシーを作成するには、 を使用します set_queue_access_policy。

ip
str
既定値: None

要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip='168.1.5.65' または sip='168.1.5.60-168.1.5.70' を指定すると、要求はこれらの IP アドレスに制限されます。

protocol
str

要求に対して許可されるプロトコルを指定します。 既定値は https です。

戻り値

Shared Access Signature (sas) トークン。

の戻り値の型 :

str

例

sas トークンを生成します。


   from azure.storage.queue import generate_queue_sas
   sas_token = generate_queue_sas(
       queue.account_name,
       queue.queue_name,
       queue.credential.account_key,
       policy_id='my-access-policy-id'
   )