@azure/storage-file package

Classes

Aborter	Uma instância de abortador implementa a interface AbortSignal, pode anular solicitações HTTP. Chame Aborter.none para criar uma nova instância do Aborter sem tempo limite. Chame Aborter.timeout() para criar uma nova instância de Aborter com tempo limite. Para um abortador de instância existente: Chame aborter.withTimeout() para criar e retornar uma instância Aborter filho com tempo limite. Chame aborter.withValue(key, value) para criar e retornar uma instância Aborter filho com par chave/valor. Chame aborter.abort() para anular a instância atual e todas as instâncias filhas. Chame aborter.getValue(key) para pesquisar e obter valor com a chave correspondente do abortador atual para todos os pais.
AccountSASPermissions	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:IAccountSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
AccountSASResourceTypes	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa os recursos acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse tipo de recurso. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de recursos em um objeto <xref:IAccountSASSignatureValues>. É possível construir a cadeia de caracteres de recursos sem essa classe, mas a ordem dos recursos é particular e essa classe garante a correção.
AccountSASServices	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa os serviços acessíveis por um AccountSAS. Definir um valor como true significa que qualquer SAS que use essas permissões concederá acesso a esse serviço. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de serviços em um objeto <xref:IAccountSASSignatureValues>. É possível construir a cadeia de caracteres de serviços sem essa classe, mas a ordem dos serviços é particular e essa classe garante a correção.
BrowserPolicyFactory	BrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos BrowserPolicy.
DirectoryURL	Um DirectoryURL representa uma URL para o diretório de Armazenamento do Azure, permitindo que você manipule seus arquivos e diretórios.
FileSASPermissions	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS a um arquivo. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:IFileSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
FileSystemAttributes	Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa os atributos NTFS para um arquivo ou diretório.
FileURL	Um FileURL representa uma URL para um arquivo de Armazenamento do Azure.
KeepAlivePolicyFactory	KeepAlivePolicyFactory é uma classe de fábrica que ajuda a gerar objetos KeepAlivePolicy.
LoggingPolicyFactory	LoggingPolicyFactory é uma classe de fábrica que ajuda a gerar objetos LoggingPolicy.
Pipeline	Uma classe Pipeline que contém políticas de solicitação HTTP. Você pode criar um Pipeline padrão chamando StorageURL.newPipeline(). Ou você pode criar um Pipeline com suas próprias políticas pelo construtor de Pipeline. Consulte StorageURL.newPipeline() e forneceu políticas como referência antes de implementar seu Pipeline personalizado.
RetryPolicyFactory	RetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos RetryPolicy.
SASQueryParameters	Representa os componentes que compõem os parâmetros de consulta de um SAS de Armazenamento do Azure. Este tipo não é construído diretamente pelo usuário; é gerado apenas pelos tipos <xref:IAccountSASSignatureValues> e <xref:IFileSASSignatureValues>. Uma vez gerado, ele pode ser codificado em uma {@code String} e anexado a uma URL diretamente (embora seja necessário ter cuidado aqui caso existam parâmetros de consulta existentes, o que pode afetar os meios apropriados de anexar esses parâmetros de consulta). Observação : instâncias dessa classe são imutáveis.
ServiceURL	Um ServiceURL representa uma URL para o serviço de Arquivo de Armazenamento do Azure permitindo que você manipule compartilhamentos de arquivos.
ShareSASPermissions	Esta é uma classe auxiliar para construir uma cadeia de caracteres que representa as permissões concedidas por um ServiceSAS a um compartilhamento. Definir um valor como true significa que qualquer SAS que use essas permissões concederá permissões para essa operação. Depois que todos os valores estiverem definidos, isso deve ser serializado com toString e definido como o campo de permissões em um objeto <xref:IFileSASSignatureValues>. É possível construir a cadeia de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
ShareURL	Um ShareURL representa uma URL para o compartilhamento de Armazenamento do Azure, permitindo que você manipule seus diretórios e arquivos.
StorageURL	Um ServiceURL representa uma classe de URL baseada para ServiceURL, ContainerURL e etc.
TelemetryPolicyFactory	TelemetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos TelemetryPolicy.
UniqueRequestIDPolicyFactory	UniqueRequestIDPolicyFactory é uma classe de fábrica que ajuda a gerar objetos UniqueRequestIDPolicy.
AnonymousCredential	AnonymousCredential fornece um membro credentialPolicyCreator usado para criar objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS).
Credential	Credential é uma classe abstrata para assinatura de solicitações HTTP do Armazenamento do Azure. Essa classe hospedará uma fábrica credentialPolicyCreator que gera CredentialPolicy.
SharedKeyCredential	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. SharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.
Directory	Classe que representa um diretório.
File	Classe que representa um arquivo.
Service	Classe que representa um Serviço.
Share	Classe que representa uma Ação.
StorageClient
StorageClientContext
AnonymousCredentialPolicy	AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com Assinaturas de Acesso Compartilhado (SAS).
BrowserPolicy	BrowserPolicy lidará com as diferenças entre Node.js e o tempo de execução do navegador, incluindo: Os navegadores armazenam em cache solicitações GET/HEAD adicionando cabeçalhos condicionais como 'IF_MODIFIED_SINCE'. BrowserPolicy é uma política usada para adicionar uma consulta de carimbo de data/hora ao URL de solicitação GET/HEAD, evitando assim o cache do navegador. Remover cabeçalho de cookie para segurança Remova o cabeçalho de comprimento de conteúdo para evitar avisos de navegadores
CredentialPolicy	Política de credenciais usada para assinar solicitações HTTP(S) antes do envio. Esta é uma classe abstrata.
KeepAlivePolicy	KeepAlivePolicy é uma política usada para controlar as configurações de manter ativas para cada solicitação.
LoggingPolicy	LoggingPolicy é uma política usada para registrar solicitações.
RetryPolicy	Política de repetição com repetição exponencial e repetição linear implementada.
SharedKeyCredentialPolicy	SharedKeyCredentialPolicy é uma política usada para assinar solicitações HTTP com uma chave compartilhada.
TelemetryPolicy	TelemetryPolicy é uma política usada para marcar o cabeçalho do agente do usuário para cada solicitação.
UniqueRequestIDPolicy	UniqueRequestIDPolicy gera um UUID como valor de cabeçalho x-ms-request-id.
Batch	O lote fornece execução paralela básica com limites de simultaneidade. Interromperá as operações de execução à esquerda quando uma das operações executadas lançar um erro. Mas o Batch não pode cancelar operações em andamento, você precisa cancelá-las por conta própria.
BufferScheduler	Essa classe aceita um fluxo Node.js legível como entrada e mantém a leitura de dados do fluxo para a estrutura de buffer interno, até que atinja maxBuffers. Cada buffer disponível tentará acionar outgoingHandler. A estrutura de buffer interno inclui uma matriz de buffer de entrada e uma matriz de buffer de saída. A matriz de buffer de entrada inclui os buffers "vazios" podem ser preenchidos com novos dados de entrada. A matriz de saída inclui os buffers preenchidos a serem manipulados por outgoingHandler. Cada tamanho de buffer acima é definido pelo parâmetro bufferSize. NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING <NUM_OF_ALL_BUFFERS = maxBuffers DICAS DE MELHORIA DE DESEMPENHO: O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações Buffer.concat(). O paralelismo deve definir um valor menor do que maxBuffers, o que é útil para reduzir a possibilidade quando um manipulador de saída aguarda os dados de fluxo. Nessa situação, os manipuladores de saída são bloqueados. A fila de saída não deve estar vazia.
RetriableReadableStream	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Um Node.js ReadableStream tentará internamente novamente quando o ReadableStream interno terminar.

Interfaces

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions	A opção é definida como paridade à definição REST. Embora não esteja pronto para ser usado agora, considerando que o Crc64 do conteúdo de origem não está acessível.
IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. IAccountSASSignatureValues é usado para gerar uma Assinatura de Acesso Compartilhado (SAS) para uma conta de Armazenamento do Azure. Uma vez que todos os valores aqui são definidos adequadamente, chame generateSASQueryParameters() para obter uma representação do SAS que pode realmente ser aplicado a urls de arquivo. Nota: que tanto essa classe quanto <xref:SASQueryParameters> existem porque a primeira é mutável e uma representação lógica, enquanto a segunda é imutável e usada para gerar solicitações REST reais.
IFileSASSignatureValues	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. IFileSASSignatureValues é usado para ajudar a gerar tokens SAS de serviço de arquivo para compartilhamentos ou arquivos.
IIPRange	Intervalo de IP permitido para uma SAS.
IRange	Intervalo para operações de serviço.
IKeepAliveOptions	Interface das opções KeepAlivePolicy.
IRequestLogOptions	RequestLogOptions configura o comportamento da política de repetição.
IPipelineOptions	Interface de opção para o construtor Pipeline.
IRetryOptions	Interface de opções de repetição novamente.
IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions	Interface de opção para o método Pipeline.newPipeline.
ITelemetryOptions	Interface das opções TelemetryPolicy.
AccessPolicy	Uma política de acesso.
CorsRule	O CORS é um recurso HTTP que permite que um aplicativo Web executado em um domínio acesse recursos em outro domínio. Os navegadores da Web implementam uma restrição de segurança conhecida como política de mesma origem que impede que uma página da Web chame APIs em um domínio diferente; O CORS fornece uma maneira segura de permitir que um domínio (o domínio de origem) chame APIs em outro domínio.
DirectoryCreateHeaders	Define cabeçalhos para a operação Create.
DirectoryCreateOptionalParams	Parâmetros opcionais.
DirectoryDeleteHeaders	Define cabeçalhos para a operação Delete.
DirectoryDeleteMethodOptionalParams	Parâmetros opcionais.
DirectoryForceCloseHandlesHeaders	Define cabeçalhos para a operação ForceCloseHandles.
DirectoryForceCloseHandlesOptionalParams	Parâmetros opcionais.
DirectoryGetPropertiesHeaders	Define cabeçalhos para a operação GetProperties.
DirectoryGetPropertiesOptionalParams	Parâmetros opcionais.
DirectoryItem	Um item de diretório listado.
DirectoryListFilesAndDirectoriesSegmentHeaders	Define cabeçalhos para a operação ListFilesAndDirectoriesSegment.
DirectoryListFilesAndDirectoriesSegmentOptionalParams	Parâmetros opcionais.
DirectoryListHandlesHeaders	Define cabeçalhos para a operação ListHandles.
DirectoryListHandlesOptionalParams	Parâmetros opcionais.
DirectorySetMetadataHeaders	Define cabeçalhos para a operação SetMetadata.
DirectorySetMetadataOptionalParams	Parâmetros opcionais.
DirectorySetPropertiesHeaders	Define cabeçalhos para a operação SetProperties.
DirectorySetPropertiesOptionalParams	Parâmetros opcionais.
FileAbortCopyHeaders	Define cabeçalhos para a operação AbortCopy.
FileAbortCopyOptionalParams	Parâmetros opcionais.
FileCreateHeaders	Define cabeçalhos para a operação Create.
FileCreateOptionalParams	Parâmetros opcionais.
FileDeleteHeaders	Define cabeçalhos para a operação Delete.
FileDeleteMethodOptionalParams	Parâmetros opcionais.
FileDownloadHeaders	Define cabeçalhos para a operação de download.
FileDownloadOptionalParams	Parâmetros opcionais.
FileForceCloseHandlesHeaders	Define cabeçalhos para a operação ForceCloseHandles.
FileForceCloseHandlesOptionalParams	Parâmetros opcionais.
FileGetPropertiesHeaders	Define cabeçalhos para a operação GetProperties.
FileGetPropertiesOptionalParams	Parâmetros opcionais.
FileGetRangeListHeaders	Define cabeçalhos para a operação GetRangeList.
FileGetRangeListOptionalParams	Parâmetros opcionais.
FileHTTPHeaders	Parâmetros adicionais para um conjunto de operações, tais como: File_create, File_setHTTPHeaders.
FileItem	Um item de arquivo listado.
FileListHandlesHeaders	Define cabeçalhos para a operação ListHandles.
FileListHandlesOptionalParams	Parâmetros opcionais.
FileProperty	Propriedades do arquivo.
FileSetHTTPHeadersHeaders	Define cabeçalhos para a operação SetHTTPHeaders.
FileSetHTTPHeadersOptionalParams	Parâmetros opcionais.
FileSetMetadataHeaders	Define cabeçalhos para a operação SetMetadata.
FileSetMetadataOptionalParams	Parâmetros opcionais.
FileStartCopyHeaders	Define cabeçalhos para a operação StartCopy.
FileStartCopyOptionalParams	Parâmetros opcionais.
FileUploadRangeFromURLHeaders	Define cabeçalhos para a operação UploadRangeFromURL.
FileUploadRangeFromURLOptionalParams	Parâmetros opcionais.
FileUploadRangeHeaders	Define cabeçalhos para a operação UploadRange.
FileUploadRangeOptionalParams	Parâmetros opcionais.
FilesAndDirectoriesListSegment	Resumo para entradas que podem ser listadas a partir do Diretório.
HandleItem	Um item de identificador de Armazenamento do Azure listado.
ListFilesAndDirectoriesSegmentResponse	Uma enumeração de diretórios e arquivos.
ListHandlesResponse	Uma enumeração de identificadores.
ListSharesResponse	Uma enumeração de ações.
Metrics	Métricas do Storage Analytics para serviço de arquivos.
Permission	Permission(um descritor de segurança) descrito no Security Descriptor Definition Language (SDDL).
Range	Um intervalo de arquivos do Armazenamento do Azure.
RetentionPolicy	A política de retenção.
ServiceGetPropertiesHeaders	Define cabeçalhos para a operação GetProperties.
ServiceGetPropertiesOptionalParams	Parâmetros opcionais.
ServiceListSharesSegmentHeaders	Define cabeçalhos para a operação ListSharesSegment.
ServiceListSharesSegmentOptionalParams	Parâmetros opcionais.
ServiceSetPropertiesHeaders	Define cabeçalhos para a operação SetProperties.
ServiceSetPropertiesOptionalParams	Parâmetros opcionais.
ShareCreateHeaders	Define cabeçalhos para a operação Create.
ShareCreateOptionalParams	Parâmetros opcionais.
ShareCreatePermissionHeaders	Define cabeçalhos para a operação CreatePermission.
ShareCreatePermissionOptionalParams	Parâmetros opcionais.
ShareCreateSnapshotHeaders	Define cabeçalhos para a operação CreateSnapshot.
ShareCreateSnapshotOptionalParams	Parâmetros opcionais.
ShareDeleteHeaders	Define cabeçalhos para a operação Delete.
ShareDeleteMethodOptionalParams	Parâmetros opcionais.
ShareGetAccessPolicyHeaders	Define cabeçalhos para a operação GetAccessPolicy.
ShareGetAccessPolicyOptionalParams	Parâmetros opcionais.
ShareGetPermissionHeaders	Define cabeçalhos para a operação GetPermission.
ShareGetPermissionOptionalParams	Parâmetros opcionais.
ShareGetPropertiesHeaders	Define cabeçalhos para a operação GetProperties.
ShareGetPropertiesOptionalParams	Parâmetros opcionais.
ShareGetStatisticsHeaders	Define cabeçalhos para a operação GetStatistics.
ShareGetStatisticsOptionalParams	Parâmetros opcionais.
ShareItem	Um item de compartilhamento de Armazenamento do Azure listado.
ShareProperties	Propriedades de uma ação.
ShareSetAccessPolicyHeaders	Define cabeçalhos para a operação SetAccessPolicy.
ShareSetAccessPolicyOptionalParams	Parâmetros opcionais.
ShareSetMetadataHeaders	Define cabeçalhos para a operação SetMetadata.
ShareSetMetadataOptionalParams	Parâmetros opcionais.
ShareSetQuotaHeaders	Define cabeçalhos para a operação SetQuota.
ShareSetQuotaOptionalParams	Parâmetros opcionais.
ShareStats	Estatísticas para a ação.
SignedIdentifier	Identificador assinado.
SourceModifiedAccessConditions	Parâmetros adicionais para a operação uploadRangeFromURL.
StorageError	Uma interface que representa StorageError.
StorageServiceProperties	Propriedades do serviço de armazenamento.
IDownloadFromAzureFileOptions	Interface de opção para DownloadAzurefileToBuffer.
IUploadToAzureFileOptions	Interface de opção para uploadFileToAzureFile e uploadSeekableStreamToAzureFile.
IUploadStreamToAzureFileOptions	Interface de opção para uploadStreamToAzureFile.
IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

Aliases de Tipo

FileDownloadResponse	Contém dados de resposta para a operação de download.
FileGetRangeListResponse	Contém dados de resposta para a operação getRangeList.
ShareGetAccessPolicyResponse	Contém dados de resposta para a operação getAccessPolicy.
ShareGetStatisticsResponse	Contém dados de resposta para a operação getStatistics.
CredentialPolicyCreator	Uma função de fábrica que cria uma nova CredentialPolicy que usa a nextPolicy fornecida.
CopyStatusType	Define valores para CopyStatusType. Os valores possíveis incluem: 'pendente', 'sucesso', 'abortado', 'reprovado'
DeleteSnapshotsOptionType	Define valores para DeleteSnapshotsOptionType. Os valores possíveis incluem: 'include'
DirectoryCreateResponse	Contém dados de resposta para a operação create.
DirectoryDeleteResponse	Contém dados de resposta para a operação deleteMethod.
DirectoryForceCloseHandlesResponse	Contém dados de resposta para a operação forceCloseHandles.
DirectoryGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse	Contém dados de resposta para a operação listFilesAndDirectoriesSegment.
DirectoryListHandlesResponse	Contém dados de resposta para a operação listHandles.
DirectorySetMetadataResponse	Contém dados de resposta para a operação setMetadata.
DirectorySetPropertiesResponse	Contém dados de resposta para a operação setProperties.
FileAbortCopyResponse	Contém dados de resposta para a operação abortCopy.
FileCreateResponse	Contém dados de resposta para a operação create.
FileDeleteResponse	Contém dados de resposta para a operação deleteMethod.
FileForceCloseHandlesResponse	Contém dados de resposta para a operação forceCloseHandles.
FileGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
FileListHandlesResponse	Contém dados de resposta para a operação listHandles.
FileRangeWriteType	Define valores para FileRangeWriteType. Os valores possíveis incluem: 'update', 'clear'
FileSetHTTPHeadersResponse	Contém dados de resposta para a operação setHTTPHeaders.
FileSetMetadataResponse	Contém dados de resposta para a operação setMetadata.
FileStartCopyResponse	Contém dados de resposta para a operação startCopy.
FileType	Define valores para FileType. Os valores possíveis incluem: 'Ficheiro'
FileUploadRangeFromURLResponse	Contém dados de resposta para a operação uploadRangeFromURL.
FileUploadRangeResponse	Contém dados de resposta para a operação uploadRange.
ListSharesIncludeType	Define valores para ListSharesIncludeType. Os valores possíveis incluem: 'snapshots', 'metadata'
ServiceGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
ServiceListSharesSegmentResponse	Contém dados de resposta para a operação listSharesSegment.
ServiceSetPropertiesResponse	Contém dados de resposta para a operação setProperties.
ShareCreatePermissionResponse	Contém dados de resposta para a operação createPermission.
ShareCreateResponse	Contém dados de resposta para a operação create.
ShareCreateSnapshotResponse	Contém dados de resposta para a operação createSnapshot.
ShareDeleteResponse	Contém dados de resposta para a operação deleteMethod.
ShareGetPermissionResponse	Contém dados de resposta para a operação getPermission.
ShareGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
ShareSetAccessPolicyResponse	Contém dados de resposta para a operação setAccessPolicy.
ShareSetMetadataResponse	Contém dados de resposta para a operação setMetadata.
ShareSetQuotaResponse	Contém dados de resposta para a operação setQuota.
StorageErrorCode	Define valores para StorageErrorCode. Os valores possíveis incluem: 'AccountAlreadyExists', 'AccountBeingCreated', 'AccountIsDisabled', 'AuthenticationFailed', 'AuthorizationFailure', 'ConditionHeadersNotSupported', 'ConditionNotMet', 'EmptyMetadataKey', 'InsufficientAccountPermissions', 'InternalError', 'InvalidAuthenticationInfo', 'InvalidHeaderValue', 'InvalidHttpVerb', 'InvalidInput', 'InvalidMd5', 'InvalidMetadata', 'InvalidQueryParameterValue', 'InvalidRange', 'InvalidResourceName', 'InvalidUri', ' InvalidXmlDocument', 'InvalidXmlNodeValue', 'Md5Mismatch', 'MetadataTooLarge', 'MissingContentLengthHeader', 'MissingRequiredQueryParameter', 'MissingRequiredHeader', 'MissingRequiredXmlNode', 'MultipleConditionHeadersNotSupported', 'OperationTimedOut', 'OutOfRangeInput', 'OutOfRangeQueryParameterValue', 'RequestBodyTooLarge', 'ResourceTypeMismatch', 'RequestUrlFailedToParse', 'ResourceAlreadyExists', 'ResourceNotFound', 'ServerBusy', 'UnsupportedHeader', ' UnsupportedXmlNode', 'UnsupportedQueryParameter', 'UnsupportedHttpVerb', 'CannotDeleteFileOrDirectory', 'ClientCacheFlushDelay', 'DeletePending', 'DirectoryNotEmpty', 'FileLockConflict', 'InvalidFileOrDirectoryPathName', 'ParentNotFound', 'ReadOnlyAttribute', 'ShareAlreadyExists', 'ShareBeingDeleted', 'ShareDisabled', 'ShareNotFound', 'SharingViolation', 'ShareSnapshotInProgress', 'ShareSnapshotCountExceeded', 'ShareSnapshotOperationNotSupported', ' ShareHasSnapshots', 'ContainerQuotaDowngradeNotAllowed'
FileAttributesPreserveType	Indica manter os atributos de arquivo existentes inalterados.
FilePermissionInheritType	Indica a permissão de herdar arquivo do diretório pai.
FilePermissionPreserveType	Indica manter o valor de permissão de arquivo existente inalterado.
TimeNowType	Indica a configuração como a hora da solicitação.
TimePreserveType	Indica manter o valor de tempo existente inalterado.
Operation	Operação é uma função assíncrona a ser executada e gerenciada pelo Batch.
OutgoingHandler	OutgoingHandler é uma função assíncrona acionada por BufferScheduler.
ReadableStreamGetter

Enumerações

SASProtocol	Protocolos para SAS gerado.
RetryPolicyType	Tipos RetryPolicy.

Funções

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto <xref:SASQueryParameters> que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.
generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters. Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startTime e identificador. AVISO: Quando o identificador não é fornecido, as permissões e o expiryTime são necessários. Você DEVE atribuir valor ao identificador ou permissões de & expiryTime manualmente se você inicializar com este construtor.
ipRangeToString(IIPRange)	Gerar cadeia de caracteres de formato IPRange. Por exemplo: "8.8.8.8" ou "1.1.1.1-255.255.255.255"
rangeToString(IRange)	Gere uma cadeia de caracteres de intervalo. Por exemplo: "bytes=255-" ou "bytes=0-511"
uploadBrowserDataToAzureFile(Aborter, Blob \| ArrayBuffer \| ArrayBufferView, FileURL, IUploadToAzureFileOptions)	DISPONÍVEL APENAS EM NAVEGADORES. Carrega um objeto Blob/File/ArrayBuffer/ArrayBufferView do navegador em um arquivo do Azure.
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined \| number, IDownloadFromAzureFileOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para ambos para baixar o arquivo inteiro.
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um arquivo local em um arquivo do Azure.
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um fluxo Node.js legível em um arquivo do Azure. Esse método tentará criar um Azure e, em seguida, começará a carregar bloco por bloco. O tamanho do bloco é definido por `bufferSize` parâmetro. Certifique-se de que o tamanho potencial do fluxo não exceda o tamanho do arquivo. DICAS DE MELHORIA DE DESEMPENHO: O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações Buffer.concat().
fileAttributesToString(FileSystemAttributes \| FileAttributesPreserveType)
fileCreationTimeToString(Date \| TimeNowType \| TimePreserveType)
fileLastWriteTimeToString(Date \| TimeNowType \| TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined \| string, undefined \| string)
NewRetryPolicyFactory(IRetryOptions)	Um método de fábrica usado para gerar uma fábrica RetryPolicy.
blobToArrayBuffer(Blob)	Converta um objeto Browser Blob em ArrayBuffer.
appendToURLPath(string, string)	Anexe uma cadeia de caracteres ao caminho da URL. Removerá "/" duplicado na frente da cadeia de caracteres quando o caminho da URL terminar com um "/".
base64decode(string)	Decodificação Base64.
base64encode(string)	Codificação Base64.
delay(number, AbortSignalLike, Error)	Atrasar o intervalo de tempo especificado.
escapeURLPath(string)	Os caracteres de URL reservados devem ser escapados corretamente para serviços de armazenamento como Blob ou Arquivo. Estratégia de codificação e escape de URL para SDKs JSv10 Quando os clientes passam uma cadeia de caracteres de URL para o construtor de classes XXXURL, a cadeia de caracteres de URL pode já estar codificada por URL ou não. Mas antes de enviar para o servidor de Armazenamento do Azure, a URL deve ser codificada. No entanto, é difícil para um SDK adivinhar se a cadeia de caracteres de URL foi codificada ou não. Temos 2 estratégias potenciais, e escolhemos a estratégia duas para os construtores XXXURL. Estratégia um: suponha que a cadeia de caracteres de URL do cliente não está codificada e sempre codifique a cadeia de caracteres de URL no SDK. Isso é o que o SDK V2 legado faz, simples e funciona para a maioria dos casos. Quando a cadeia de caracteres de URL do cliente for "http://account.blob.core.windows.net/con/b:", o SDK a codificará para "http://account.blob.core.windows.net/con/b%3A" e enviar para o servidor. Um blob chamado "b:" será criado. Quando a cadeia de caracteres de URL do cliente for "http://account.blob.core.windows.net/con/b%3A", o SDK a codificará para "http://account.blob.core.windows.net/con/b%253A" e enviar para o servidor. Um blob chamado "b%3A" será criado. Mas esta estratégia fará com que não seja possível criar um blob com "?" no seu nome. Porque quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/blob?name", o "?nome" será tratado como paramter de URL em vez de nome de blob. Se a cadeia de caracteres de URL do cliente for "http://account.blob.core.windows.net/con/blob%3Fname", um blob chamado "blob%3Fname" será criado. O SDK V2 não tem esse problema porque não permite que o cliente passe em uma URL completa, aceita um nome de blob separado e codifica URIComponent para ele. Não podemos aceitar que um SDK não possa criar um nome de blob com "?". Assim, implementamos a estratégia dois: Estratégia dois: o SDK não assume que a URL foi codificada ou não. Ele apenas escapará dos caracteres especiais. Isso é o que o V10 Blob Go SDK faz. Ele aceita um tipo de URL em Go, e chamar url. EscapedPath() para escapar dos chars especiais sem escapar. Quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/b:", o SDK escapará de ":" como "http://account.blob.core.windows.net/con/b%3A" e enviar para o servidor. Um blob chamado "b:" será criado. Quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/b%3A", Não há caracteres especiais, então envie "http://account.blob.core.windows.net/con/b%3A" ao servidor. Um blob chamado "b:" será criado. Quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/b%253A", Não há caracteres especiais, então envie "http://account.blob.core.windows.net/con/b%253A" ao servidor. Um blob chamado "b%3A" será criado. Esta estratégia dá-nos flexibilidade para criar com quaisquer caracteres especiais. Mas "%" será tratado como um caractere especial, se a string de URL não estiver codificada, não deve haver um "%" na string de URL, caso contrário, a URL não é uma URL válida. Se o cliente precisar criar um blob com "%" no nome do blob, use "%25" insead de "%". Assim como acima da 3ª amostra. E as seguintes cadeias de caracteres de URL são inválidas: "http://account.blob.core.windows.net/con/b%" "http://account.blob.core.windows.net/con/b%2" "http://account.blob.core.windows.net/con/b%G" Outro caractere especial é "?", use "%2F" para representar um nome de blob com "?" em uma cadeia de caracteres de URL. Estratégia para containerName, blobName ou outros parâmetros XXXName específicos em métodos como `BlobURL.fromContainerURL(containerURL, blobName)` Vamos aplicar a estratégia um e chamar encodeURIComponent para esses parâmetros como blobName. Porque o que os clientes passam é um nome simples em vez de um URL.
getURLParameter(string, string)	Obter parâmetro de URL por nome.
getURLPath(string)	Obter caminho de URL de uma cadeia de caracteres de URL.
getURLQueries(string)	Obtenha pares de valores de chave de consulta de URL a partir de uma cadeia de caracteres de URL.
padStart(string, number, undefined \| string)	String.prototype.padStart()
setURLHost(string, string)	Definir host de URL.
setURLParameter(string, string, undefined \| string)	Defina o nome e o valor do parâmetro de URL. Se o nome existir nos parâmetros de URL, o valor antigo será substituído pela chave de nome. Se não fornecer valor, o parâmetro será excluído.
truncatedISO8061Date(Date, undefined \| false \| true)	Arredonda uma data para segundos.
streamToBuffer(ReadableStream, Buffer, number, number, undefined \| string)	Lê um fluxo legível no buffer. Preencha o buffer do deslocamento ao fim.

Detalhes de Função

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Gera um objeto <xref:SASQueryParameters> que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parâmetros

accountSASSignatureValues: IAccountSASSignatureValues

sharedKeyCredential: SharedKeyCredential

Devoluções

SASQueryParameters

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria uma instância de SASQueryParameters.

Só aceita as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startTime e identificador.

AVISO: Quando o identificador não é fornecido, as permissões e o expiryTime são necessários. Você DEVE atribuir valor ao identificador ou permissões de & expiryTime manualmente se você inicializar com este construtor.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Parâmetros

fileSASSignatureValues: IFileSASSignatureValues

sharedKeyCredential: SharedKeyCredential

Devoluções

SASQueryParameters

ipRangeToString(IIPRange)

Gerar cadeia de caracteres de formato IPRange. Por exemplo: "8.8.8.8" ou "1.1.1.1-255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Parâmetros

ipRange: IIPRange

Devoluções

string

rangeToString(IRange)

Gere uma cadeia de caracteres de intervalo. Por exemplo: "bytes=255-" ou "bytes=0-511"

function rangeToString(iRange: IRange)

Parâmetros

iRange: IRange

Devoluções

string

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

DISPONÍVEL APENAS EM NAVEGADORES. Carrega um objeto Blob/File/ArrayBuffer/ArrayBufferView do navegador em um arquivo do Azure.

function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Parâmetros

aborter: Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer ou ArrayBufferView

fileURL: FileURL

options: IUploadToAzureFileOptions

Devoluções

Promise<void>

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para ambos para baixar o arquivo inteiro.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)

Parâmetros

aborter: Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

buffer: Buffer

Buffer para ser preenchido, deve ter comprimento maior do que contagem

fileURL: FileURL

Um objeto FileURL

offset: number

A partir de qual posição do Arquivo do Azure para baixar

count: undefined | number

options: IDownloadFromAzureFileOptions

Devoluções

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um arquivo local em um arquivo do Azure.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Parâmetros

aborter: Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

filePath: string

Caminho completo do arquivo local

fileURL: FileURL

URL do arquivo

options: IUploadToAzureFileOptions

Devoluções

Promise<void>

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um fluxo Node.js legível em um arquivo do Azure. Esse método tentará criar um Azure e, em seguida, começará a carregar bloco por bloco. O tamanho do bloco é definido por bufferSize parâmetro. Certifique-se de que o tamanho potencial do fluxo não exceda o tamanho do arquivo.

DICAS DE MELHORIA DE DESEMPENHO:

O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações Buffer.concat().

function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Parâmetros

aborter: Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

stream: Readable

Node.js Fluxo legível. Deve ser menor ou igual ao tamanho do arquivo.

size: number

Tamanho do arquivo a ser criado. O tamanho máximo permitido é de 1TB. Se esse valor for maior do que o tamanho do fluxo, haverá bytes vazios na cauda do arquivo.

fileURL: FileURL

Uma instância FileURL

bufferSize: number

Tamanho de cada buffer alocado em bytes, também o tamanho do bloco/intervalo durante o arquivo carregado. O tamanho deve ser > 0 e <= 4 * 1024 * 1024 (4MB)

maxBuffers: number

Buffers máximos serão alocados durante o upload, correlação positiva com simultaneidade máxima de upload

options: IUploadStreamToAzureFileOptions

Devoluções

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Parâmetros

fileAttributes: FileSystemAttributes | FileAttributesPreserveType

Devoluções

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Parâmetros

time: Date | TimeNowType | TimePreserveType

Devoluções

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Parâmetros

time: Date | TimeNowType | TimePreserveType

Devoluções

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Parâmetros

options: IFileAndDirectoryCreateCommonOptions

Devoluções

IFileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Parâmetros

options: IFileAndDirectorySetPropertiesCommonOptions

Devoluções

IFileAndDirectorySetPropertiesCommonOptions

validateFilePermissionOptions(undefined | string, undefined | string)

function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)

Parâmetros

filePermission: undefined | string

filePermissionKey: undefined | string

NewRetryPolicyFactory(IRetryOptions)

Um método de fábrica usado para gerar uma fábrica RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Parâmetros

retryOptions: IRetryOptions

Devoluções

RequestPolicyFactory

blobToArrayBuffer(Blob)

Converta um objeto Browser Blob em ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Parâmetros

blob: Blob

Devoluções

Promise<ArrayBuffer>

appendToURLPath(string, string)

Anexe uma cadeia de caracteres ao caminho da URL. Removerá "/" duplicado na frente da cadeia de caracteres quando o caminho da URL terminar com um "/".

function appendToURLPath(url: string, name: string)

Parâmetros

url: string

Cadeia de caracteres de URL de origem

name: string

String a ser anexada ao URL

Devoluções

string

Uma cadeia de caracteres de URL atualizada

base64decode(string)

Decodificação Base64.

function base64decode(encodedString: string)

Parâmetros

encodedString: string

Devoluções

string

base64encode(string)

Codificação Base64.

function base64encode(content: string)

Parâmetros

content: string

Devoluções

string

delay(number, AbortSignalLike, Error)

Atrasar o intervalo de tempo especificado.

function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)

Parâmetros

timeInMs: number

aborter: AbortSignalLike

abortError: Error

Devoluções

Promise<unknown>

escapeURLPath(string)

Os caracteres de URL reservados devem ser escapados corretamente para serviços de armazenamento como Blob ou Arquivo.

Estratégia de codificação e escape de URL para SDKs JSv10

Quando os clientes passam uma cadeia de caracteres de URL para o construtor de classes XXXURL, a cadeia de caracteres de URL pode já estar codificada por URL ou não. Mas antes de enviar para o servidor de Armazenamento do Azure, a URL deve ser codificada. No entanto, é difícil para um SDK adivinhar se a cadeia de caracteres de URL foi codificada ou não. Temos 2 estratégias potenciais, e escolhemos a estratégia duas para os construtores XXXURL.

Estratégia um: suponha que a cadeia de caracteres de URL do cliente não está codificada e sempre codifique a cadeia de caracteres de URL no SDK.

Isso é o que o SDK V2 legado faz, simples e funciona para a maioria dos casos.

Quando a cadeia de caracteres de URL do cliente for "http://account.blob.core.windows.net/con/b:", o SDK a codificará para "http://account.blob.core.windows.net/con/b%3A" e enviar para o servidor. Um blob chamado "b:" será criado.
Quando a cadeia de caracteres de URL do cliente for "http://account.blob.core.windows.net/con/b%3A", o SDK a codificará para "http://account.blob.core.windows.net/con/b%253A" e enviar para o servidor. Um blob chamado "b%3A" será criado.

Mas esta estratégia fará com que não seja possível criar um blob com "?" no seu nome. Porque quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/blob?name", o "?nome" será tratado como paramter de URL em vez de nome de blob. Se a cadeia de caracteres de URL do cliente for "http://account.blob.core.windows.net/con/blob%3Fname", um blob chamado "blob%3Fname" será criado. O SDK V2 não tem esse problema porque não permite que o cliente passe em uma URL completa, aceita um nome de blob separado e codifica URIComponent para ele. Não podemos aceitar que um SDK não possa criar um nome de blob com "?". Assim, implementamos a estratégia dois:

Estratégia dois: o SDK não assume que a URL foi codificada ou não. Ele apenas escapará dos caracteres especiais.

Isso é o que o V10 Blob Go SDK faz. Ele aceita um tipo de URL em Go, e chamar url. EscapedPath() para escapar dos chars especiais sem escapar.

Quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/b:", o SDK escapará de ":" como "http://account.blob.core.windows.net/con/b%3A" e enviar para o servidor. Um blob chamado "b:" será criado.
Quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/b%3A", Não há caracteres especiais, então envie "http://account.blob.core.windows.net/con/b%3A" ao servidor. Um blob chamado "b:" será criado.
Quando a cadeia de caracteres de URL do cliente é "http://account.blob.core.windows.net/con/b%253A", Não há caracteres especiais, então envie "http://account.blob.core.windows.net/con/b%253A" ao servidor. Um blob chamado "b%3A" será criado.

Esta estratégia dá-nos flexibilidade para criar com quaisquer caracteres especiais. Mas "%" será tratado como um caractere especial, se a string de URL não estiver codificada, não deve haver um "%" na string de URL, caso contrário, a URL não é uma URL válida. Se o cliente precisar criar um blob com "%" no nome do blob, use "%25" insead de "%". Assim como acima da 3ª amostra. E as seguintes cadeias de caracteres de URL são inválidas:

"http://account.blob.core.windows.net/con/b%"
"http://account.blob.core.windows.net/con/b%2"
"http://account.blob.core.windows.net/con/b%G"

Outro caractere especial é "?", use "%2F" para representar um nome de blob com "?" em uma cadeia de caracteres de URL.

Estratégia para containerName, blobName ou outros parâmetros XXXName específicos em métodos como `BlobURL.fromContainerURL(containerURL, blobName)`

Vamos aplicar a estratégia um e chamar encodeURIComponent para esses parâmetros como blobName. Porque o que os clientes passam é um nome simples em vez de um URL.

function escapeURLPath(url: string)

Parâmetros

url: string

Devoluções

string

getURLParameter(string, string)

Obter parâmetro de URL por nome.

function getURLParameter(url: string, name: string)

Parâmetros

url: string

name: string

Devoluções

string | string[] | undefined

getURLPath(string)

Obter caminho de URL de uma cadeia de caracteres de URL.

function getURLPath(url: string)

Parâmetros

url: string

Cadeia de caracteres de URL de origem

Devoluções

string | undefined

getURLQueries(string)

Obtenha pares de valores de chave de consulta de URL a partir de uma cadeia de caracteres de URL.

function getURLQueries(url: string)

Parâmetros

url: string

Devoluções

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

function padStart(currentString: string, targetLength: number, padString?: undefined | string)

Parâmetros

currentString: string

targetLength: number

padString: undefined | string

Devoluções

string

setURLHost(string, string)

Definir host de URL.

function setURLHost(url: string, host: string)

Parâmetros

url: string

Cadeia de caracteres de URL de origem

host: string

Nova cadeia de caracteres de host

Devoluções

string

Uma cadeia de caracteres de URL atualizada

setURLParameter(string, string, undefined | string)

Defina o nome e o valor do parâmetro de URL. Se o nome existir nos parâmetros de URL, o valor antigo será substituído pela chave de nome. Se não fornecer valor, o parâmetro será excluído.

function setURLParameter(url: string, name: string, value?: undefined | string)

Parâmetros

url: string

Cadeia de caracteres de URL de origem

name: string

Nome do parâmetro

value: undefined | string

Devoluções

string

Uma cadeia de caracteres de URL atualizada

truncatedISO8061Date(Date, undefined | false | true)

Arredonda uma data para segundos.

function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)

Parâmetros

date: Date

withMilliseconds: undefined | false | true

Devoluções

string

Cadeia de caracteres de data no formato ISO8061, com ou sem componente de 7 milissegundos

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Lê um fluxo legível no buffer. Preencha o buffer do deslocamento ao fim.

function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)

Parâmetros

stream: ReadableStream

Um fluxo legível Node.js

buffer: Buffer

Buffer a ser preenchido, comprimento deve >= deslocamento

offset: number

A partir de qual posição no buffer a ser preenchido, inclusive

end: number

Para qual posição no tampão a ser preenchido, exclusivo

encoding: undefined | string

Devoluções

Promise<void>

Comentários

Esta página foi útil?

Partilhar via

@azure/storage-file package

Classes

Interfaces

Aliases de Tipo

Enumerações

Funções

Estratégia de codificação e escape de URL para SDKs JSv10

Estratégia um: suponha que a cadeia de caracteres de URL do cliente não está codificada e sempre codifique a cadeia de caracteres de URL no SDK.

Estratégia dois: o SDK não assume que a URL foi codificada ou não. Ele apenas escapará dos caracteres especiais.

Estratégia para containerName, blobName ou outros parâmetros XXXName específicos em métodos como BlobURL.fromContainerURL(containerURL, blobName)

Detalhes de Função

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

Parâmetros

Devoluções

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

Parâmetros

Devoluções

ipRangeToString(IIPRange)

Parâmetros

Devoluções

rangeToString(IRange)

Parâmetros

Devoluções

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

Parâmetros

Devoluções

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

Parâmetros

Devoluções

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

Parâmetros

Devoluções

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

Parâmetros

Devoluções

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)

Parâmetros

Devoluções

fileCreationTimeToString(Date | TimeNowType | TimePreserveType)

Parâmetros

Devoluções

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)

Parâmetros

Devoluções

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)

Parâmetros

Devoluções

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)

Parâmetros

Devoluções

validateFilePermissionOptions(undefined | string, undefined | string)

Parâmetros

NewRetryPolicyFactory(IRetryOptions)

Parâmetros

Devoluções

blobToArrayBuffer(Blob)

Parâmetros

Devoluções

appendToURLPath(string, string)

Parâmetros

Devoluções

base64decode(string)

Parâmetros

Devoluções

base64encode(string)

Parâmetros

Devoluções

delay(number, AbortSignalLike, Error)

Parâmetros

Devoluções

escapeURLPath(string)

Estratégia de codificação e escape de URL para SDKs JSv10

Estratégia um: suponha que a cadeia de caracteres de URL do cliente não está codificada e sempre codifique a cadeia de caracteres de URL no SDK.

Estratégia dois: o SDK não assume que a URL foi codificada ou não. Ele apenas escapará dos caracteres especiais.

Estratégia para containerName, blobName ou outros parâmetros XXXName específicos em métodos como BlobURL.fromContainerURL(containerURL, blobName)

Parâmetros

Devoluções

getURLParameter(string, string)

Parâmetros

Estratégia para containerName, blobName ou outros parâmetros XXXName específicos em métodos como `BlobURL.fromContainerURL(containerURL, blobName)`

Estratégia para containerName, blobName ou outros parâmetros XXXName específicos em métodos como `BlobURL.fromContainerURL(containerURL, blobName)`