@azure/storage-file-share package
Classes
AccountSASPermissions |
DISPONÍVEL SOMENTE 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 é específica e essa classe garante a exatidão. |
AccountSASResourceTypes |
DISPONÍVEL SOMENTE 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 é específica e essa classe garante a exatidão. |
AccountSASServices |
DISPONÍVEL SOMENTE 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 é específica e essa classe garante a exatidã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 |
Credential é 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 SOMENTE 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 é específica e essa classe garante a exatidão. |
FileSystemAttributes |
Essa é uma classe auxiliar para construir uma cadeia de caracteres que representa os atributos NTFS para um arquivo ou diretório. Veja https://docs.microsoft.com/en-us/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. |
RestError |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
SASQueryParameters |
Representa os componentes que compõem os parâmetros de consulta de uma SAS do 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 a uma URL diretamente (embora seja necessário ter cuidado aqui caso haja 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. Ver https://docs.microsoft.com/rest/api/storageservices/lease-file e ver https://docs.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 é específica e essa classe garante a exatidão. |
ShareServiceClient |
Um ShareServiceClient representa uma URL para o serviço de Arquivo de Armazenamento do Azure, permitindo que você manipule compartilhamentos de arquivos. |
StorageBrowserPolicy |
StorageBrowserPolicy lidará com diferenças entre Node.js e o runtime do navegador, incluindo:
|
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 implementadas. |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory é uma classe de fábrica que ajuda a gerar objetos StorageRetryPolicy . |
StorageSharedKeyCredential |
DISPONÍVEL SOMENTE 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 SOMENTE 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 pode realmente 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://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obter mais informações conceituais sobre SAS Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas para obter descrições dos parâmetros, incluindo quais são necessários |
ClearRange | |
CloseHandlesInfo |
Fechar manipula informações de resultado. |
CommonGenerateSasUrlOptions |
Opções comuns de ShareGenerateSasUrlOptions e FileGenerateSasUrlOptions. |
CommonOptions |
Uma interface para opções comuns a cada operação remota. |
CopyFileSmbInfo |
Grupo de parâmetros |
CorsRule |
O 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 evita que uma página da Web chame as 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 solicitação de identificadores de fechamento. |
DirectoryCreateHeaders |
Define cabeçalhos para Directory_create operação. |
DirectoryCreateIfNotExistsResponse |
Contém dados de resposta para a createIfNotExists(DirectoryCreateOptions) operação. |
DirectoryCreateOptions |
Opções para configurar a operação de criação . |
DirectoryDeleteHeaders |
Define cabeçalhos para Directory_delete operação. |
DirectoryDeleteIfExistsResponse |
Contém dados de resposta para a deleteIfExists(DirectoryDeleteOptions) operação. |
DirectoryDeleteOptions |
Opções para configurar a operação de exclusão . |
DirectoryExistsOptions |
Opções para configurar a operação existente . |
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 operações de segmento de identificadores de fechamento. Consulte:
|
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 a operação 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 Diretório – Listar Identificadores de Segmento. Consulte:
|
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 a operação de renomeaçã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 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 solicitação de identificadores de fechamento. |
FileCreateHeaders |
Define cabeçalhos para File_create operação. |
FileCreateOptions |
Opções para configurar a operação de criação . |
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 . |
FileDownloadHeaders |
Define cabeçalhos para File_download operação. |
FileDownloadOptionalParams |
Parâmetros opcionais. |
FileDownloadOptions |
Opções para configurar o Arquivo – Operações de download. Consulte: |
FileDownloadToBufferOptions |
Interface de opção para a operação downloadToBuffer . |
FileExistsOptions |
Opções para configurar a operação existente . |
FileForceCloseHandlesHeaders |
Define cabeçalhos para File_forceCloseHandles operação. |
FileForceCloseHandlesOptions |
Opções para configurar as operações Arquivo – Forçar Fechar Identificadores. Consulte:
|
FileGenerateSasUrlOptions |
Opções para configurar a operação 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 getRangeList . |
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. Consulte:
|
FileParallelUploadOptions |
Interface de opção para operações de Arquivo – Carregar Consulte:
|
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 a operação de renomeação . |
FileResizeOptions |
Opções para configurar a operação de redimensionamento . |
FileSASSignatureValues |
DISPONÍVEL SOMENTE 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 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 startCopyFromURL . |
FileUploadRangeFromURLHeaders |
Define cabeçalhos para File_uploadRangeFromURL operação. |
FileUploadRangeFromURLOptionalParams |
Parâmetros opcionais. |
FileUploadRangeFromURLOptions |
Opções para configurar a operação 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 |
Abstrato para 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 nos 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. |
IHttpClient |
Uma interface compatível para políticas de solicitação core-http |
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. |
PipelineLike |
Uma interface para a 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. |
PipelineOptions |
Interface de opção para o construtor pipeline. |
Range |
Intervalo para operações de serviço. |
RangeModel |
Um intervalo de arquivos do Armazenamento do Azure. |
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 tipado. |
RetentionPolicy |
A política de retenção. |
SasIPRange |
Intervalo de IP permitido para uma SAS. |
ServiceClientOptions |
Um subconjunto de |
ServiceGenerateAccountSasUrlOptions |
Opções para configurar a operação 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 <xref:ShareServiceClient.undelete> operação. |
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 createIfNotExists . |
ShareCreateOptions |
Opções para configurar a operação de criaçã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 . |
ShareExistsOptions |
Opções para configurar a operação existente . |
ShareFileRangeList |
A lista de intervalos de arquivos |
ShareGenerateSasUrlOptions |
Opções para configurar a operação generateSasUrl . |
ShareGetAccessPolicyHeaders |
Define cabeçalhos para Share_getAccessPolicy operação. |
ShareGetAccessPolicyOptions |
Opções para configurar a operação 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 a serem habilitados no compartilhamento. Por enquanto, só dá suporte a SMB ou NFS. |
ShareSetAccessPolicyHeaders |
Define cabeçalhos para Share_setAccessPolicy operação. |
ShareSetAccessPolicyOptions |
Opções para configurar a operação 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 para multicanal SMB |
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. |
CredentialPolicyCreator |
Uma função de fábrica que cria uma nova CredentialPolicy que usa a nextPolicy fornecida. |
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. |
FileCreateResponse |
Contém dados de resposta para a operação de criação. |
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 getRangeList . |
FileLastWrittenMode |
Define valores para FileLastWrittenMode. |
FileListHandlesResponse |
Contém dados de resposta para a operação listHandles. |
FilePermissionInheritType |
Indica a permissão 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 e () => ReadableStream 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. |
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 . |
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. Valores conhecidos compatíveis com o serviçobackup |
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 de _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
generate |
DISPONÍVEL SOMENTE 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
generate |
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Cria uma instância de SASQueryParameters. Aceita apenas as configurações necessárias 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, permissões e expiraOn são necessárias. Você DEVE atribuir o valor ao identificador ou expirarEm permissões de & manualmente se você iniciar com esse construtor. |
get |
Para obter o público-alvo do OAuth para uma conta de armazenamento para o serviço de arquivo. |
is |
Um auxiliar para decidir se um determinado argumento satisfaz o contrato de pipeline |
new |
Cria um novo objeto Pipeline com a Credencial fornecida. |
Detalhes da função
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL SOMENTE 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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Parâmetros
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Retornos
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.
Cria uma instância de SASQueryParameters.
Aceita apenas as configurações necessárias 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, permissões e expiraOn são necessárias. Você DEVE atribuir o valor ao identificador ou expirarEm permissões de & manualmente se você iniciar com esse construtor.
function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Parâmetros
- fileSASSignatureValues
- FileSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Retornos
getFileServiceAccountAudience(string)
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
isPipelineLike(unknown)
Um auxiliar para decidir se um determinado argumento satisfaz o contrato de 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 de pipeline
newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)
Cria um novo objeto Pipeline com a Credencial fornecida.
function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline
Parâmetros
- credential
Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity
pacote 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
Opcional. Opções.
Retornos
Um novo objeto Pipeline.