Excluir compartilhamento

A Delete Share operação exclui o compartilhamento ou o instantâneo de compartilhamento especificado. Essa API tem suporte total, mas lembre-se de que essa é uma API de gerenciamento herdada.

É uma boa ideia usar Compartilhamentos de Arquivos – Excluir em vez disso. Ele é 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 Sim
NFS Sim

Solicitação

Você pode construir a solicitação da Delete Share seguinte maneira. HTTPS é recomendado.

Método URI da solicitação Versão HTTP
DELETE https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1
DELETE https://myaccount.file.core.windows.net/myshare?sharesnapshot=<DateTime>&restype=share 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 referenciando compartilhamentos, diretórios, arquivos e metadados.

Parâmetros do URI

Você pode especificar os seguintes parâmetros adicionais 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 DateTime que, quando presente, especifica o instantâneo de compartilhamento a ser excluído.
timeout Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Configurando 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-delete-snapshots: { include, include-leased } Opcional se o compartilhamento tiver instantâneos associados. Especifique uma das seguintes opções:
  • include: exclua o compartilhamento base e todos os seus instantâneos.
  • include-leased: versão 2020-02-10 e posterior. Exclua o compartilhamento base e todos os seus instantâneos, mesmo que um ou mais instantâneos tenham concessões ativas de compartilhamento.
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 do Azure Monitor quando o registro em log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar as atividades do lado do cliente com as solicitações recebidas pelo servidor. Para obter mais informações, consulte Monitor Arquivos do Azure.
x-ms-lease-id: <ID> Obrigatório se o compartilhamento de arquivo 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 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 também falhará com o código de status 412 (Falha na pré-condição).

Corpo da solicitação

Nenhum.

Solicitação de exemplo

DELETE https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1  
  
Request Headers:  
x-ms-version: 2014-02-14  
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT  
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ= TBD  

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 202 (Aceito). Para obter informações sobre códigos de status, consulte Status e códigos 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
x-ms-request-id Esse cabeçalho identifica exclusivamente a solicitação feita e pode ser usado para solucionar problemas da solicitação. Para obter mais informações, consulte Solução de problemas de operações de API.
x-ms-version Indica a versão de 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 a resposta foi iniciada. O serviço gera esse valor.
x-ms-client-request-id Você pode usar esse cabeçalho 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. O valor é 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

Ao excluir um compartilhamento, você não pode criar um compartilhamento com o mesmo nome por pelo menos 30 segundos. Enquanto o compartilhamento está sendo excluído, as tentativas de recriar um compartilhamento com o mesmo nome falharão com o código de status 409 (Conflito). O serviço retorna informações de erro adicionais, indicando que o compartilhamento está sendo excluído. Todas as outras operações, inclusive operações em todos os arquivos no compartilhamento, falharão com o código de status 404 (Não Localizado) durante a exclusão do compartilhamento.

Atualmente, a exclusão de um compartilhamento com instantâneos não é permitida. Os instantâneos de compartilhamento podem ser excluídos individualmente ou podem ser excluídos junto com o compartilhamento usando o x-ms-delete-snapshots=include cabeçalho.

Você só deve especificar x-ms-delete-snapshots uma solicitação em relação ao recurso de compartilhamento base. Se você especificar esse cabeçalho em uma solicitação para excluir um instantâneo individual, Arquivos do Azure retornará o código de status 400 (valor de parâmetro de consulta inválido). Se esse cabeçalho não for especificado na solicitação de exclusão e o compartilhamento tiver instantâneos associados, o Arquivos do Azure retornará o código de status 409 (Compartilhar Tem Instantâneos).

Confira também

Operações em compartilhamentos (Arquivos do Azure)