FileShares interface
Interface que representa um FileShares.
Métodos
| create(string, string, string, File |
Cria uma nova partilha na conta especificada, conforme descrito pelo corpo do pedido. O recurso de partilha inclui metadados e propriedades para essa partilha. Não inclui uma lista dos ficheiros contidos pela partilha. |
| delete(string, string, string, File |
Elimina a partilha especificada na respetiva conta. |
| get(string, string, string, File |
Obtém as propriedades de uma partilha especificada. |
| lease(string, string, string, File |
A operação Partilha de Concessão estabelece e gere um bloqueio numa partilha para operações de eliminação. A duração do bloqueio pode ser de 15 a 60 segundos ou pode ser infinita. |
| list(string, string, File |
Lista todas as partilhas. |
| restore(string, string, string, Deleted |
Restaurar uma partilha de ficheiros dentro de dias de retenção válidos se a eliminação recuperável da partilha estiver ativada |
| update(string, string, string, File |
Atualizações partilhar propriedades conforme especificado no corpo do pedido. As propriedades não mencionadas no pedido não serão alteradas. A atualização falha se a partilha especificada ainda não existir. |
Detalhes de Método
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
Cria uma nova partilha na conta especificada, conforme descrito pelo corpo do pedido. O recurso de partilha inclui metadados e propriedades para essa partilha. Não inclui uma lista dos ficheiros contidos pela partilha.
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 subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.
- accountName
-
string
O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.
- shareName
-
string
O nome da partilha de ficheiros na conta de armazenamento especificada. Os nomes das partilhas de ficheiros têm de ter entre 3 e 63 carateres de comprimento e utilizar números, letras minúsculas e apenas travessão (-). Cada traço (-) tem de ser imediatamente precedido e seguido de uma letra ou número.
- fileShare
- FileShare
Propriedades da partilha de ficheiros a criar.
- options
- FileSharesCreateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
Elimina a partilha especificada na respetiva conta.
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.
- accountName
-
string
O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.
- shareName
-
string
O nome da partilha de ficheiros na conta de armazenamento especificada. Os nomes das partilhas de ficheiros têm de ter entre 3 e 63 carateres de comprimento e utilizar números, letras minúsculas e apenas travessão (-). Cada traço (-) tem de ser imediatamente precedido e seguido de uma letra ou número.
- options
- FileSharesDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
Obtém as propriedades de uma partilha especificada.
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.
- accountName
-
string
O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.
- shareName
-
string
O nome da partilha de ficheiros na conta de armazenamento especificada. Os nomes das partilhas de ficheiros têm de ter entre 3 e 63 carateres de comprimento e utilizar números, letras minúsculas e apenas travessão (-). Cada traço (-) tem de ser imediatamente precedido e seguido de uma letra ou número.
- options
- FileSharesGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
A operação Partilha de Concessão estabelece e gere um bloqueio numa partilha para operações de eliminaçã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 subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.
- accountName
-
string
O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.
- shareName
-
string
O nome da partilha de ficheiros na conta de armazenamento especificada. Os nomes das partilhas de ficheiros têm de ter entre 3 e 63 carateres de comprimento e utilizar números, letras minúsculas e apenas travessão (-). Cada traço (-) tem de ser imediatamente precedido e seguido de uma letra ou número.
- options
- FileSharesLeaseOptionalParams
Os parâmetros de opções.
Devoluções
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
Lista todas as partilhas.
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos na subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.
- accountName
-
string
O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.
- options
- FileSharesListOptionalParams
Os parâmetros de opções.
Devoluções
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
Restaurar uma partilha de ficheiros dentro de dias de retenção válidos se a eliminação recuperável da partilha estiver ativada
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 subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.
- accountName
-
string
O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.
- shareName
-
string
O nome da partilha de ficheiros na conta de armazenamento especificada. Os nomes das partilhas de ficheiros têm de ter entre 3 e 63 carateres de comprimento e utilizar números, letras minúsculas e apenas travessão (-). Cada traço (-) tem de ser imediatamente precedido e seguido de uma letra ou número.
- deletedShare
- DeletedShare
A partilha eliminada a restaurar.
- options
- FileSharesRestoreOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
Atualizações partilhar propriedades conforme especificado no corpo do pedido. As propriedades não mencionadas no pedido não serão alteradas. A atualização falha se a partilha especificada 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 subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas.
- accountName
-
string
O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas.
- shareName
-
string
O nome da partilha de ficheiros na conta de armazenamento especificada. Os nomes das partilhas de ficheiros têm de ter entre 3 e 63 carateres de comprimento e utilizar números, letras minúsculas e apenas travessão (-). Cada traço (-) tem de ser imediatamente precedido e seguido de uma letra ou número.
- fileShare
- FileShare
Propriedades a atualizar para a partilha de ficheiros.
- options
- FileSharesUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<FileShare>