Compartilhar via

Exclusão reversível do Gerenciamento de API (versão prévia)

APLICA-SE A: todas as camadas do Gerenciamento de API

Com a exclusão reversível do Gerenciamento de API, você pode recuperar e restaurar uma instância do Gerenciamento de API recém-excluída. Esse recurso oferece proteção contra a exclusão acidental da instância do Gerenciamento de API.

No momento, dependendo de como você exclui uma instância do Gerenciamento de API, ela é excluída de modo reversível e recuperável durante um período de retenção ou excluída permanentemente:

  • Quando você usa o portal do Azure ou a API REST versão 2020-06-01-preview ou posterior para excluir uma instância do Gerenciamento de API, ela é excluída de modo reversível.
  • Uma instância do Gerenciamento de API excluída usando uma versão da API REST anterior à 2020-06-01-preview é excluída permanentemente.
  • Uma instância do Gerenciamento de API excluída usando comandos do Gerenciamento de API no Azure PowerShell ou na CLI do Azure é excluída temporariamente.

Interfaces de suporte

A recuperação e outras operações em uma instância excluída de modo reversível são habilitadas por meio da API REST versão 2020-06-01-preview ou posterior, ou do SDK do Azure para .NET, Go ou Python.

Dica

Veja a referência de API REST do Azure para obter dicas e ferramentas para chamar as APIs REST do Azure e o Gerenciamento de API REST para obter mais informações específicas do Gerenciamento de API.

Operação Descrição Namespace do Gerenciamento de API Versão mínima da API
Criar ou Atualizar Crie ou atualize um serviço do Gerenciamento de API. Serviço de Gerenciamento de API Qualquer
Criar ou Atualizar com a propriedade restore defina como Verdadeiro Recupera um serviço de Gerenciamento de API que já foi excluído de modo reversível. Se restore for especificado e definido como true, todas as outras propriedades serão ignoradas. Serviço de Gerenciamento de API Versão prévia-01-06-2020
Excluir Exclui um serviço de Gerenciamento de API. Serviço de Gerenciamento de API Versão prévia-01-06-2020
Obter pelo Nome Obtenha o Serviço de Gerenciamento de API com exclusão reversível pelo nome. Serviços Excluídos Versão prévia-01-06-2020
Listar por Assinatura Lista todos os serviços disponíveis com exclusão reversível para cancelamento da exclusão da assinatura selecionada. Serviços Excluídos Versão prévia-01-06-2020
Limpar Limpa o serviço de Gerenciamento de API (a exclusão é permanente sem a opção de restauração). Serviços Excluídos Versão prévia-01-06-2020

Comportamento de exclusão reversível

Você pode usar qualquer versão de API para criar uma instância do Gerenciamento de API. Quando você usa o portal do Azure, a API REST do Azure ou outra ferramenta do Azure com a versão 2020-06-01-preview da API ou posterior para excluir uma instância do Gerenciamento de API, ela é excluída automaticamente de modo reversível.

Após a exclusão reversível de uma instância do Gerenciamento de API, o serviço existirá em um estado excluído, ficando inacessível para operações normais do Gerenciamento de API.

No estado de exclusão em modo reversível:

  • A instância do Gerenciamento de API só pode ser listada, recuperada ou descartada (excluída permanentemente).
  • O Azure agendará a exclusão permanente dos dados subjacentes correspondentes à instância do Gerenciamento de API após o período de retenção (48 horas) predeterminado.
  • Não é possível reutilizar o nome da instância do Gerenciamento de API.

Se a instância do Gerenciamento de API não for recuperada ou limpa por você em até 48 horas, ela será excluída permanentemente de modo automático.

Listar as instâncias de Gerenciamento de API excluídas

Você pode verificar se uma instância do Gerenciamento de API excluída de modo reversível está disponível para restauração (sem exclusão) usando as operações Obter por nome ou Listar por assinatura dos Serviços excluídos.

Obter uma instância excluída de maneira reversível pelo nome

Use a operação Obter pelo nome do Gerenciamento de API, substituindo {subscriptionId}, {location} e {serviceName} pela assinatura do Azure, nome do local do recurso e nome da instância do Gerenciamento de API:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}?api-version=2021-08-01

Se o cancelamento da exclusão estiver disponível, o Azure retornará um registro da instância do Gerenciamento de API mostrando seu deletionDate e scheduledPurgeDate, por exemplo:

{
    "id": "subscriptions/########-####-####-####-############/providers/Microsoft.ApiManagement/locations/southcentralus/deletedservices/apimtest",
    "name": "apimtest",
    "type": "Microsoft.ApiManagement/deletedservices",
    "location": "South Central US",
    "properties": {
        "serviceId": "/subscriptions/########-####-####-####-############/resourceGroups/apimtestgroup/providers/Microsoft.ApiManagement/service/apimtest",
        "scheduledPurgeDate": "2021-11-26T19:40:26.3596893Z",
        "deletionDate": "2021-11-24T19:40:50.1013572Z"
    }
}

Listar todas as instâncias com exclusão reversível de uma determinada assinatura

Use a operação Lista por Assinatura do Gerenciamento de API, substituindo {subscriptionId} pela ID de assinatura:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/deletedservices?api-version=2021-08-01

Isso retornará uma lista de todos os serviços com exclusão reversível, disponíveis para restauração na assinatura fornecida, mostrando o deletionDate e o scheduledPurgeDate para cada um.

Recuperar uma instância de exclusão reversível

Use a operação Criar ou Atualizar do Gerenciamento de API, substituindo {subscriptionId}, {resourceGroup} e {apimServiceName} pela assinatura do Azure, pelo nome do grupo de recursos e pelo nome do Gerenciamento de API:

PUT
https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ApiManagement/service/{apimServiceName}?api-version=2021-08-01

. . . e defina a propriedade restore como true no corpo da solicitação. (Quando esse sinalizador for especificado e definido como verdadeiro, todas as outras propriedades serão ignoradas.) Por exemplo:

{
  "properties": {
    "publisherEmail": "help@contoso.com",
    "publisherName": "Contoso",
    "restore": true
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "location": "South Central US"
}

Limpar uma instância excluída de modo reversível

Use a operação Limpar do Gerenciamento de API, substituindo {subscriptionId}, {location} e {serviceName} pela assinatura do Azure, local do recurso e nome do Gerenciamento de API.

Observação

Para limpar uma instância excluída de forma reversível, você deve ter as seguintes permissões RBAC no escopo da assinatura, além do acesso de Colaborador à instância de Gerenciamento de API: Microsoft.ApiManagement/locations/deletedservices/delete, Microsoft.ApiManagement/deletedservices/read.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}?api-version=2021-08-01

Isso excluirá permanentemente a instância do Gerenciamento de API do Azure.

Reutilizar um nome de instância do Gerenciamento de API após a exclusão

É possível reutilizar o nome de uma instância do Gerenciamento de API em uma nova implantação:

  • Depois que a instância for excluída permanentemente (limpa) do Azure.

  • Na mesma assinatura que a instância original.

Não é possível reutilizar o nome de uma instância do Gerenciamento de API em uma nova implantação:

  • Enquanto a instância é excluída temporariamente.

  • Em uma assinatura diferente daquela usada para implantar a instância original, mesmo após a instância original ter sido excluída permanentemente (limpa) do Azure. Essa restrição se aplica se a nova assinatura usada está no mesmo locatário ou em um locatário diferente do Microsoft Entra. A restrição fica em vigor por vários dias ou mais após a exclusão, dependendo do tipo de assinatura.

    Essa restrição ocorre porque o Azure reserva o nome do host de serviço para um locatário do cliente por um período de reserva para evitar a ameaça de aquisição de subdomínio com entradas de DNS pendentes. Para obter mais informações, confira Impedir entradas de DNS pendentes e evitar a tomada de subdomínios. Para ver todas as entradas DNS pendentes para assinaturas em um locatário do Microsoft Entra, consulte Identificar entradas DNS pendentes.

Próximas etapas

Saiba mais sobre as opções de backup e recuperação de longo prazo do Gerenciamento de API: