Obter propriedades de compartilhamento
A Get Share Properties solicitação retorna propriedades para o compartilhamento ou compartilhamento especificado instantâneo.
Embora essa API tenha suporte total, ela é uma API de gerenciamento herdada. Por esse motivo, recomendamos que você use Compartilhamentos de Arquivos – Get, que é fornecido pelo provedor de recursos de armazenamento (Microsoft.Storage).
Para saber mais sobre como interagir programaticamente com FileShare recursos usando o provedor de recursos de armazenamento, consulte Operações em FileShares.
Disponibilidade do protocolo
| Protocolo de compartilhamento de arquivos habilitado | Disponível |
|---|---|
| SMB |  |
| NFS | |
Solicitação
A solicitação Get Share Properties pode ser criada da seguinte maneira. Recomendamos que você use HTTPS.
| Método | URI da solicitação | 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 do caminho mostrados no URI da solicitação pelos seus próprios, como segue:
| Componente Demarcador | Descrição |
|---|---|
myaccount |
O nome da sua conta de armazenamento. |
myshare |
O nome do seu compartilhamento de arquivo. |
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 do URI
Os seguintes parâmetros adicionais podem ser especificados no URI de solicitação:
| Parâmetro | Descrição |
|---|---|
sharesnapshot |
Opcional. Versão 2017-04-17 e posterior. O sharesnapshot parâmetro é um valor opaco de data/hora que, quando presente, especifica o compartilhamento instantâneo consultar para recuperar as propriedades. |
timeout |
Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações de Arquivos do Azure. |
Cabeçalhos da solicitação
Os cabeçalhos obrigatórios e opcionais são descritos na tabela a seguir:
| Cabeçalho da solicitação | Descrição |
|---|---|
Authorization |
Obrigatórios. Especifica o esquema de autorização, o nome da conta e a assinatura. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure. |
Date ou x-ms-date |
Obrigatórios. Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Para saber mais, confira 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 esta 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 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-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 arquivo. Se não houver correspondência, a operação falhará com status código 412 (Falha na pré-condição). |
Corpo da solicitação
Nenhum.
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 cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.
| Cabeçalho de resposta | Descrição |
|---|---|
Last-Modified |
Retorna a data e a hora em que o compartilhamento foi modificado pela última vez. O formato da data segue 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 de nome/valor que contém os metadados definidos pelo usuário para o compartilhamento. |
ETag |
Contém um valor que você pode usar para executar operações condicionalmente. O valor é colocado entre aspas. |
x-ms-request-id |
Identifica exclusivamente a solicitação que foi feita e pode ser usada para solucionar problemas da solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API. |
x-ms-version |
A versão 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. Retorna a cota de compartilhamento 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 no tipo de conta de armazenamento FileStorage). Retorna o número de IOPS (operações de entrada/saída por segundo), conforme provisionado para o compartilhamento premium. |
x-ms-share-provisioned-ingress-mbps |
Versão 2019-07-07 e posterior. Retornado somente para compartilhamentos de arquivos Premium (compartilhamentos de arquivos no tipo de conta de armazenamento FileStorage). Retorna a entrada em mebibytes por segundo (MiB/s), conforme provisionado para o compartilhamento Premium. |
x-ms-share-provisioned-egress-mbps |
Versão 2019-07-07 e posterior. Retornado somente para compartilhamentos de arquivos Premium (compartilhamentos de arquivos no tipo de conta de armazenamento FileStorage). Retorna a saída em MiB/s, conforme provisionado para o compartilhamento Premium. |
x-ms-share-provisioned-bandwidth-mibps |
Versão 2021-02-12 e posterior. Retornado somente para compartilhamentos de arquivos Premium (compartilhamentos de arquivos no tipo de conta de armazenamento FileStorage). Retorna a largura de banda combinada (entrada + saída) em MiB/s, conforme provisionado para o compartilhamento 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 no tipo de conta de armazenamento FileStorage). Um valor de data/hora que especifica quando a cota para o compartilhamento de arquivos premium tem permissão para ser reduzida. O formato da data segue RFC 1123. |
x-ms-access-tier |
Versão 2019-12-12 e posterior. Retorna a camada de acesso atual do compartilhamento. Em contas TransationOptimized de armazenamento de GPv2 (versão de uso geral 2), é 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 em um compartilhamento é de duração infinita ou fixa. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Versão 2020-02-10 e posterior. Quando um compartilhamento é concedido, esse cabeçalho especifica o estado de concessão do compartilhamento. |
x-ms-lease-status: <locked;unlocked> |
Versão 2020-02-10 e posterior. Quando um compartilhamento é concedido, esse cabeçalho especifica o status de concessão do compartilhamento. |
x-ms-enabled-protocols: <SMB;NFS> |
Retorna os protocolos atuais habilitados para compartilhamento 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 squashing de raiz de compartilhamento para a versão 2019-07-07 e posterior. Somente NFS. - NoRootSquash: o squashing raiz está desativado.- RootSquash: as solicitações de UID/GID 0 são mapeadas para o UID/GID anônimo.- AllSquash: todos os UIDs e GIDs são mapeados para o usuário anônimo. |
x-ms-client-request-id |
Pode ser usado para solucionar problemas de solicitações e respostas correspondentes. O valor desse cabeçalho será igual ao valor do x-ms-client-request-id cabeçalho se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o x-ms-client-request-id cabeçalho 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 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
Somente o proprietário da conta pode chamar essa operação.
Comentários
Nenhum.