Criar Partilha

A operação Create Share cria um novo compartilhamento de Arquivos do Azure na conta especificada. Embora essa API seja totalmente suportada, ela é uma API de gerenciamento herdada. Recomendamos que, em vez disso, você use Compartilhamentos de Arquivos - Criar, que é fornecido pelo provedor de recursos de Armazenamento do Azure (Microsoft.Storage). Para saber mais sobre como interagir programaticamente com recursos FileShare usando o provedor de recursos de Armazenamento do Azure, consulte Operations on FileShares.

Se já existir uma partilha com o mesmo nome, a operação falhará. O recurso de compartilhamento inclui metadados e propriedades para esse compartilhamento. Ele não inclui uma lista dos arquivos contidos no compartilhamento.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado Disponível
Bloco de mensagens do servidor (SMB) Sim
Sistema de arquivos de rede (NFS) Sim

Solicitar

Você pode construir a solicitação de Create Share como mostrado aqui. Recomendamos que você use HTTPS.

Método Solicitar URI Versão HTTP
PUT https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1

Substitua os componentes de caminho mostrados no URI de solicitação pelo seu, da seguinte maneira:

Componente Caminho Descrição
myaccount O nome da sua conta de armazenamento.
myshare O nome do seu compartilhamento de arquivos. O nome pode conter apenas caracteres minúsculos.

Para obter mais informações sobre restrições de nomenclatura de caminho, consulte Compartilhamentos de nome e referência, diretórios, arquivos e metadados.

Parâmetros de URI

Você pode especificar os seguintes parâmetros adicionais no URI de solicitação:

Parâmetro Descrição
timeout Opcional. O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações de serviço de arquivo.

Cabeçalhos de solicitação

Os cabeçalhos de solicitação obrigatórios e opcionais são descritos na tabela a seguir:

Cabeçalho da solicitação Descrição
Authorization Necessário. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
Date ou x-ms-date Necessário. Especifica a hora UTC (Tempo Universal Coordenado) para a solicitação. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
x-ms-version Obrigatório para todos os pedidos autorizados. Especifica a versão da operação a ser usada para essa solicitação. Para obter mais informações, consulte Versionamento para serviços de Armazenamento do Azure.
x-ms-meta-name:value Opcional. Um par nome-valor para associar ao compartilhamento como metadados.

Os nomes de metadados devem aderir às regras de nomenclatura para identificadores C#.
x-ms-share-quota Opcional. Suportado na versão 2015-02-21 e posterior. Especifica o tamanho máximo do compartilhamento, em gibibytes (GiB).
x-ms-access-tier Opcional. Suportado na versão 2019-12-12 e posterior. Especifica a camada de acesso do compartilhamento. Os valores válidos são TransactionOptimized, Hote Cool. Para obter informações detalhadas sobre camadas de compartilhamento de arquivos, consulte camadas de armazenamento do Azure Files.
x-ms-enabled-protocols: <SMB \| NFS> Opcional. Suportado na versão 2019-07-07 e posterior. Especifica os protocolos habilitados no compartilhamento. Se eles não forem especificados, o padrão será SMB.

- SMB: O compartilhamento pode ser acessado por SMBv3.0, SMBv2.1 e REST.
- NFS: O compartilhamento pode ser acessado pelo NFSv4.1. É necessária uma conta premium para esta opção.
x-ms-root-squash: <NoRootSquash \| RootSquash \| AllSquash> Opcional. Apenas NFS. Suportado na versão 2019-07-07 e posterior. Especifica o comportamento de esmagamento de raiz no compartilhamento quando o NFS está habilitado. Se não for especificado, o padrão é NoRootSquash.

- NoRootSquash: Desligue o esmagamento de raízes.
- RootSquash: Mapeie solicitações de uid/gid 0 para o anônimo uid/gid.
- AllSquash: Mapeie todos os uids e gids para o usuário anônimo.
x-ms-enable-snapshot-virtual-directory-access: <true \| false> Opcional. Suportado na versão 2024-08-04 e posterior. Especifica se o diretório virtual de instantâneo deve estar acessível na raiz do ponto de montagem do compartilhamento quando o NFS está habilitado. Se não for especificado, o padrão será true.
x-ms-client-request-id Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 kibibyte (KiB) que é registrado nos logs quando o log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações que o servidor recebe. Para obter mais informações, consulte Monitorar arquivos do Azure.
x-ms-share-paid-bursting-enabled: <true \| false> Opcional. Suportado na versão 2024-11-04 e posterior. Permitido apenas para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Esta propriedade permite bursting pago. Se a propriedade não for especificada, o valor padrão será false.
x-ms-share-paid-bursting-max-iops Opcional. Suportado na versão 2024-11-04 e posterior. Apenas permitido para compartilhamentos de arquivos premium. Um inteiro que representa o máximo pago de operações de entrada/saída por segundo (IOPS) permitidas para a ação. O padrão, se não especificado, é o máximo de IOPS permitido para um compartilhamento. Se esse cabeçalho estiver definido, x-ms-share-paid-bursting-enabled também deverá ser definido como true.
x-ms-share-paid-bursting-max-bandwidth-mibps Opcional. Suportado na versão 2024-11-04 e posterior. Apenas permitido para compartilhamentos de arquivos premium. Um inteiro que representa o máximo de mebibytes de bursting pagos por segundo (MiB/s) permitidos para o compartilhamento. O padrão, se não especificado, é o MiB/s máximo permitido para uma ação. Se esse cabeçalho estiver definido, x-ms-share-paid-bursting-enabled também deverá ser definido como true.

Corpo do pedido

Nenhuma.

Pedido de amostra

PUT https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1  
  
Request Headers:  
x-ms-version: 2020-02-10  
x-ms-date: <date>  
x-ms-meta-Name: StorageSample  
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=  

Resposta

A resposta inclui um código de status HTTP e um conjunto de cabeçalhos de resposta.

Código de status

Uma operação bem-sucedida retorna o código de status 201 (Criado).

Para obter mais informações, consulte Status e códigos de erro.

Cabeçalhos de resposta

A resposta para esta operação inclui os seguintes cabeçalhos. A resposta também pode incluir cabeçalhos HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho da resposta Descrição
ETag Contém um valor que representa a versão do compartilhamento, entre aspas.
Last-Modified Devolve a data e hora em que a partilha foi modificada pela última vez. O formato de data segue o RFC 1123. Para obter mais informações, consulte Representar valores de data/hora em cabeçalhos.

Qualquer operação que modifique o compartilhamento ou suas propriedades ou metadados atualiza a hora da última modificação. As operações em arquivos não afetam a hora da última modificação do compartilhamento.
x-ms-request-id Identifica exclusivamente a solicitação e você pode usá-la para solucionar problemas da solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API
x-ms-version Indica a versão dos Arquivos do Azure que foi usada para executar a solicitação.
Date Um valor de data/hora UTC gerado pelo serviço, que indica a hora em que a resposta foi iniciada.
x-ms-client-request-id Pode ser usado para solucionar problemas de solicitações e respostas correspondentes. O valor desse cabeçalho é igual ao valor do cabeçalho x-ms-client-request-id se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o cabeçalho x-ms-client-request-id não estiver presente na solicitação, ele não estará presente na resposta.

Corpo de resposta

Nenhuma.

Resposta da amostra

Response Status:  
HTTP/1.1 201 Created  
  
Response Headers:  
Transfer-Encoding: chunked  
Date: <date>  
ETag: "0x8CB14C3E29B7E82"  
Last-Modified: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  

Autorização

Apenas o proprietário da conta pode chamar esta operação.

Comentários

Os compartilhamentos são criados imediatamente dentro da conta de armazenamento. Não é possível aninhar uma ação dentro da outra.

Você pode especificar metadados para um compartilhamento ao criá-lo incluindo um ou mais cabeçalhos de metadados na solicitação. O formato do cabeçalho de metadados é x-ms-meta-name:value.

Se um compartilhamento com o mesmo nome estiver sendo excluído quando você chamar Create Share, o servidor retornará o código de status 409 (Conflito) e informações de erro adicionais indicarão que o compartilhamento está sendo excluído.

Você pode usar a cota de tamanho de compartilhamento para limitar o tamanho dos arquivos armazenados no compartilhamento. A cota não limita o tamanho dos instantâneos. A sobrecarga associada aos arquivos e usada para calcular o tamanho do faturamento da conta de armazenamento não é contabilizada na cota.

Quando a soma dos tamanhos dos arquivos no compartilhamento exceder a cota definida no compartilhamento, as tentativas de aumentar o tamanho de um arquivo falharão e a criação de novos arquivos não vazios (via REST) falhará. Você ainda poderá criar arquivos vazios.

Alterar ou definir a quota não tem qualquer efeito na faturação. Você ainda é cobrado pelo tamanho dos arquivos mais a sobrecarga.

Ver também

Operations on Azure Files compartilha