FileCreateOptions interface

Pacote:

@azure/storage-file-share

Opções para configurar o criar operação.

Extends

FileAndDirectoryCreateCommonOptions,CommonOptions

Propriedades

abortSignal	Uma implementação da interface AbortSignalLike para sinalizar o pedido de cancelamento da operação. Por exemplo, use o controlador @azure/abort para criar um AbortSignal.
content	Dados iniciais.
contentChecksumAlgorithm	Opções para indicar qual algoritmo usar para validação de conteúdo no upload.
contentLength	Especifica o número de bytes que estão sendo transmitidos no corpo da solicitação. Quando o conteúdo é definido como NULL, o valor deste cabeçalho deve ser definido a zero.
contentMD5	Um hash MD5 do conteúdo. Este hash é usado para verificar a integridade dos dados durante o transporte. Quando o cabeçalho Content-MD5 é especificado, o serviço de arquivo compara o hash do conteúdo que chegou com o valor do cabeçalho que foi enviado. Se os dois hashes não coincidirem, a operação falhará com o código de erro 400 (Pedido Mau).
fileHttpHeaders	Cabeçalhos HTTP de arquivo como Content-Type.
leaseAccessConditions	Condições de acesso à locação.
metadata	Uma coleção de pares de cadeia de caracteres chave-valor para associar ao objeto de armazenamento de arquivos.
onProgress	Manipulador de eventos de atualização de progresso.

Propriedades Herdadas

changeTime	A propriedade de tempo de alteração do Tempo Universal Coordenado (UTC) para o diretório. Um valor de agora pode ser usado para indicar a hora da solicitação. Por padrão, o valor será definido para a hora da solicitação.
creationTime	A propriedade de tempo de criação UTC (Tempo Universal Coordenado) para o diretório. Um valor de agora pode ser usado para indicar a hora da solicitação. Por padrão, o valor será definido como agora.
fileAttributes	Os atributos do sistema de arquivos a serem definidos no arquivo ou diretório.
filePermission	A permissão (descritor de segurança) a ser definida para o arquivo ou diretório na linguagem de definição do descritor de segurança (SDDL) ou binário. Se especificado, ele deve ter um proprietário, grupo e lista de controle de acesso discricionário (DACL). Um valor de herança pode ser passado para herdar do diretório pai. Observe que apenas um de filePermission ou filePermissionKey pode ser especificado. E se ambos não forem especificados, inherit será definido como filePermission como valor padrão pela biblioteca do cliente.
filePermissionFormat	Opcional. Disponível para a versão 2023-06-01 e posterior. Especifica o formato no qual a permissão é retornada. Os valores aceitáveis são SDDL ou binário. Se x-ms-file-permission-format não estiver especificado ou explicitamente definido como SDDL, a permissão será retornada no formato SDDL. Se x-ms-file-permission-format estiver explicitamente definido como binário, a permissão será retornada como uma cadeia de caracteres base64 que representa a codificação binária da permissão
filePermissionKey	A chave da permissão a ser definida para o arquivo ou diretório. Isso pode ser criado usando a API Create-Permission. Observe que apenas um de filePermission ou filePermissionKey pode ser especificado.
lastWriteTime	A última propriedade de gravação do Tempo Universal Coordenado (UTC) para o diretório. Um valor de agora pode ser usado para indicar a hora da solicitação. Por padrão, o valor será definido como agora.
posixProperties	Propriedades opcionais a serem definidas em arquivos NFS. Observe que essa propriedade só é aplicável a arquivos criados em compartilhamentos NFS.
tracingOptions

Detalhes de Propriedade

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar o pedido de cancelamento da operação. Por exemplo, use o controlador @azure/abort para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

content

Dados iniciais.

content?: RequestBodyType

Valor de Propriedade

HttpRequestBody

contentChecksumAlgorithm

Opções para indicar qual algoritmo usar para validação de conteúdo no upload.

contentChecksumAlgorithm?: StorageChecksumAlgorithm

Valor de Propriedade

StorageChecksumAlgorithm

contentLength

Especifica o número de bytes que estão sendo transmitidos no corpo da solicitação. Quando o conteúdo é definido como NULL, o valor deste cabeçalho deve ser definido a zero.

contentLength?: number

Valor de Propriedade

number

contentMD5

Um hash MD5 do conteúdo. Este hash é usado para verificar a integridade dos dados durante o transporte. Quando o cabeçalho Content-MD5 é especificado, o serviço de arquivo compara o hash do conteúdo que chegou com o valor do cabeçalho que foi enviado. Se os dois hashes não coincidirem, a operação falhará com o código de erro 400 (Pedido Mau).

contentMD5?: Uint8Array

Valor de Propriedade

Uint8Array

fileHttpHeaders

Cabeçalhos HTTP de arquivo como Content-Type.

fileHttpHeaders?: FileHttpHeaders

Valor de Propriedade

FileHttpHeaders

leaseAccessConditions

Condições de acesso à locação.

leaseAccessConditions?: LeaseAccessConditions

Valor de Propriedade

LeaseAccessConditions

metadata

Uma coleção de pares de cadeia de caracteres chave-valor para associar ao objeto de armazenamento de arquivos.

metadata?: Metadata

Valor de Propriedade

Metadata

onProgress

Manipulador de eventos de atualização de progresso.

onProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Detalhes da Propriedade Herdada

changeTime

A propriedade de tempo de alteração do Tempo Universal Coordenado (UTC) para o diretório. Um valor de agora pode ser usado para indicar a hora da solicitação. Por padrão, o valor será definido para a hora da solicitação.

changeTime?: Date | "now"

Valor de Propriedade

Date | "now"

herdado de FileAndDirectoryCreateCommonOptions.changeTime

creationTime

A propriedade de tempo de criação UTC (Tempo Universal Coordenado) para o diretório. Um valor de agora pode ser usado para indicar a hora da solicitação. Por padrão, o valor será definido como agora.

creationTime?: Date | "now"

Valor de Propriedade

Date | "now"

herdado deFileAndDirectoryCreateCommonOptions.creationTime

fileAttributes

Os atributos do sistema de arquivos a serem definidos no arquivo ou diretório.

fileAttributes?: FileSystemAttributes

Valor de Propriedade

FileSystemAttributes

herdado deFileAndDirectoryCreateCommonOptions.fileAttributes

filePermission

A permissão (descritor de segurança) a ser definida para o arquivo ou diretório na linguagem de definição do descritor de segurança (SDDL) ou binário. Se especificado, ele deve ter um proprietário, grupo e lista de controle de acesso discricionário (DACL). Um valor de herança pode ser passado para herdar do diretório pai.

Observe que apenas um de filePermission ou filePermissionKey pode ser especificado. E se ambos não forem especificados, inherit será definido como filePermission como valor padrão pela biblioteca do cliente.

filePermission?: string

Valor de Propriedade

string

herdado de FileAndDirectoryCreateCommonOptions.filePermission

filePermissionFormat

Opcional. Disponível para a versão 2023-06-01 e posterior. Especifica o formato no qual a permissão é retornada. Os valores aceitáveis são SDDL ou binário. Se x-ms-file-permission-format não estiver especificado ou explicitamente definido como SDDL, a permissão será retornada no formato SDDL. Se x-ms-file-permission-format estiver explicitamente definido como binário, a permissão será retornada como uma cadeia de caracteres base64 que representa a codificação binária da permissão

filePermissionFormat?: FilePermissionFormat

Valor de Propriedade

FilePermissionFormat

herdado de FileAndDirectoryCreateCommonOptions.filePermissionFormat

filePermissionKey

A chave da permissão a ser definida para o arquivo ou diretório. Isso pode ser criado usando a API Create-Permission.

Observe que apenas um de filePermission ou filePermissionKey pode ser especificado.

filePermissionKey?: string

Valor de Propriedade

string

herdado de FileAndDirectoryCreateCommonOptions.filePermissionKey

lastWriteTime

A última propriedade de gravação do Tempo Universal Coordenado (UTC) para o diretório. Um valor de agora pode ser usado para indicar a hora da solicitação. Por padrão, o valor será definido como agora.

lastWriteTime?: Date | "now"

Valor de Propriedade

Date | "now"

herdado de FileAndDirectoryCreateCommonOptions.lastWriteTime

posixProperties

Propriedades opcionais a serem definidas em arquivos NFS. Observe que essa propriedade só é aplicável a arquivos criados em compartilhamentos NFS.

posixProperties?: FilePosixProperties

Valor de Propriedade

FilePosixProperties

herdado deFileAndDirectoryCreateCommonOptions.posixProperties

tracingOptions

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado deCommonOptions.tracingOptions