SASQueryParameters class

リファレンス

パッケージ:: @azure/storage-file-datalake

Azure Storage SAS のクエリパラメーターを構成するコンポーネントを表します。この型は、ユーザーによって直接構築されません。 AccountSASSignatureValues と <xref:BlobSASSignatureValues> 型によってのみ生成されます。生成されると、に toString() エンコードして URL に直接追加できます (ただし、既存のクエリパラメーターがある場合は注意が必要です。これは、これらのクエリパラメーターを追加する適切な方法に影響する可能性があります)。

注: このクラスのインスタンスは変更できません。

コンストラクター

SASQueryParameters(string, string, SASQueryParametersOptions)	SASQueryParameters のインスタンスを作成します。
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)	SASQueryParameters のインスタンスを作成します。

プロパティ

agentObjectId	GUID 形式の未承認の AAD オブジェクト ID。ユーザー委任キーの所有者によって承認されていないと見なされるユーザーの AAD オブジェクト ID。 Azure Storage Service は、要求された操作の実行がユーザーに許可されているかどうかを判断するために、追加の POSIX ACL チェックを実行します。これは、と <xref:signedAuthorizedUserObjectId>一緒に使用することはできません。これは、ユーザー委任 SAS でのみ使用されます。
cacheControl	Blob/File Service SAS のキャッシュ制御ヘッダーの値。
contentDisposition	Blob/File Service SAS の content-disposition ヘッダーの値。
contentEncoding	Blob/File Service SAS のコンテンツエンコードヘッダーの値。
contentLanguage	Blob/File Service SAS の content-length ヘッダーの値。
contentType	Blob/File Service SAS の content-type ヘッダーの値。
correlationId	ストレージ診断ログに記録され、SAS 生成とストレージリソースアクセスを関連付けるために使用できる GUID 値。これは、ユーザー委任 SAS でのみ使用されます。
directoryDepth	string-to-sign の canonicalizedresource フィールドで指定されたディレクトリの深さを示します。ディレクトリの深さは、ルートフォルダーの下にあるディレクトリの数です。
encryptionScope	省略可能。この SAS URI で承認された要求を送信するときに使用する暗号化スコープ。
expiresOn	identifier が指定されている場合にのみ省略可能です。この SAS トークンの有効期限。
identifier	省略可能。符号付き識別子 (の場合 <xref:BlobSASSignatureValues>のみ)。「https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy」を参照してください。
ipRange	省略可能。この SAS に許可される IP 範囲。
permissions	identifier が指定されている場合にのみ省略可能です。詳細については、 AccountSASPermissions、、 <xref:BlobSASPermissions>、または <xref:ContainerSASPermissions> を参照してください。
preauthorizedAgentObjectId	GUID 形式の承認済み AAD オブジェクト ID。 SAS によって付与されたアクションを実行するためにユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、この値で指定されたユーザーに対する追加のアクセス許可チェックは実行されません。これは、と <xref:signedUnauthorizedUserObjectId>一緒に使用することはできません。これは、ユーザー委任 SAS でのみ使用されます。
protocol	省略可能。許可される HTTP プロトコル。
resource	省略可能。 SAS を介してアクセスできるリソースを指定します (の場合 <xref:BlobSASSignatureValues>のみ)。「https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only」を参照してください。
resourceTypes	省略可能。アクセスされるストレージリソースの種類 (アカウント SAS の場合のみ)。詳細については、「 AccountSASResourceTypes 」を参照してください。
services	省略可能。アクセスされるストレージサービス (アカウント SAS の場合のみ)。詳細については、「 AccountSASServices 」を参照してください。
signature	SAS トークンの署名。
startsOn	省略可能。この SAS トークンの開始時刻。
version	ストレージ API のバージョン。

メソッド

toString()

すべての SAS クエリパラメーターを、URL に追加できる文字列にエンコードします。

コンストラクターの詳細

SASQueryParameters(string, string, SASQueryParametersOptions)

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

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

パラメーター

version: string

ストレージのバージョンを表す

signature: string

SAS トークンの署名を表す

options: SASQueryParametersOptions

省略可能。 SASQueryParameters を構築するためのオプション。

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)

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

new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string, userDelegationKey?: UserDelegationKey, directoryDepth?: number, preauthorizedAgentObjectId?: string, agentObjectId?: string, correlationId?: string, encryptionScope?: string)

パラメーター

version: string

ストレージのバージョンを表す

signature: string

SAS トークンの署名を表す

permissions: string

ストレージのアクセス許可を表す

services: string

アクセスされるストレージサービスを表す (アカウント SAS の場合のみ)

resourceTypes: string

アクセスされるストレージリソースの種類を表す (アカウント SAS の場合のみ)

protocol: SASProtocol

許可されている HTTP プロトコルを表す

startsOn: Date

この SAS トークンの開始時刻を表す

expiresOn: Date

この SAS トークンの有効期限を表す

ipRange: SasIPRange

この SAS トークンの有効な IP アドレスの範囲を表す

identifier: string

署名された識別子を表す (Service SAS の場合のみ)

resource: string

ストレージコンテナーまたは BLOB を表す (Service SAS の場合のみ)

cacheControl: string

キャッシュ制御ヘッダーを表す (BLOB/ファイルサービス SAS の場合のみ)

contentDisposition: string

コンテンツ処理ヘッダーを表す (BLOB/ファイルサービス SAS の場合のみ)

contentEncoding: string

コンテンツエンコードヘッダーを表す (BLOB/ファイルサービス SAS の場合のみ)

contentLanguage: string

コンテンツ言語ヘッダーを表す (BLOB/ファイルサービス SAS の場合のみ)

contentType: string

コンテンツタイプヘッダーを表す (BLOB/ファイルサービス SAS の場合のみ)

userDelegationKey: UserDelegationKey

ユーザー委任キーのプロパティを表す

directoryDepth: number

preauthorizedAgentObjectId: string

承認された AAD オブジェクト ID を表す (ユーザー委任 SAS の場合のみ)

agentObjectId: string

承認されていない AAD オブジェクト ID を表す (ユーザー委任 SAS の場合のみ)

correlationId: string

関連付け ID を表す (ユーザー委任 SAS の場合のみ)

encryptionScope: string

プロパティの詳細

agentObjectId

GUID 形式の未承認の AAD オブジェクト ID。ユーザー委任キーの所有者によって承認されていないと見なされるユーザーの AAD オブジェクト ID。 Azure Storage Service は、要求された操作の実行がユーザーに許可されているかどうかを判断するために、追加の POSIX ACL チェックを実行します。これは、と <xref:signedAuthorizedUserObjectId>一緒に使用することはできません。これは、ユーザー委任 SAS でのみ使用されます。

agentObjectId?: string

プロパティ値

string

cacheControl

Blob/File Service SAS のキャッシュ制御ヘッダーの値。

cacheControl?: string

プロパティ値

string

contentDisposition

Blob/File Service SAS の content-disposition ヘッダーの値。

contentDisposition?: string

プロパティ値

string

contentEncoding

Blob/File Service SAS のコンテンツエンコードヘッダーの値。

contentEncoding?: string

プロパティ値

string

contentLanguage

Blob/File Service SAS の content-length ヘッダーの値。

contentLanguage?: string

プロパティ値

string

contentType

Blob/File Service SAS の content-type ヘッダーの値。

contentType?: string

プロパティ値

string

correlationId

ストレージ診断ログに記録され、SAS 生成とストレージリソースアクセスを関連付けるために使用できる GUID 値。これは、ユーザー委任 SAS でのみ使用されます。

correlationId?: string

プロパティ値

string

directoryDepth

string-to-sign の canonicalizedresource フィールドで指定されたディレクトリの深さを示します。ディレクトリの深さは、ルートフォルダーの下にあるディレクトリの数です。

directoryDepth?: number

プロパティ値

number

encryptionScope

省略可能。この SAS URI で承認された要求を送信するときに使用する暗号化スコープ。

encryptionScope?: string

プロパティ値

string

expiresOn

identifier が指定されている場合にのみ省略可能です。この SAS トークンの有効期限。

expiresOn?: Date

プロパティ値

Date

identifier

省略可能。符号付き識別子 (の場合 <xref:BlobSASSignatureValues>のみ)。

「https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy」を参照してください。

identifier?: string

プロパティ値

string

ipRange

省略可能。この SAS に許可される IP 範囲。

undefined | SasIPRange ipRange

プロパティ値

undefined | SasIPRange

permissions

identifier が指定されている場合にのみ省略可能です。詳細については、 AccountSASPermissions、、 <xref:BlobSASPermissions>、または <xref:ContainerSASPermissions> を参照してください。

permissions?: string

プロパティ値

string

preauthorizedAgentObjectId

GUID 形式の承認済み AAD オブジェクト ID。 SAS によって付与されたアクションを実行するためにユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、この値で指定されたユーザーに対する追加のアクセス許可チェックは実行されません。これは、と <xref:signedUnauthorizedUserObjectId>一緒に使用することはできません。これは、ユーザー委任 SAS でのみ使用されます。

preauthorizedAgentObjectId?: string

プロパティ値

string

protocol

省略可能。許可される HTTP プロトコル。

protocol?: SASProtocol

プロパティ値

SASProtocol

resource

省略可能。 SAS を介してアクセスできるリソースを指定します (の場合 <xref:BlobSASSignatureValues>のみ)。

「https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only」を参照してください。

resource?: string

プロパティ値

string

resourceTypes

省略可能。アクセスされるストレージリソースの種類 (アカウント SAS の場合のみ)。詳細については、「 AccountSASResourceTypes 」を参照してください。

resourceTypes?: string

プロパティ値

string

services

省略可能。アクセスされるストレージサービス (アカウント SAS の場合のみ)。詳細については、「 AccountSASServices 」を参照してください。

services?: string

プロパティ値

string

signature

SAS トークンの署名。

signature: string

プロパティ値

string

startsOn

省略可能。この SAS トークンの開始時刻。

startsOn?: Date

プロパティ値

Date

version

ストレージ API のバージョン。

version: string

プロパティ値

string

メソッドの詳細

toString()

すべての SAS クエリパラメーターを、URL に追加できる文字列にエンコードします。

function toString(): string

戻り値

string

次の方法で共有

SASQueryParameters class

コンストラクター

プロパティ

メソッド

コンストラクターの詳細

SASQueryParameters(string, string, SASQueryParametersOptions)

パラメーター

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)

パラメーター

プロパティの詳細

agentObjectId

プロパティ値

cacheControl

プロパティ値

contentDisposition

プロパティ値

contentEncoding

プロパティ値

contentLanguage

プロパティ値

contentType

プロパティ値

correlationId

プロパティ値

directoryDepth

プロパティ値

encryptionScope

プロパティ値

expiresOn

プロパティ値

identifier

プロパティ値

ipRange

プロパティ値

permissions

プロパティ値

preauthorizedAgentObjectId

プロパティ値

protocol

プロパティ値

resource

プロパティ値

resourceTypes

プロパティ値

services

プロパティ値

signature

プロパティ値

startsOn

プロパティ値

version

プロパティ値

メソッドの詳細

toString()

戻り値

その他のリソース