Definir metadados de compartilhamento

A Set Share Metadata operação define um ou mais pares de nome/valor definidos pelo usuário para o compartilhamento especificado. Embora essa operação seja totalmente compatível, ela é uma operação de gerenciamento herdada. Recomendamos que você use a operação Compartilhamentos de Arquivos – Atualização fornecida pelo provedor de recursos de armazenamento (Microsoft.Storage). Para saber mais sobre como interagir programaticamente com FileShare os recursos usando o provedor de recursos de armazenamento, consulte Operações em recursos de FileShare.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado Disponível
SMB Sim
NFS Sim

Solicitação

Você constrói a solicitação da Set Share Metadata seguinte maneira. Recomendamos HTTPS. Substitua myaccount pelo nome da sua conta de armazenamento.

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

Substitua os componentes do caminho mostrados no URI da solicitação pelos seus próprios, como segue:

Componente path Descrição
myaccount O nome da sua conta de armazenamento.
myshare O nome do seu compartilhamento de arquivo.

Para obter detalhes sobre restrições de nomenclatura de caminho, consulte Nomenclatura e referência de compartilhamentos, diretórios, arquivos e metadados.

Parâmetros do 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 de Arquivos do Azure.

Cabeçalhos da 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 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-meta-name:value Opcional. Fornece um par nome/valor para conter metadados para o compartilhamento.

Cada chamada para essa operação substitui todos os metadados existentes anexados ao compartilhamento. Para remover todos os metadados do compartilhamento, chame essa operação sem cabeçalhos de metadados.

Os nomes de metadados devem seguir as regras de nomenclatura para identificadores C#.
x-ms-client-request-id Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres KiB (1 kibibyte) registrado nos logs de Análise de Armazenamento 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 Armazenamento de Blobs do Azure.
x-ms-lease-id:<ID> Obrigató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 a ID de concessão ou não for válida, a operação falhará com status código 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 status código 412 (Falha na pré-condição).

Corpo da solicitação

Nenhum.

Solicitação de exemplo

PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1  
  
Request Headers:  
x-ms-version: 2014-02-14  
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT  
x-ms-meta-Category: Images  
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 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 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 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 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, entre aspas.
x-ms-request-id Identifica exclusivamente a solicitação que foi feita. Você pode usá-lo 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 de Arquivos do Azure que foi 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 x-ms-client-request-id cabeçalho, se ele estiver presente na solicitação e o valor for no máximo 1.024 caracteres ASCII visíveis. Se o x-ms-client-request-id cabeçalho não estiver presente na solicitação, esse cabeçalho não estará presente na resposta.

Corpo da resposta

Nenhum.

Autorização

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

Comentários

A chamada Set Share Metadata substitui todos os metadados existentes associados ao compartilhamento. Não é possível modificar um par de nome/valor individual.

Você também pode definir metadados para um compartilhamento no momento em que ele é criado, como parte da operação Criar Compartilhamento .

Chamar Set Share Metadata atualiza as ETag propriedades e Last-Modified-Time para o compartilhamento.

Set Share Metadatanão há suporte para um instantâneo de compartilhamento. Uma tentativa de executar essa operação em um instantâneo de compartilhamento falhará com status código 400 (InvalidQueryParameterValue). Você pode definir metadados para um compartilhamento instantâneo no momento em que ele é criado, como parte da Snapshot Share operação.

Confira também

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