Gestão direta Gestão de API API REST

  • Artigo

O Azure Gestão de API fornece uma API REST de gestão direta para realizar operações em entidades selecionadas, como utilizadores, grupos, produtos e subscrições. A API de gestão direta pode ignorar determinados limites da API baseada em Resource Manager do Azure, como a limitação de pedidos.

Importante

Esta secção descreve como aceder à gestão direta Gestão de API API REST. Esta API tem um mecanismo de autenticação diferente do Azure Resource Manager e utiliza um URL base diferente.

Ativar o acesso à API REST de gestão direta

O acesso à gestão direta Gestão de API API REST tem de ser concedido antes de as chamadas poderem ser efetuadas com êxito.

  1. Navegue para a instância do Azure Gestão de API no portal do Azure.

  2. Selecione API de Gestão na secção Implementação + infraestrutura do menu à esquerda.

    Selecione API de Gestão no portal do Azure

  3. Em Ativar Gestão de API API REST, selecione Sim.

    Importante

    Se Ativar Gestão de API API REST não estiver selecionada, as chamadas efetuadas à API REST para essa instância de serviço falharão.

    Ativar a API de Gestão de API no portal do Azure

Tipo de suporte de dados predefinido

O tipo de suporte de dados predefinido para pedidos e respostas é application/json. Quando indicado, algumas operações suportam outros tipos de conteúdo. Se não for mencionado nenhum tipo de conteúdo adicional para uma operação específica, o tipo de suporte de dados é application/json.

Autenticação

Cada pedido à API REST Gestão de API tem de ser acompanhado por um Authorization cabeçalho que contenha um token de acesso partilhado válido, conforme mostrado no exemplo seguinte.

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

Este token de acesso pode ser gerado programaticamente ou a partir do portal do publicador Gestão de API. Para obter instruções sobre como gerar e obter o token de acesso, veja Para criar manualmente um token de acesso e Para criar programaticamente um token de acesso.

URL Base

O URL Base da gestão direta Gestão de API API REST está em conformidade com o modelo seguinte.

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

Este modelo contém o seguinte parâmetro.

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

Todos os URLs devolvidos pelo Gestão de API API REST são relativos a este URL base e todos os pedidos à API REST têm de utilizar este modelo de URL base.

Parâmetro de Consulta de Versão

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

Nota

Durante um período de pré-visualização de um Gestão de API API REST, -preview é anexado ao parâmetro de consulta de versão, por exemplo 2021-04-01-preview.

Se este parâmetro de consulta não for transmitido na cadeia de consulta de um pedido, o servidor devolverá um código de estado de 400 Bad Request. Para obter uma lista de versões suportadas, veja Gestão de API referência da API REST.

Passos seguintes