@azure/storage-file-share package

Classes

AccountSASPermissions	DISPONÍVEL APENAS EM NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto AccountSASSignatureValues. É possível construir a cadeia de caracteres 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 NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de recursos em um objeto AccountSASSignatureValues. É 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 NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de serviços em um objeto AccountSASSignatureValues. É 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.
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 SAS (Assinaturas de Acesso Compartilhado).
AnonymousCredentialPolicy	AnonymousCredentialPolicy é usado com solicitações HTTP(S) que leem recursos públicos ou para uso com SAS (Assinaturas de Acesso Compartilhado).
BaseRequestPolicy	A classe base da qual todas as políticas de solicitação derivam.
Credential	A credencial é uma classe abstrata para assinatura de solicitações HTTP do Armazenamento do Azure. Essa classe hospedará uma fábrica credentialPolicyCreator que gera CredentialPolicy.
CredentialPolicy	Política de credencial usada para assinar solicitações HTTP(S) antes de enviar. Esta é uma classe abstrata.
FileSASPermissions	DISPONÍVEL APENAS EM NODE.JS RUNTIME. Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto FileSASSignatureValues. É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
FileSystemAttributes	Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa os atributos NTFS para um arquivo ou diretório. Consulte https://learn.microsoft.com/rest/api/storageservices/create-file#file-system-attributes
Pipeline	Uma classe pipeline que contém políticas de solicitação HTTP. Você pode criar um Pipeline padrão chamando newPipeline. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor do Pipeline. Consulte newPipeline e as políticas fornecidas antes de implementar seu Pipeline personalizado.
SASQueryParameters	Representa os componentes que compõem os parâmetros de consulta de uma SAS de Armazenamento do Azure. Esse tipo não é construído diretamente pelo usuário; ele só é gerado pelos tipos AccountSASSignatureValues e FileSASSignatureValues. Uma vez gerado, ele pode ser codificado em um toString() e acrescentado diretamente a uma URL (embora seja necessário ter cuidado aqui no caso de haver parâmetros de consulta existentes, o que pode afetar os meios apropriados de acrescentar esses parâmetros de consulta). OBSERVAÇÃO: as instâncias dessa classe são imutáveis.
ShareClient	Um ShareClient representa uma URL para o compartilhamento de Armazenamento do Azure, permitindo que você manipule seus diretórios e arquivos.
ShareDirectoryClient	Um ShareDirectoryClient representa uma URL para o diretório do Armazenamento do Azure, permitindo que você manipule seus arquivos e diretórios.
ShareFileClient	Um ShareFileClient representa uma URL para um arquivo de Armazenamento do Azure.
ShareLeaseClient	Um cliente que gerencia concessões para um ShareFileClient ou ShareClient. Consulte https://learn.microsoft.com/rest/api/storageservices/lease-file e Ver https://learn.microsoft.com/rest/api/storageservices/lease-share
ShareSASPermissions	Essa é 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 forem definidos, isso deverá ser serializado com toString e definido como o campo de permissões em um objeto FileSASSignatureValues. É possível construir a cadeia de caracteres de permissões sem essa classe, mas a ordem das permissões é particular e essa classe garante a correção.
ShareServiceClient	Um ShareServiceClient representa uma URL para o serviço de Arquivo de Armazenamento do Azure, permitindo que você manipule compartilhamentos de arquivos.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageBrowserPolicy.
StorageRetryPolicy	Política de repetição com repetição exponencial e repetição linear implementada.
StorageRetryPolicyFactory	StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageRetryPolicy.
StorageSharedKeyCredential	DISPONÍVEL APENAS EM NODE.JS RUNTIME. StorageSharedKeyCredential para autorização de chave de conta do serviço de Armazenamento do Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy é uma política usada para assinar uma solicitação HTTP com uma chave compartilhada.

Interfaces

AccessPolicy	Uma política de acesso.
AccountSASSignatureValues	DISPONÍVEL APENAS EM NODE.JS RUNTIME. AccountSASSignatureValues é usado para gerar uma SAS (Assinatura de Acesso Compartilhado) para uma conta de Armazenamento do Azure. Depois que todos os valores aqui forem definidos adequadamente, chame generateAccountSASQueryParameters para obter uma representação da SAS que, na verdade, pode ser aplicada às urls de arquivo. Observação: essa classe e SASQueryParameters existem porque a primeira é mutável e uma representação lógica enquanto a última é imutável e usada para gerar solicitações REST reais. Consulte https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceituais sobre SAS Consulte https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas para obter descrições dos parâmetros, incluindo os quais são necessários
ClearRange
CloseHandlesInfo	Fechar manipula as informações de resultado.
CommonGenerateSasUrlOptions	Opções comuns das ShareGenerateSasUrlOptions e FileGenerateSasUrlOptions.
CommonOptions	Uma interface para opções comuns a cada operação remota.
CopyFileSmbInfo	Grupo de parâmetros
CorsRule	CORS é um recurso HTTP que permite que um aplicativo Web em execução 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 uma página da Web de chamar 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.
DirectoryCloseHandlesHeaders	Valores de cabeçalho de resposta adicionais para a solicitação close handles.
DirectoryCreateHeaders	Define cabeçalhos para Directory_create operação.
DirectoryCreateIfNotExistsResponse	Contém dados de resposta para a operação de createIfNotExists(DirectoryCreateOptions).
DirectoryCreateOptions	Opções para configurar criar operação.
DirectoryDeleteHeaders	Define cabeçalhos para Directory_delete operação.
DirectoryDeleteIfExistsResponse	Contém dados de resposta para a operação de deleteIfExists(DirectoryDeleteOptions).
DirectoryDeleteOptions	Opções para configurar a operação de exclusão de .
DirectoryExistsOptions	Há opções para configurar o operação.
DirectoryForceCloseHandlesHeaders	Define cabeçalhos para Directory_forceCloseHandles operação.
DirectoryForceCloseHandlesOptions	Opções para configurar forceCloseHandle.
DirectoryForceCloseHandlesSegmentOptions	Opções para configurar o Diretório – forçar o fechamento de operações do segmento de identificadores. See: <xref:ShareDirectoryClient.forceCloseHandlesSegment> forceCloseAllHandles
DirectoryGetPropertiesHeaders	Define cabeçalhos para Directory_getProperties operação.
DirectoryGetPropertiesOptions	Opções para configurar a operação getProperties.
DirectoryItem	Um item de diretório listado.
DirectoryListFilesAndDirectoriesOptions	Opções para configurar operação de listFilesAndDirectories.
DirectoryListFilesAndDirectoriesSegmentHeaders	Define cabeçalhos para Directory_listFilesAndDirectoriesSegment operação.
DirectoryListHandlesHeaders	Define cabeçalhos para Directory_listHandles operação.
DirectoryListHandlesOptions	Opções para configurar a operação listHandles.
DirectoryListHandlesSegmentOptions	Opções para configurar operações de Segmento de Identificadores de Lista – Diretórios de Lista. See: <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	Uma interface para opções comuns a cada operação remota.
DirectoryRenameHeaders	Define cabeçalhos para Directory_rename operação.
DirectoryRenameOptions	Opções para configurar o renomear operação.
DirectorySetMetadataHeaders	Define cabeçalhos para Directory_setMetadata operação.
DirectorySetMetadataOptions	Opções para configurar a operação setMetadata.
DirectorySetPropertiesHeaders	Define cabeçalhos para Directory_setProperties operação.
FileAbortCopyFromURLOptions	Opções para configurar a operação de abortCopyFromURL.
FileAbortCopyHeaders	Define cabeçalhos para File_abortCopy operação.
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	Opções para configurar a operação clearRange .
FileCloseHandlesHeaders	Valores de cabeçalho de resposta adicionais para a solicitação close handles.
FileCreateHardLinkHeaders	Define cabeçalhos para File_createHardLink operação.
FileCreateHardLinkOptions	Opções para configurar o Arquivo – Criar operações de Link Rígido. See: createHardLink
FileCreateHeaders	Define cabeçalhos para File_create operação.
FileCreateOptions	Opções para configurar o criar operação.
FileCreateSymbolicLinkHeaders	Define cabeçalhos para File_createSymbolicLink operação.
FileCreateSymbolicLinkOptions	Opções para configurar operações de Arquivo - Criar Link Simbólico. See: createSymbolicLink
FileDeleteHeaders	Define cabeçalhos para File_delete operação.
FileDeleteIfExistsResponse	Contém dados de resposta para a operação deleteIfExists.
FileDeleteOptions	Opções para configurar a operação de exclusão de .
FileDownloadHeaders	Define cabeçalhos para File_download operação.
FileDownloadOptionalParams	Parâmetros opcionais.
FileDownloadOptions	Opções para configurar o Arquivo – Operações de download. See: download downloadToFile
FileDownloadToBufferOptions	Interface de opção para a operação baixar o ToBuffer.
FileExistsOptions	Há opções para configurar o operação.
FileForceCloseHandlesHeaders	Define cabeçalhos para File_forceCloseHandles operação.
FileForceCloseHandlesOptions	Opções para configurar as operações Arquivo – Forçar Fechar Identificadores. See: <xref:ShareFileClient.forceCloseHandlesSegment> forceCloseAllHandles forceCloseHandle
FileGenerateSasUrlOptions	Opções para configurar a operação de generateSasUrl.
FileGetPropertiesHeaders	Define cabeçalhos para File_getProperties operação.
FileGetPropertiesOptions	Opções para configurar a operação getProperties.
FileGetRangeListHeaders	Define cabeçalhos para File_getRangeList operação.
FileGetRangeListOptions	Opções para configurar a operação de getRangeList.
FileGetSymbolicLinkHeaders	Define cabeçalhos para File_getSymbolicLink operação.
FileGetSymbolicLinkOptions	Opções para configurar operações de Arquivo – Obter Link Simbólico. See: getSymbolicLink
FileHttpHeaders
FileItem	Um item de arquivo listado.
FileListHandlesHeaders	Define cabeçalhos para File_listHandles operação.
FileListHandlesOptions	Uma interface para opções comuns a cada operação remota.
FileListHandlesSegmentOptions	Opções para configurar operações de Segmento de Identificadores de Arquivo – Lista. See: <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions	Interface de opção para Arquivo – Carregar operações See: uploadFile <xref:ShareFileClient.uploadSeekableStream>
FilePosixProperties	Propriedades NFS. Observe que essas propriedades se aplicam apenas a arquivos ou diretórios em contas de arquivo NFS premium.
FileProperties	Uma interface para opções comuns a cada operação remota.
FileProperty	Propriedades do arquivo.
FileRenameHeaders	Define cabeçalhos para File_rename operação.
FileRenameOptions	Opções para configurar o renomear operação.
FileResizeOptions	Opções para configurar a operação de redimensionamento .
FileSASSignatureValues	DISPONÍVEL APENAS EM NODE.JS RUNTIME. FileSASSignatureValues é usado para ajudar a gerar tokens SAS do serviço de arquivo para compartilhamentos ou arquivos.
FileServiceProperties	Propriedades do serviço de armazenamento.
FileSetHTTPHeadersHeaders	Define cabeçalhos para File_setHttpHeaders operação.
FileSetHttpHeadersOptions	Opções para configurar a operação de setHttpHeaders.
FileSetMetadataHeaders	Define cabeçalhos para File_setMetadata operação.
FileSetMetadataOptions	Opções para configurar a operação setMetadata.
FileStartCopyHeaders	Define cabeçalhos para File_startCopy operação.
FileStartCopyOptions	Opções para configurar a operação de startCopyFromURL.
FileUploadRangeFromURLHeaders	Define cabeçalhos para File_uploadRangeFromURL operação.
FileUploadRangeFromURLOptionalParams	Parâmetros opcionais.
FileUploadRangeFromURLOptions	Opções para configurar a operação de uploadRangeFromURL.
FileUploadRangeHeaders	Define cabeçalhos para File_uploadRange operação.
FileUploadRangeOptions	Opções para configurar a operação uploadRange.
FileUploadStreamOptions	Interface de opção para ShareFileClient.uploadStream().
FilesAndDirectoriesListSegment	Resumo das entradas que podem ser listadas no Diretório.
HandleItem	Um item de identificador do Armazenamento do Azure listado.
HttpAuthorization	Representa informações de autenticação em valores de cabeçalho Authorization, ProxyAuthorization, WWW-Authenticate e Proxy-Authenticate.
HttpHeaders	Uma coleção de pares chave/valor de cabeçalho HTTP.
HttpOperationResponse	Resposta Http compatível com o core-v1 (core-http).
HttpResponse	Uma representação de uma resposta HTTP que inclui uma referência à solicitação que a originou.
LeaseAccessConditions	Grupo de parâmetros
LeaseOperationOptions	opções de operações de concessão.
LeaseOperationResponseHeaders	Os detalhes da resposta para uma operação de concessão específica.
ListFilesAndDirectoriesSegmentResponse	Uma enumeração de diretórios e arquivos.
ListHandlesResponse	Uma enumeração de identificadores.
ListSharesResponse	Uma enumeração de compartilhamentos.
ListSharesResponseModel	Uma enumeração de compartilhamentos.
Metadata
Metrics	Métricas da Análise de Armazenamento para o serviço de arquivo.
NfsFileMode	As permissões de modo do arquivo ou diretório.
PipelineLike	Uma interface para a classe pipeline do que contém políticas de solicitação HTTP. Você pode criar um Pipeline padrão chamando newPipeline. Ou você pode criar um Pipeline com suas próprias políticas pelo construtor do Pipeline. Consulte newPipeline e as políticas fornecidas antes de implementar seu Pipeline personalizado.
PipelineOptions	Interface de opção para o construtor pipeline.
PosixRolePermissions	Representa permissões de arquivo para uma função específica.
Range	Intervalo para operações de serviço. Consulte https://learn.microsoft.com/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	Um intervalo de arquivos do Armazenamento do Azure.
RequestPolicy	Uma interface compatível para políticas de solicitação core-http
RequestPolicyFactory	Uma interface para compatibilidade com RequestPolicyFactory do core-http
RequestPolicyOptions	Uma interface para compatibilidade com RequestPolicy
ResponseLike	Um objeto com uma propriedade _response simples.
ResponseWithBody	Um objeto com uma propriedade _response que tem corpo e cabeçalhos já analisados em tipos conhecidos.
ResponseWithHeaders	Um objeto com uma propriedade _response que tem cabeçalhos já analisados em um objeto digitado.
RestError	Um tipo de erro personalizado para solicitações de pipeline com falha.
RetentionPolicy	A política de retenção.
SasIPRange	Intervalo de IP permitido para uma SAS.
ServiceClientOptions	Um subconjunto de `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Opções para configurar operação de generateAccountSasUrl.
ServiceGetPropertiesHeaders	Define cabeçalhos para Service_getProperties operação.
ServiceGetPropertiesOptions	Opções para configurar a operação getProperties.
ServiceListSharesOptions	Opções para configurar a operação listShares.
ServiceListSharesSegmentHeaders	Define cabeçalhos para Service_listSharesSegment operação.
ServiceSetPropertiesHeaders	Define cabeçalhos para Service_setProperties operação.
ServiceSetPropertiesOptions	Opções para configurar a operação setProperties.
ServiceUndeleteShareOptions	Opções para configurar a operação de <xref:ShareServiceClient.undelete>.
SetPropertiesResponse	Contém dados de resposta para a operação setHttpHeaders.
ShareClientConfig
ShareCreateHeaders	Define cabeçalhos para Share_create operação.
ShareCreateIfNotExistsResponse	Contém dados de resposta para a operação de createIfNotExists.
ShareCreateOptions	Opções para configurar o criar operação.
ShareCreatePermissionHeaders	Define cabeçalhos para Share_createPermission operação.
ShareCreatePermissionOptions	Opções para configurar a operação createPermission.
ShareCreateSnapshotHeaders	Define cabeçalhos para Share_createSnapshot operação.
ShareCreateSnapshotOptions	Opções para configurar a operação createSnapshot.
ShareDeleteHeaders	Define cabeçalhos para Share_delete operação.
ShareDeleteIfExistsResponse	Contém dados de resposta para a operação deleteIfExists.
ShareDeleteMethodOptions	Opções para configurar a operação de exclusão de .
ShareExistsOptions	Há opções para configurar o operação.
ShareFileRangeList	A lista de intervalos de arquivos
ShareGenerateSasUrlOptions	Opções para configurar a operação de generateSasUrl.
ShareGetAccessPolicyHeaders	Define cabeçalhos para Share_getAccessPolicy operação.
ShareGetAccessPolicyOptions	Opções para configurar a operação de getAccessPolicy.
ShareGetPermissionHeaders	Define cabeçalhos para Share_getPermission operação.
ShareGetPermissionOptions	Opções para configurar a operação getPermission.
ShareGetPropertiesHeaders	Define cabeçalhos para Share_getProperties operação.
ShareGetPropertiesOptions	Opções para configurar a operação getProperties.
ShareGetStatisticsHeaders	Define cabeçalhos para Share_getStatistics operação.
ShareGetStatisticsOptions	Opções para configurar a operação getStatistics.
ShareItem	Um item de compartilhamento do Armazenamento do Azure listado.
ShareItemInternal	Um item de compartilhamento do Armazenamento do Azure listado.
SharePermission	Uma permissão (um descritor de segurança) no nível do compartilhamento.
SharePropertiesInternal	Propriedades de um compartilhamento.
ShareProtocolSettings	Configurações de protocolo
ShareProtocols	Protocolos para habilitar no compartilhamento. Por enquanto, só há suporte para SMB ou NFS.
ShareSetAccessPolicyHeaders	Define cabeçalhos para Share_setAccessPolicy operação.
ShareSetAccessPolicyOptions	Opções para configurar a operação de setAccessPolicy.
ShareSetMetadataHeaders	Define cabeçalhos para Share_setMetadata operação.
ShareSetMetadataOptions	Opções para configurar a operação setMetadata.
ShareSetPropertiesHeaders	Define cabeçalhos para Share_setProperties operação.
ShareSetPropertiesOptions	Opções para configurar a operação setProperties.
ShareSetQuotaOptions	Opções para configurar a operação setQuota.
ShareSmbSettings	Configurações do protocolo SMB.
ShareStats	Estatísticas para o compartilhamento.
SignedIdentifier	Identificador assinado
SignedIdentifierModel	Identificador assinado.
SmbMultichannel	Configurações do SMB multichannel
SourceModifiedAccessConditions	Grupo de parâmetros
StoragePipelineOptions	Interface de opções para a função newPipeline.
StorageRetryOptions	Interface de opções de repetição do Blob de Armazenamento.
WebResource	Uma descrição de uma solicitação HTTP a ser feita a um servidor remoto.

Aliases de tipo

CopyStatusType	Define valores para CopyStatusType.
DeleteSnapshotsOptionType	Define valores para DeleteSnapshotsOptionType.
DirectoryCreateResponse	Contém dados de resposta para a operação de criação.
DirectoryDeleteResponse	Contém dados de resposta para a operação de exclusão.
DirectoryForceCloseHandlesResponse	Tipo de resposta para forceCloseHandle.
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.
DirectoryRenameResponse	Contém dados de resposta para a operação de renomeação.
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.
FileAttributesPreserveType	Indica manter os atributos de arquivo existentes inalterados.
FileCreateHardLinkResponse	Contém dados de resposta para a operação criar link rígido.
FileCreateResponse	Contém dados de resposta para a operação de criação.
FileCreateSymbolicLinkResponse	Contém dados de resposta para a operação criar link rígido.
FileDeleteResponse	Contém dados de resposta para a operação de exclusão.
FileDownloadResponseModel	Contém dados de resposta para a operação de download.
FileForceCloseHandlesResponse	Tipo de resposta para forceCloseHandle.
FileGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
FileGetRangeListDiffResponse	Contém dados de resposta para a operação getRangeList.
FileGetRangeListResponse	Contém dados de resposta para a operação de getRangeList.
FileGetSymbolicLinkResponse	Contém dados de resposta para a operação criar link rígido.
FileLastWrittenMode	Define valores para FileLastWrittenMode.
FileListHandlesResponse	Contém dados de resposta para a operação listHandles.
FilePermissionFormat	Define valores para FilePermissionFormat.
FilePermissionInheritType	Indica a permissão de herdar arquivo do diretório pai.
FilePermissionPreserveType	Indica manter o valor de permissão de arquivo existente inalterado.
FileRenameResponse	Contém dados de resposta para a operação de renomeação.
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.
FileUploadRangeFromURLResponse	Contém dados de resposta para a operação uploadRangeFromURL.
FileUploadRangeResponse	Contém dados de resposta para a operação uploadRange.
HttpRequestBody	Tipos de corpos com suporte na solicitação. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream<Uint8Array> e () => ReadableStream<Uint8Array> são somente navegador.
LeaseDurationType	Define valores para LeaseDurationType.
LeaseOperationResponse	Contém os dados de resposta para operações que adquirem, alteram, interrompem ou liberam uma concessão. Consulte ShareLeaseClient.
LeaseStateType	Define valores para LeaseStateType.
LeaseStatusType	Define valores para LeaseStatusType.
ListSharesIncludeType	Define valores para ListSharesIncludeType.
ModeCopyMode	Define valores para ModeCopyMode.
NfsFileType	Define valores para NfsFileType. <xref:KnownNfsFileType> pode ser usado de forma intercambiável com NfsFileType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Regular Directory SymLink
OwnerCopyMode	Define valores para OwnerCopyMode.
PermissionCopyModeType	Define valores para PermissionCopyModeType.
RawFileDownloadResponse	Contém dados de resposta para a operação de download.
ServiceGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
ServiceListSharesSegmentResponse	Contém dados de resposta para a operação listShares.
ServiceSetPropertiesResponse	Contém dados de resposta para a operação setProperties.
ShareAccessTier	Define valores para ShareAccessTier.
ShareClientOptions
ShareCreatePermissionResponse	Contém dados de resposta para a operação createPermission.
ShareCreateResponse	Contém dados de resposta para a operação de criação.
ShareCreateSnapshotResponse	Contém dados de resposta para a operação createSnapshot.
ShareDeleteResponse	Contém dados de resposta para a operação de exclusão.
ShareFileHandleAccessRights	Define valores para AccessRight.
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	Contém dados de resposta para a operação getPermission.
ShareGetPropertiesResponse	Contém dados de resposta para a operação getProperties.
ShareGetPropertiesResponseModel	Contém dados de resposta para a operação getProperties.
ShareGetStatisticsResponse	Dados de resposta para a operação getStatistics do.
ShareGetStatisticsResponseModel	Contém dados de resposta para a operação getStatistics.
ShareProperties	Propriedades de um compartilhamento.
ShareRootSquash	Define valores para ShareRootSquash.
ShareSetAccessPolicyResponse	Contém dados de resposta para a operação setAccessPolicy.
ShareSetMetadataResponse	Contém dados de resposta para a operação setMetadata.
ShareSetPropertiesResponse	Contém dados de resposta para a operação setProperties.
ShareSetQuotaHeaders	Define cabeçalhos para a operação setQuota.
ShareSetQuotaResponse	Contém dados de resposta para a operação setQuota.
ShareTokenIntent	Define valores para ShareTokenIntent. KnownShareTokenIntent pode ser usado de forma intercambiável com ShareTokenIntent, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço backup
TimeNowType	Indica a configuração como a hora da solicitação.
TimePreserveType	Indica manter o valor de tempo existente inalterado.
WithResponse	Um tipo que representa um resultado de operação com uma propriedade _response conhecida.

Enumerações

KnownShareTokenIntent	Valores conhecidos de ShareTokenIntent que o serviço aceita.
SASProtocol	Protocolos para SAS gerada.
StorageFileAudience	Define as audiências de nuvem conhecidas para Armazenamento.
StorageRetryPolicyType	Tipos RetryPolicy.

Funções

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	DISPONÍVEL APENAS EM NODE.JS RUNTIME. Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real. Consulte https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)	DISPONÍVEL APENAS EM NODE.JS RUNTIME. Cria uma instância de SASQueryParameters. Aceita apenas as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador. AVISO: quando o identificador não é fornecido, as permissões e expiraOn são necessárias. Você deve atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar com esse construtor.
getFileServiceAccountAudience(string)	Para obter o público-alvo do OAuth para uma conta de armazenamento para o serviço de arquivo.
isPipelineLike(unknown)	Um auxiliar para decidir se um determinado argumento satisfaz o contrato pipeline
newPipeline(Credential \| TokenCredential, StoragePipelineOptions)	Cria um novo objeto Pipeline com a Credencial fornecida.
parseOctalFileMode(string)	Analise a representação de cadeia de caracteres octal de 4 dígitos de um Modo de Arquivo para uma estrutura NfsFileMode .
parseSymbolicFileMode(string)	Analise uma representação de cadeia de caracteres simbólica de 9 caracteres de um Modo de Arquivo para uma estrutura NfsFileMode .
toOctalFileMode(NfsFileMode)	Converta a estrutura NfsFileMode em uma representação de cadeia de caracteres octal de 4 dígitos.
toSymbolicFileMode(NfsFileMode)	Converta um NfsFileMode em uma cadeia de caracteres em notação simbólica.

Detalhes da função

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

Gera um objeto SASQueryParameters que contém todos os parâmetros de consulta SAS necessários para fazer uma solicitação REST real.

Consulte https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parâmetros

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Retornos

SASQueryParameters

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

Cria uma instância de SASQueryParameters.

Aceita apenas as configurações necessárias para criar uma SAS. Para configurações opcionais, defina as propriedades correspondentes diretamente, como permissões, startsOn e identificador.

AVISO: quando o identificador não é fornecido, as permissões e expiraOn são necessárias. Você deve atribuir valor ao identificador ou expiraOn & permissões manualmente se você inicializar com esse construtor.

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parâmetros

fileSASSignatureValues: FileSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Retornos

SASQueryParameters

Para obter o público-alvo do OAuth para uma conta de armazenamento para o serviço de arquivo.

function getFileServiceAccountAudience(storageAccountName: string): string

Parâmetros

storageAccountName: string

Retornos

string

Um auxiliar para decidir se um determinado argumento satisfaz o contrato pipeline

function isPipelineLike(pipeline: unknown): pipeline

Parâmetros

pipeline: unknown

Um argumento que pode ser um Pipeline

Retornos

pipeline

true quando o argumento satisfaz o contrato pipeline

Cria um novo objeto Pipeline com a Credencial fornecida.

function newPipeline(credential?: Credential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parâmetros

credential: Credential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

pipelineOptions: StoragePipelineOptions

Optional. Options.

Retornos

Pipeline

Um novo objeto Pipeline.

Analise a representação de cadeia de caracteres octal de 4 dígitos de um Modo de Arquivo para uma estrutura NfsFileMode .

function parseOctalFileMode(input?: string): NfsFileMode | undefined

Parâmetros

input: string

Retornos

NfsFileMode | undefined

Analise uma representação de cadeia de caracteres simbólica de 9 caracteres de um Modo de Arquivo para uma estrutura NfsFileMode .

function parseSymbolicFileMode(input?: string): NfsFileMode | undefined

Parâmetros

input: string

Retornos

NfsFileMode | undefined

Converta a estrutura NfsFileMode em uma representação de cadeia de caracteres octal de 4 dígitos.

function toOctalFileMode(input?: NfsFileMode): string | undefined

Parâmetros

input: NfsFileMode

Retornos

string | undefined

Converta um NfsFileMode em uma cadeia de caracteres em notação simbólica.

function toSymbolicFileMode(input?: NfsFileMode): string | undefined

Parâmetros

input: NfsFileMode

Retornos

string | undefined

Compartilhar via

@azure/storage-file-share package

Classes

Interfaces

Aliases de tipo

Valores conhecidos compatíveis com o serviço

Valores conhecidos compatíveis com o serviço

Enumerações

Funções

Detalhes da função

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parâmetros

Retornos

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

Parâmetros

Retornos

getFileServiceAccountAudience(string)

Parâmetros

Retornos

isPipelineLike(unknown)

Parâmetros

Retornos

newPipeline(Credential | TokenCredential, StoragePipelineOptions)

Parâmetros

Retornos

parseOctalFileMode(string)

Parâmetros

Retornos

parseSymbolicFileMode(string)

Parâmetros

Retornos

toOctalFileMode(NfsFileMode)

Parâmetros

Retornos

toSymbolicFileMode(NfsFileMode)

Parâmetros

Retornos