Obter metadados de compartilhamento

A Get Share Metadata operação retorna todos os metadados definidos pelo usuário para o compartilhamento de arquivos do Azure ou o compartilhamento instantâneo.

Embora essa API tenha suporte total, é 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 compartilhamentos de arquivos do Azure.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado	Disponível
SMB
NFS

Solicitação

A solicitação Get Share Metadata é construída conforme a seguir. 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&comp=metadata	HTTP/1.1
GET/HEAD	https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata&sharesnapshot=<DateTime>	HTTP/1.1

Substitua os componentes de caminho mostrados no URI de 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 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 os metadados
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

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 Representar 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.
x-ms-meta-name:value	Um conjunto de pares nome-valor que contêm metadados definidos pelo usuário para o 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 problemas da solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API.
x-ms-version	Indica a versão Arquivos do Azure usada para executar a solicitação.
Date ou x-ms-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 suas 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: somemetadata  
Date: Mon, 27 Jan 2014 22:49:18 GMT  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: Mon, 27 Jan 2014 22:48:29 GMT  
x-ms-version: 2014-02-14  
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

Essa operação retorna apenas os metadados definidos pelo usuário no compartilhamento. Para retornar as propriedades do sistema também, chame Obter Propriedades do Compartilhamento.

Confira também

Operações em recursos fileshare (Arquivos do Azure)