Criar compartilhamento

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

Se já existir um compartilhamento 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)
Sistema de Arquivos de Rede (NFS)

Pedir

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

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

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

Componente path	Descrição
myaccount	O nome da sua conta de armazenamento.
myshare	O nome do 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 da 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 de 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) da solicitação. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
x-ms-version	Necessário para todas as solicitações autorizadas. Especifica a versão da operação a ser usada para essa solicitação. Para obter mais informações, consulte controle de versão dos serviços de Armazenamento do Azure.
x-ms-meta-name:value	Opcional. Um par nome-valor a ser associado ao compartilhamento como metadados. Os nomes de metadados devem seguir as regras de nomenclatura para identificadores C#.
x-ms-share-quota	Opcional. Com suporte na versão 2015-02-21 e posterior. Especifica o tamanho máximo do compartilhamento, em gibibytes (GiB).
x-ms-access-tier	Opcional. Com suporte 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 de Arquivos do Azure.
x-ms-enabled-protocols: <SMB \| NFS>	Opcional. Com suporte 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 pelo SMBv3.0, SMBv2.1 e REST. - NFS: o compartilhamento pode ser acessado pelo NFSv4.1. Uma conta premium é necessária para essa opção.
x-ms-root-squash: <NoRootSquash \| RootSquash \| AllSquash>	Opcional. Somente NFS. Com suporte na versão 2019-07-07 e posterior. Especifica o comportamento de esmagamento raiz no compartilhamento quando o NFS está habilitado. Se não for especificado, o padrão será NoRootSquash. - NoRootSquash: desative o esmagamento raiz. - RootSquash: mapear solicitações de uid/gid 0 para o uid/gid anônimo. - AllSquash: mapeie todos os uids e gids para o usuário anônimo.
x-ms-enable-snapshot-virtual-directory-access: <true \| false>	Opcional. Com suporte na versão 2024-08-04 e posterior. Especifica se o diretório virtual de instantâneo deve ser acessível na raiz do ponto de montagem do compartilhamento quando o NFS está habilitado. Se não for especificado, o padrão será verdadeiro.
x-ms-client-request-id	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres kib (1 kibibyte) que é registrado nos logs quando o registro em log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações recebidas pelo servidor. Para obter mais informações, consulte Monitorar arquivos do Azure.
x-ms-share-paid-bursting-enabled: <true \| false>	Opcional. Com suporte na versão 2024-11-04 e posterior. Permitido somente para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Essa propriedade permite o estouro pago. Se a propriedade não for especificada, o valor padrão será false.
x-ms-share-paid-bursting-max-iops	Opcional. Com suporte na versão 2024-11-04 e posterior. Permitido somente para compartilhamentos de arquivos premium. Um inteiro que representa o máximo de IOPS (operações de entrada/saída) de intermitência pagas por segundo permitido para o compartilhamento. O padrão, se não especificado, é o IOPS máximo 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. Com suporte na versão 2024-11-04 e posterior. Permitido somente para compartilhamentos de arquivos premium. Um inteiro que representa o máximo pago de mebibytes por segundo (MiB/s) permitido para o compartilhamento. O padrão, se não especificado, é o máximo permitido de MiB/s para um compartilhamento. Se esse cabeçalho estiver definido, x-ms-share-paid-bursting-enabled também deverá ser definido como true.

Corpo da solicitação

Nenhum.

Solicitação de exemplo

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 dessa operação inclui os cabeçalhos a seguir. 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 de protocolo HTTP/1.1 .

Cabeçalho de resposta	Descrição
ETag	Contém um valor que representa a versão do compartilhamento, entre aspas.
Last-Modified	Retorna a data e a hora em que o compartilhamento foi modificado 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 da resposta

Nenhum.

Resposta de exemplo

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

Somente o proprietário da conta pode chamar essa operação.

Observações

Os compartilhamentos são criados imediatamente na conta de armazenamento. Não é possível aninhar uma parte dentro de 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 adicionais de erro 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 da cobrança da conta de armazenamento não é contabilizado 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 cota não tem efeito sobre a cobrança. Você ainda é cobrado pelo tamanho dos arquivos mais a sobrecarga.

Consulte também

operações de em compartilhamentos de Arquivos do Azure