FileRenameOptions interface

パッケージ:

@azure/storage-file-share

名前変更操作を構成するためのオプション。

Extends

CommonOptions

プロパティ

abortSignal	操作を AbortSignalLike 取り消す要求を通知するインターフェイスの実装。 たとえば、@azure/abort-controller を使用して を作成します AbortSignal。
contentType	省略可能。 ファイルに設定するコンテンツ タイプ。
copyFileSmbInfo	省略可能。 ソース ファイルからファイル セキュリティ記述子をコピーするか、x-ms-file-permission または x-ms-file-permission-key のヘッダー値で定義されている値を使用して設定するオプションを指定します。
destinationLeaseAccessConditions	宛先ファイルのリース アクセス条件。 コピー先ファイルにアクティブな無限リースがある場合は必須です。
filePermission	省略可能。 指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。
filePermissionKey	省略可能。 ディレクトリ/ファイルに対して設定するアクセス許可のキー。 注: filePermission または filePermissionKey の 1 つだけを指定する必要があります。
ignoreReadOnly	省略可能。 既存の宛先ファイルの ReadOnly 属性を尊重するかどうかを指定するブール値。 true の場合、名前の変更は成功し、それ以外の場合は、ReadOnly 属性が設定された宛先の前のファイルで名前の変更が失敗します。
metadata	ファイル ストレージ オブジェクトに関連付ける名前と値のペア。
replaceIfExists	省略可能。 この要求によってファイルが上書きされるかどうかに関係なく、宛先ファイルが既に存在する場合の のブール値。 true の場合、名前の変更は成功し、コピー先のファイルが上書きされます。 指定されていない場合、または false で宛先ファイルが存在する場合、要求は宛先ファイルを上書きしません。 指定されたファイルが存在しない場合、名前の変更は成功します。 注: この値は、x-ms-file-copy-ignore-read-only ヘッダー値をオーバーライドしません。
sourceLeaseAccessConditions	ソース ファイルのリース アクセス条件。 ソース ファイルにアクティブな無限リースがある場合は必須です。
timeoutInSeconds	省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「ファイル サービス操作のタイムアウトの設定」を参照してください。

継承されたプロパティ

tracingOptions

プロパティの詳細

abortSignal

操作を AbortSignalLike 取り消す要求を通知するインターフェイスの実装。 たとえば、@azure/abort-controller を使用して を作成します AbortSignal。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

contentType

省略可能。 ファイルに設定するコンテンツ タイプ。

contentType?: string

プロパティ値

string

copyFileSmbInfo

省略可能。 ソース ファイルからファイル セキュリティ記述子をコピーするか、x-ms-file-permission または x-ms-file-permission-key のヘッダー値で定義されている値を使用して設定するオプションを指定します。

copyFileSmbInfo?: CopyFileSmbInfo

プロパティ値

CopyFileSmbInfo

destinationLeaseAccessConditions

宛先ファイルのリース アクセス条件。 コピー先ファイルにアクティブな無限リースがある場合は必須です。

destinationLeaseAccessConditions?: LeaseAccessConditions

プロパティ値

LeaseAccessConditions

filePermission

省略可能。 指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。

filePermission?: string

プロパティ値

string

filePermissionKey

省略可能。 ディレクトリ/ファイルに対して設定するアクセス許可のキー。 注: filePermission または filePermissionKey の 1 つだけを指定する必要があります。

filePermissionKey?: string

プロパティ値

string

ignoreReadOnly

省略可能。 既存の宛先ファイルの ReadOnly 属性を尊重するかどうかを指定するブール値。 true の場合、名前の変更は成功し、それ以外の場合は、ReadOnly 属性が設定された宛先の前のファイルで名前の変更が失敗します。

ignoreReadOnly?: boolean

プロパティ値

boolean

metadata

ファイル ストレージ オブジェクトに関連付ける名前と値のペア。

metadata?: Metadata

プロパティ値

Metadata

replaceIfExists

省略可能。 この要求によってファイルが上書きされるかどうかに関係なく、宛先ファイルが既に存在する場合の のブール値。 true の場合、名前の変更は成功し、コピー先のファイルが上書きされます。 指定されていない場合、または false で宛先ファイルが存在する場合、要求は宛先ファイルを上書きしません。 指定されたファイルが存在しない場合、名前の変更は成功します。 注: この値は、x-ms-file-copy-ignore-read-only ヘッダー値をオーバーライドしません。

replaceIfExists?: boolean

プロパティ値

boolean

sourceLeaseAccessConditions

ソース ファイルのリース アクセス条件。 ソース ファイルにアクティブな無限リースがある場合は必須です。

sourceLeaseAccessConditions?: LeaseAccessConditions

プロパティ値

LeaseAccessConditions

timeoutInSeconds

省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「ファイル サービス操作のタイムアウトの設定」を参照してください。

timeoutInSeconds?: number

プロパティ値

number

継承されたプロパティの詳細

tracingOptions

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

CommonOptions.tracingOptionsから継承