FileShares interface
Interface que representa um FileShares.
Métodos
| create(string, string, string, File |
Cria um novo compartilhamento na conta especificada, conforme descrito pelo corpo da solicitação. O recurso do compartilhamento inclui os metadados e as propriedades desse compartilhamento. Ele não inclui uma lista dos arquivos presentes no compartilhamento. |
| delete(string, string, string, File |
Exclui o compartilhamento especificado em sua conta. |
| get(string, string, string, File |
Obtém as propriedades de um compartilhamento especificado. |
| lease(string, string, string, File |
A operação Lease Share estabelece e gerencia um bloqueio em um compartilhamento para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita. |
| list(string, string, File |
Lista todos os compartilhamentos. |
| restore(string, string, string, Deleted |
Restaurar um compartilhamento de arquivos em dias de retenção válidos se a exclusão reversível do compartilhamento estiver habilitada |
| update(string, string, string, File |
Atualizações compartilhar propriedades conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o compartilhamento especificado ainda não existir. |
Detalhes do método
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
Cria um novo compartilhamento na conta especificada, conforme descrito pelo corpo da solicitação. O recurso do compartilhamento inclui os metadados e as propriedades desse compartilhamento. Ele não inclui uma lista dos arquivos presentes no compartilhamento.
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.
- shareName
-
string
O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número.
- fileShare
- FileShare
Propriedades do compartilhamento de arquivos a ser criado.
- options
- FileSharesCreateOptionalParams
Os parâmetros de opções.
Retornos
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
Exclui o compartilhamento especificado em sua conta.
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.
- shareName
-
string
O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número.
- options
- FileSharesDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
Obtém as propriedades de um compartilhamento especificado.
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.
- shareName
-
string
O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número.
- options
- FileSharesGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
A operação Lease Share estabelece e gerencia um bloqueio em um compartilhamento para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita.
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.
- shareName
-
string
O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número.
- options
- FileSharesLeaseOptionalParams
Os parâmetros de opções.
Retornos
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
Lista todos os compartilhamentos.
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.
- options
- FileSharesListOptionalParams
Os parâmetros de opções.
Retornos
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
Restaurar um compartilhamento de arquivos em dias de retenção válidos se a exclusão reversível do compartilhamento estiver habilitada
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.
- shareName
-
string
O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número.
- deletedShare
- DeletedShare
O compartilhamento excluído a ser restaurado.
- options
- FileSharesRestoreOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
Atualizações compartilhar propriedades conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o compartilhamento especificado ainda não existir.
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas.
- accountName
-
string
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.
- shareName
-
string
O nome do compartilhamento de arquivos dentro da conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número.
- fileShare
- FileShare
Propriedades a serem atualizadas para o compartilhamento de arquivos.
- options
- FileSharesUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<FileShare>