Gerenciamento direto Gerenciamento de API API REST

  • Artigo

O Azure Gerenciamento de API fornece uma API REST de gerenciamento direto para executar operações em entidades selecionadas, como usuários, grupos, produtos e assinaturas. A API de gerenciamento direto pode ignorar determinados limites da API baseada em Resource Manager do Azure, como a limitação de solicitação.

Importante

Esta seção descreve como acessar o gerenciamento direto Gerenciamento de API API REST. Essa API tem um mecanismo de autenticação diferente do Resource Manager do Azure e usa uma URL base diferente.

Habilitar o acesso à API REST de gerenciamento direto

O acesso ao gerenciamento direto Gerenciamento de API API REST deve ser concedido antes que as chamadas possam ser feitas com êxito.

  1. Navegue até sua instância de Gerenciamento de API do Azure no portal do Azure.

  2. Selecione API de Gerenciamento na seção Implantação + infraestrutura do menu à esquerda.

    Selecione API de Gerenciamento no portal do Azure

  3. Em Habilitar Gerenciamento de API API REST, selecione Sim.

    Importante

    Se Habilitar Gerenciamento de API API REST não estiver selecionada, as chamadas feitas à API REST para essa instância de serviço falharão.

    Habilitar a API de Gerenciamento de API no portal do Azure

Tipo de mídia padrão

O tipo de mídia padrão das solicitações e respostas é application/json. Onde observado, algumas operações podem dar suporte a outros tipos de conteúdo. Se nenhum tipo de conteúdo adicional for mencionado para uma operação específica, o tipo de mídia será application/json.

Autenticação

Cada solicitação para a API REST Gerenciamento de API deve ser acompanhada por um Authorization cabeçalho que contenha um token de acesso compartilhado válido, conforme mostrado no exemplo a seguir.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Esse token de acesso pode se gerado programaticamente no portal do publicador do Console de Gerenciamento de API. Para obter instruções sobre como gerar e recuperar o token de acesso, consulte Para criar manualmente um token de acesso e Para criar programaticamente um token de acesso.

URL base

A URL base do gerenciamento direto Gerenciamento de API API REST está em conformidade com o modelo a seguir.

https://{servicename}.management.azure-api.net

Esse modelo contém o seguinte parâmetro.

  • {serviceName} é o nome do serviço especificado durante a sua criação, por exemplo https://contosoapi.management.azure-api.net.

Todas as URLs retornadas pela API REST Gerenciamento de API são relativas a essa URL base e todas as solicitações à API REST devem usar esse modelo de URL base.

Parâmetro de consulta de versão

Todas as operações esperam um parâmetro de consulta api-version com um valor no formato YYYY-MM-DD, por exemplo 2021-08-01.

Observação

Durante um período de visualização de uma API REST Gerenciamento de API, -preview é acrescentado ao parâmetro de consulta de versão, por exemplo2021-04-01-preview.

Se esse parâmetro de consulta não for passado na cadeia de caracteres de consulta de uma solicitação, o servidor retornará um código status de 400 Bad Request. Para obter uma lista de versões com suporte, consulte Gerenciamento de API referência da API REST.

Próximas etapas