Definir propriedades de compartilhamento
A operação Set Share Properties define propriedades para o compartilhamento de arquivos do Azure especificado. Embora esta operação seja totalmente suportada, é uma operação de gestão legada. Recomendamos que você use a operação File Shares - Update fornecida pelo provedor de recursos de armazenamento (Microsoft.Storage). Para saber mais sobre como interagir programaticamente com recursos FileShare usando o provedor de recursos de armazenamento, consulte Operations on FileShare resources.
Disponibilidade do protocolo
| Protocolo de compartilhamento de arquivos habilitado | Disponível |
|---|---|
| PME |
|
| NFS |
|
Solicitar
Você pode construir a solicitação Set Share Properties da seguinte maneira. Recomendamos HTTPS. Substitua myaccount pelo nome da sua conta de armazenamento.
| Método | Solicitar URI | Versão HTTP |
|---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=properties |
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. |
Para obter detalhes sobre restrições de nomenclatura de caminho, consulte Nomeando e referenciando compartilhamentos, 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. Expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações do Azure Files. |
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais:
| 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 o Tempo Universal Coordenado (UTC) 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 controle de versão para os serviços de Armazenamento do Azure. |
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 a hierarquização de compartilhamento de arquivos, consulte camadas de armazenamento do Azure Files. |
x-ms-root-squash: <NoRootSquash \| RootSquash \| AllSquash> |
Opcional. Suportado na versão 2020-02-10 e posterior. Especifica o comportamento de esmagamento de raiz no compartilhamento quando o NFS está habilitado.
|
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. |
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 do Storage Analytics 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 Monitor Azure Blob Storage. |
x-ms-lease-id:<ID> |
Necessário se o compartilhamento de arquivos de destino tiver uma concessão ativa. Disponível para a versão 2020-02-10 e posterior. Se a solicitação não incluir o ID de concessão ou não for válida, a operação falhará com o código de status 412 (Falha na pré-condição). Se esse cabeçalho for especificado e o compartilhamento de arquivos de destino não tiver uma concessão ativa no momento, a operação falhará com o código de status 412 (Falha na pré-condição). |
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 pode ser usada para ativar ou desativar o bursting pago. Se a propriedade não for especificada, a ação manterá seu status de ativação de bursting pago existente. |
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. Se o bursting pago ainda não estiver habilitado no compartilhamento: o comportamento é idêntico ao cabeçalho x-ms-share-paid-bursting-max-iops em Criar compartilhamento. 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.Se o bursting pago já estiver habilitado no compartilhamento: x-ms-share-paid-bursting-max-iops pode ser usado para atualizar o máximo de IOPS de bursting pago para o compartilhamento.
x-ms-share-paid-bursting-enabled não precisa ser definido neste caso. Se x-ms-share-paid-bursting-enabled estiver definido como true, mas x-ms-share-paid-bursting-max-iops não estiver definido, o máximo de IOPS bursting pago permanecerá inalterado. |
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. Se o bursting pago ainda não estiver habilitado no compartilhamento: o comportamento é idêntico ao cabeçalho x-ms-share-paid-bursting-max-bandwidth-mibps em Criar 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.Se o bursting pago já estiver habilitado no compartilhamento: x-ms-share-paid-bursting-max-bandwidth-mibps pode ser usado para atualizar o máximo de MiB/s de bursting pago para o compartilhamento.
x-ms-share-paid-bursting-enabled não precisa ser definido neste caso. Se x-ms-share-paid-bursting-enabled estiver definido como true, mas x-ms-share-paid-bursting-max-bandwidth-mibps não estiver definido, a largura de banda máxima de bursting paga permanecerá inalterada. |
Corpo do pedido
Nenhuma.
Pedido de amostra
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=properties
Request Headers:
x-ms-version: 2020-02-10
x-ms-date: <date>
Authorization: SharedKey myaccount: Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00Jdjid0Q=
x-ms-share-quota: 55
x-ms-root-squash: RootSquash
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 200 (OK).
Para obter informações sobre códigos de status, consulte Códigos de status e 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 |
|---|---|
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 Representação de valores de data/hora em cabeçalhos. Qualquer operação que modifique o compartilhamento ou suas propriedades atualiza a hora da última modificação. As operações em arquivos não afetam a hora da última modificação do compartilhamento. |
ETag |
Contém um valor que representa a versão do compartilhamento, como uma cadeia de caracteres entre aspas. |
x-ms-request-id |
Identifica exclusivamente a solicitação que foi feita. Você também pode usá-lo para solucionar a 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 usada para executar a solicitação. |
Date ou x-ms-date |
Um valor de data/hora UTC que indica a hora em que o serviço enviou a resposta. |
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 for no máximo 1.024 caracteres ASCII visíveis. Se o cabeçalho x-ms-client-request-id não estiver presente na solicitação, esse cabeçalho não estará presente na resposta. |
Corpo de resposta
Nenhuma.
Autorização
Somente o proprietário da conta pode chamar essa operação.
Comentários
Para obter mais informações sobre como definir a cota de compartilhamento, consulte Criar compartilhamento.
Se você definir a cota de compartilhamento para ser menor do que o tamanho dos dados no compartilhamento, a operação será bem-sucedida. No entanto, você não poderá adicionar mais dados ao compartilhamento até que a quantidade de dados no compartilhamento seja reduzida abaixo da cota. Você pode reduzir a quantidade de dados excluindo ou compactando arquivos.
Set Share Properties não é suportado para um instantâneo de compartilhamento. Uma tentativa de executar essa operação em um instantâneo de compartilhamento falhará com o código de status 400 (InvalidQueryParameterValue).
Se você definir o cabeçalho x-ms-enable-snapshot-virtual-directory-access para compartilhamentos NFS, remonte o compartilhamento para observar o comportamento atualizado.