SASQueryParameters class
Azure Storage SAS のクエリ パラメーターを構成するコンポーネントを表します。 この型は、ユーザーによって直接構築されません。型と <xref:BlobSASSignatureValues> 型によって<xref:AccountSASSignatureValues>のみ生成されます。 生成されると、 に <xref:String> エンコードして URL に直接追加できます (ただし、既存のクエリ パラメーターがある場合は注意が必要です。これは、これらのクエリ パラメーターを追加する適切な方法に影響する可能性があります)。 注: このクラスのインスタンスは変更できません。
コンストラクター
| SASQuery |
SASQueryParameters のインスタンスを作成します。 |
| SASQuery |
SASQueryParameters のインスタンスを作成します。 |
プロパティ
| cache |
Blob/File Service SAS のキャッシュ制御ヘッダーの値。 |
| content |
Blob/File Service SAS の content-disposition ヘッダーの値。 |
| content |
Blob/File Service SAS のコンテンツ エンコード ヘッダーの値。 |
| content |
Blob/File Service SAS の content-length ヘッダーの値。 |
| content |
Blob/File Service SAS の content-type ヘッダーの値。 |
| correlation |
ストレージ診断ログに記録され、SAS 生成とストレージ リソース アクセスを関連付けるために使用できる GUID 値。 これは、ユーザー委任 SAS でのみ使用されます。 |
| expires |
identifier が指定されている場合にのみ省略可能です。 この SAS トークンの有効期限。 |
| identifier | 省略可能。 符号付き識別子 (の場合 <xref:BlobSASSignatureValues>のみ)。 |
| ip |
省略可能。 この SAS に許可される IP 範囲。 |
| permissions | identifier が指定されている場合にのみ省略可能です。 詳細については、 <xref:AccountSASPermissions>、 <xref:BlobSASPermissions>、または <xref:ContainerSASPermissions> を参照してください。 |
| preauthorized |
GUID 形式の承認済み AAD オブジェクト ID。 SAS によって付与されたアクションを実行するためにユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、この値で指定されたユーザーに対する追加のアクセス許可チェックは実行されません。 これは、ユーザー委任 SAS でのみ使用されます。 |
| protocol | 省略可能。 許可される HTTP プロトコル。 |
| resource | 任意。 SAS を介してアクセスできるリソースを指定します (の場合 <xref:BlobSASSignatureValues>のみ)。 |
| resource |
省略可能。 アクセスされるストレージ リソースの種類 (アカウント SAS の場合のみ)。 詳細については、 を <xref:AccountSASResourceTypes> 参照してください。 |
| services | 省略可能。 アクセスされるストレージ サービス (アカウント SAS の場合のみ)。 詳細については、 を <xref:AccountSASServices> 参照してください。 |
| signature | SAS トークンの署名。 |
| starts |
省略可能。 この SAS トークンの開始時刻。 |
| version | ストレージ API のバージョン。 |
メソッド
| to |
すべての 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, 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, preauthorizedAgentObjectId?: string, correlationId?: 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
ユーザー委任キーのプロパティを表す
- preauthorizedAgentObjectId
-
string
承認された AAD オブジェクト ID を表す (ユーザー委任 SAS の場合のみ)
- correlationId
-
string
関連付け ID を表す (ユーザー委任 SAS の場合のみ)
プロパティの詳細
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
expiresOn
identifier が指定されている場合にのみ省略可能です。 この SAS トークンの有効期限。
expiresOn?: Dateプロパティ値
Date
identifier
省略可能。 符号付き識別子 (の場合 <xref:BlobSASSignatureValues>のみ)。
identifier?: stringプロパティ値
string
ipRange
permissions
identifier が指定されている場合にのみ省略可能です。 詳細については、 <xref:AccountSASPermissions>、 <xref:BlobSASPermissions>、または <xref:ContainerSASPermissions> を参照してください。
permissions?: stringプロパティ値
string
preauthorizedAgentObjectId
GUID 形式の承認済み AAD オブジェクト ID。 SAS によって付与されたアクションを実行するためにユーザー委任キーの所有者によって承認されたユーザーの AAD オブジェクト ID。 Azure Storage サービスでは、アクセスを許可する前に、ユーザー委任キーの所有者が必要なアクセス許可を持っていることを確認しますが、この値で指定されたユーザーに対する追加のアクセス許可チェックは実行されません。 これは、ユーザー委任 SAS でのみ使用されます。
preauthorizedAgentObjectId?: stringプロパティ値
string
protocol
resource
任意。 SAS を介してアクセスできるリソースを指定します (の場合 <xref:BlobSASSignatureValues>のみ)。
resource?: stringプロパティ値
string
resourceTypes
省略可能。 アクセスされるストレージ リソースの種類 (アカウント SAS の場合のみ)。 詳細については、 を <xref:AccountSASResourceTypes> 参照してください。
resourceTypes?: stringプロパティ値
string
services
省略可能。 アクセスされるストレージ サービス (アカウント SAS の場合のみ)。 詳細については、 を <xref: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
Azure SDK for JavaScript