QueueSharedAccessSignature クラス

  • リファレンス

共通のアカウント名とアカウント キーを使用して、キュー共有アクセス署名トークンを作成するためのファクトリを提供します。 ユーザーはファクトリを使用するか、適切なサービスを構築し、generate_*_shared_access_signature メソッドを直接使用できます。

継承
SharedAccessSignature
QueueSharedAccessSignature

コンストラクター

QueueSharedAccessSignature(account_name, account_key)

パラメーター

account_name
str
必須

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

account_key
str
必須

共有アクセス署名を生成するアクセス キー。

メソッド

generate_account

アカウントの共有アクセス署名を生成します。 返された署名をサービスの sas_token パラメーターと共に使用するか、新しいアカウント オブジェクトを作成します。
generate_queue

キューの共有アクセス署名を生成します。 返されたシグネチャは、QueueService の sas_token パラメーターと共に使用します。

generate_account

アカウントの共有アクセス署名を生成します。 返された署名をサービスの sas_token パラメーターと共に使用するか、新しいアカウント オブジェクトを作成します。

generate_account(services, resource_types, permission, expiry, start=None, ip=None, protocol=None)

パラメーター

services
<xref:Services>
必須

アカウント SAS でアクセスできるサービスを指定します。 値を組み合わせて、複数のサービスへのアクセスを提供できます。

resource_types
<xref:ResourceTypes>
必須

アカウント SAS でアクセスできるリソースの種類を指定します。 値を組み合わせて、複数のリソース タイプへのアクセスを提供できます。

permission
<xref:AccountPermissions>
必須

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

expiry
datetime または str
必須

共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 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
既定値: None

要求に対して許可されるプロトコルを指定します。 既定値は https,http です。 指定できる値については、「Protocol」を参照してください。

generate_queue

キューの共有アクセス署名を生成します。 返されたシグネチャは、QueueService の sas_token パラメーターと共に使用します。

generate_queue(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)

パラメーター

queue_name
str
必須

キューの名前。

permission
QueuePermissions
既定値: None

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

expiry
datetime または str
既定値: None

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

start
datetime または str
既定値: None

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

id
str
既定値: None

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

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
既定値: None

要求に対して許可されるプロトコルを指定します。 既定値は https,http です。 指定できる値については、「Protocol」を参照してください。