Obter propriedades de compartilhamento
A solicitação Get Share Properties retorna propriedades para o compartilhamento especificado ou instantâneo de compartilhamento.
Embora essa API seja totalmente suportada, ela é uma API de gerenciamento herdada. Por esse motivo, recomendamos que você use File Shares - Get, que é fornecido pelo provedor de recursos de armazenamento (Microsoft.Storage), em vez disso.
Para saber mais sobre como interagir programaticamente com recursos FileShare usando o provedor de recursos de armazenamento, consulte Operations on FileShares.
Disponibilidade do protocolo
| Protocolo de compartilhamento de arquivos habilitado | Disponível |
|---|---|
| PME |
|
| NFS |
|
Solicitar
O pedido Get Share Properties pode ser construído da seguinte forma. Recomendamos que você use HTTPS.
| Método | Solicitar URI | Versão HTTP |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
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 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
Os seguintes parâmetros adicionais podem ser especificados no URI da solicitação:
| Parâmetro | Descrição |
|---|---|
sharesnapshot |
Opcional. Versão 2017-04-17 e posterior. O parâmetro sharesnapshot é um valor de data/hora opaco que, quando presente, especifica o instantâneo de compartilhamento a ser consultado para recuperar as propriedades. |
timeout |
Opcional. O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações do Azure Files. |
Cabeçalhos de solicitação
Os cabeçalhos 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 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-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-lease-id:<ID> |
Opcional. Versão 2020-02-10 e posterior. Se o cabeçalho for especificado, a operação será executada somente se a concessão do compartilhamento de arquivos estiver ativa no momento e a ID de concessão especificada na solicitação corresponder à ID de concessão do compartilhamento de arquivos. Se não houver correspondência, a operação falhará com o código de status 412 (Falha na pré-condição). |
Corpo do pedido
Nenhuma.
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 mais 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 Date-Time 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. |
x-ms-meta-name:value |
Um conjunto de pares nome-valor que contêm os metadados definidos pelo usuário do compartilhamento. |
ETag |
Contém um valor que você pode usar para executar operações condicionalmente. O valor está entre aspas. |
x-ms-request-id |
Identifica exclusivamente a solicitação que foi feita e pode ser usada para solucionar a solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API. |
x-ms-version |
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-share-quota |
Versão 2015-02-21 e posterior. Devolve a quota de partilha atual em gibibytes (GiB). |
x-ms-share-provisioned-iops |
Versão 2019-07-07 e posterior. Retornado somente para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Devolve o número de operações de entrada/saída por segundo (IOPS), conforme provisionado para a ação premium. |
x-ms-share-provisioned-ingress-mbps |
Versão 2019-07-07 e posterior. Retornado somente para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Devolve a entrada em mebibytes por segundo (MiB/s), conforme provisionado para a ação premium. |
x-ms-share-provisioned-egress-mbps |
Versão 2019-07-07 e posterior. Retornado somente para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Devolve a saída em MiB/s, conforme provisionado para a ação premium. |
x-ms-share-provisioned-bandwidth-mibps |
Versão 2021-02-12 e posterior. Retornado somente para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Devolve a largura de banda combinada (entrada + saída) em MiB/s, conforme provisionado para a ação premium. |
x-ms-share-next-allowed-quota-downgrade-time |
Versão 2019-07-07 e posterior. Retornado somente para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Um valor de data/hora que especifica quando a cota para o compartilhamento de arquivos premium pode ser reduzida. O formato de data segue o RFC 1123. |
x-ms-access-tier |
Versão 2019-12-12 e posterior. Retorna a camada de acesso atual do compartilhamento. Nas contas de armazenamento de uso geral versão 2 (GPv2), TransationOptimized é a camada padrão do compartilhamento. Em tipos de conta de armazenamento FileStorage, Premium é a camada padrão do compartilhamento. |
x-ms-access-tier-change-time |
Versão 2019-12-12 e posterior. Retorna a data e a hora em que a camada de acesso no compartilhamento foi modificada pela última vez. |
x-ms-access-tier-transition-state |
Versão 2019-12-12 e posterior. Se o compartilhamento estiver passando por transição de camada, esse cabeçalho indicará a camada da qual está fazendo a transição. |
x-ms-lease-duration:<fixed,infinite> |
Versão 2020-02-10 e posterior. Especifica se a concessão de uma ação é de duração infinita ou fixa. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Versão 2020-02-10 e posterior. Quando uma partilha é arrendada, este cabeçalho especifica o estado de concessão da partilha. |
x-ms-lease-status: <locked;unlocked> |
Versão 2020-02-10 e posterior. Quando uma partilha é arrendada, este cabeçalho especifica o estado de concessão da partilha. |
x-ms-enabled-protocols: <SMB;NFS> |
Retorna os protocolos habilitados para compartilhamento atuais para a versão 2019-07-07 e posterior. - SMB: O compartilhamento pode ser acessado por SMBv3.0, SMBv2.1 e REST.- NFS: O compartilhamento pode ser acessado pelo NFSv4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Retorna o comportamento atual de esmagamento da raiz do compartilhamento para a versão 2019-07-07 e posterior. Apenas NFS. - NoRootSquash: O esmagamento de raízes está desligado.- RootSquash: As solicitações de UID/GID 0 são mapeadas para o anônimo UID/GID.- AllSquash: Todos os UIDs e GIDs são mapeados para o usuário anônimo.Esse cabeçalho é retornado apenas para compartilhamentos, não para instantâneos. |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
Versão 2024-08-04 e mais recente. 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. Esse cabeçalho é retornado apenas para compartilhamentos, não para instantâneos. |
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. |
x-ms-share-paid-bursting-enabled: <true;false> |
Versão 2024-11-04 e posterior. Retornado somente para compartilhamentos de arquivos premium (compartilhamentos de arquivos dentro do tipo de conta de armazenamento FileStorage). Especifica se o bursting pago está habilitado. Esse cabeçalho é retornado apenas para compartilhamentos, não para instantâneos. |
x-ms-share-paid-bursting-max-iops |
Versão 2024-11-04 e posterior. Retornado somente para compartilhamentos de arquivos premium. Devolve o máximo de IOPS de intermitência pago permitido para a ação. Só retornado se x-ms-share-paid-bursting-enabled for verdadeiro.Esse cabeçalho é retornado apenas para compartilhamentos, não para instantâneos. |
x-ms-share-paid-bursting-max-bandwidth-mibps |
Versão 2024-11-04 e posterior. Retornado somente para compartilhamentos de arquivos premium. Devolve o máximo de MiB/s de bursting pago permitido para a ação. Só retornado se x-ms-share-paid-bursting-enabled for verdadeiro.Esse cabeçalho é retornado apenas para compartilhamentos, não para instantâneos. |
Corpo de resposta
Nenhuma.
Resposta da amostra
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
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
Nenhuma.