Configurar Conector de APIs do Service Graph para Gerenciamento de API do Azure usando a configuração assistida

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 9 min. de leitura
  • Configure trabalhos de importação agendada para inserir dados Gerenciamento de API do Azure no seu CMDB.

    Antes de Iniciar

    Importante:
    A menos que haja problemas, use a exibição Central do SGC, pois o método de configuração assistida será descontinuado. Se uma conexão for configurada usando a configuração assistida, a conexão poderá não aparecer na exibição Central do SGC.
    Dependências e requisitos:
    • A aplicação da Store Componentes comuns de integração para CMDB, que é instalado automaticamente. Veja Componentes comuns de integração para CMDB.
    • O app da Store para os Modelos de classe de IC do CMDB, que é instalado automaticamente. Consulte Modelos de classe de IC do CMDB.
    • O plug-in de licença da Descoberta do ITOM (com.snc.itom.discovery.license). Você deve ativar este plug-in.
    • Plug-in de licenciamento do ITOM (com.snc.itom.license). Consulte Request Discovery.
    Obtenha as credenciais do OAuth do administrador Azure. Anote os seguintes detalhes:
    • ID da aplicação (cliente)
    • Segredo do Cliente
    • ID do diretório (locatário)
    • URL de Conexão

    Função necessária: administrador

    Procedimento

    1. Use o seletor de aplicações para verificar se o escopo da aplicação está definido para a aplicação Conector de APIs do Service Graph para Gerenciamento de API do Azure.
      Para obter mais informações, consulte Seletor de aplicações.
    2. Navegar até Tudo > Conectores do Service Graph > Gestão de APIs Azure > Configuração.
    3. Na página Conector de APIs do Service Graph para Gerenciamento de API do Azure, verifique se a opção Início rápido está selecionada e selecione Continuar.
    4. Configure as credenciais de autenticação a fim de enviar solicitações para a aplicação do Gerenciamento de API do Azure.
      1. Na seção Configurar conexão e credenciais da página Conector de APIs do Service Graph para Gerenciamento de API do Azure, selecione Iniciar.
      2. Configure a conexão.
        1. Selecione a tarefa Configurar credenciais de autenticação do Azure.
        2. Selecione Clique aqui para abrir a página Conexões em uma guia separada do navegador.
        3. Pesquise e selecione Editar para Conexão de gestão de API do Azure.
        4. Na seção Informações de conexão da janela "Editar conexão", preencha os campos.
          Tabela 1. Informação de conexão
          Campo Descrição
          Nome da conexão de gerenciamento de API do Azure Nome para identificar o registro de conexão Gerenciamento de API do Azure.

          Conexão de gerenciamento de API do Azure é o nome do alias padrão da credencial. Você pode adicionar várias instâncias de Gerenciamento de API do Azure. No entanto, tente não modificar o nome da conexão padrão.

          URL de Conexão URL base para se conectar ao serviço Gerenciamento de API do Azure.
          Com base na região da sua aplicação cliente Azure, insira o URL em um dos seguintes formatos:
          • Global
            https://management.azure.com
          • Governo dos EUA
            htttps://management.usgovcloudapi.net
          • China
            https://management.chinacloudapi.cn
          • Alemanha
            https://management.microsoftazure.de/
        5. Na seção Informações de credencial da janela "Editar conexão", preencha os campos.
          Tabela 2. Informações de credencial
          Campo Descrição
          ID do cliente OAuth ID da aplicação (cliente) da sua aplicação cliente do Azure, conforme observado na seção Antes de começar.
          Segredo do cliente OAuth Segredo do cliente da sua aplicação cliente do Azure, conforme observado na seção Antes de começar.
          URL do token Oauth URL do token da sua aplicação cliente do Azure.
          Com base na região da sua aplicação cliente Azure, insira o URL do token em um dos seguintes formatos:
          • Global
            https://login.microsoftonline.com/<tenantid>/oauth2/v2.0/token
          • Governo dos EUA
            https://login.microsoftonline.us/<tenantid>/oauth2/v2.0/token
          • China
            https://login.partner.microsoftonline.cn/<tenantid>/oauth2/v2.0/token
          • Alemanha
            https://login.microsoftonline.de/<tenantid>/oauth2/v2.0/token
          Onde <tenantid> é o ID do locatário da sua aplicação cliente do Azure, conforme observado na seção Antes de começar.
        6. Selecione Editar e obter token OAuth.
        7. Selecione Atualizar.
        8. Quando o fluxo de token OAuth for devidamente concluído, retorne à página de configuração assistida e defina a tarefa Configurar credenciais de autenticação do Azure como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      3. Configure uma conexão para gerenciar Azure recursos por meio de Gerenciamento de API do Azure.
        1. Selecione a tarefa Configurar propriedades.
        2. Na lista relacionada Propriedades de conexão do Service Graph, insira os valores das propriedades.
          Tabela 3. Propriedades de conexão do Service Graph
          Propriedade Descrição
          CollectionPeriod (dias) Duração em dias para coletar dados de uso da API.
          CollectUsageData Habilite a coleta de dados de uso para recuperar dados de uso da API ao longo de uma duração especificada.
          Escopo da Descoberta Escopo de descoberta da aplicação cliente Azure. As opções disponíveis são:
          Grupo de gestão
          Selecione Grupo de gestão quando a conta de serviço ServiceNow tiver acesso aos dados dentro do grupo de gestão Azure.
          Assinatura
          Selecione Assinatura quando a conta de serviço ServiceNow tiver acesso aos dados somente na assinatura Azure.
          ExcludeServices Gerenciamento de API do Azure serviços que devem ser excluídos da conexão.

          Caso haja vários serviços, separe-os por vírgulas. Todos os gateways, exceto os listados na propriedade ExcludeServices, são extraídos.

          GetNestedGroupSubscriptions Habilite a recuperação de dados de todas as assinaturas secundárias aninhadas quando o Grupo de gestão estiver definido como o escopo de descoberta.

          Defina a propriedade como falsa para excluir assinaturas secundárias aninhadas.

          ManagementGroupId IDs do grupo de gestão de Gerenciamento de API do Azure serviços.

          Para vários grupos de gerenciamento, separe-os com vírgulas.

          Tamanho da partição Tamanho da partição para Azure APIs gerenciadas se o carregamento paralelo estiver habilitado.

          Aceita um valor numérico maior que zero. Se for deixado em branco, o valor será calculado automaticamente.

          ResourceGroups Nome do grupo de recursos dos Gerenciamento de API do Azure serviços.

          Caso haja vários grupos de recursos, separe os nomes por vírgulas. Se você deixar este campo em branco, as fontes de dados no conector importarão dados de todos os grupos de recursos disponíveis.

          SubscriptionId IDs de assinatura de Gerenciamento de API do Azure serviços.

          Para vários IDs de assinatura, separe-os com vírgulas. Se o escopo de descoberta estiver definido como Assinatura e este campo for deixado em branco, todas as assinaturas do locatário especificado nas credenciais serão descobertas.

          Dica:
          Para inserir um valor de propriedade, clique duas vezes (ou use o atalho de teclado) para inserir um valor na célula Valor da propriedade.
        3. Defina a tarefa Configurar propriedades como concluída marcando a caixa de seleção Marcar como concluída e selecione Continuar.
      4. Teste a conexão.
        1. Selecione a tarefa Testar conexão.
        2. Teste a conexão selecionando o link relacionado Testar conexão.

          O teste de conexão pode levar alguns minutos. A página é atualizada para mostrar os resultados do teste.

        3. Quando o campo Status estiver definido como Êxito, selecione Atualizar.

          Se algum dos testes apresentar algum erro, siga as sugestões de correção.

        4. Defina a tarefa Testar conexão como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
    5. Opcional: Faça a integração a várias instâncias do Gerenciamento de API do Azure.
      1. Na seção Adicionar várias instâncias da página do Conector de APIs do Service Graph para Gerenciamento de API do Azure, selecione Iniciar.
      2. Habilite a criação de fontes de dados para a nova conexão do Gerenciamento de API do Azure.
        1. Verifique se você tem permissões de edição para a tabela Fonte de dados [sys_data_source].
        2. Selecione a tarefa Atualizar acesso à fonte de dados.
        3. Para editar o registro, selecione o escopo da aplicação Global no seletor de aplicação.
        4. Na lista relacionada "Acesso à aplicação" do formulário "Fonte de dados" que é aberta em uma nova guia, marque as caixas de seleção Pode criar, Pode atualizar e Pode excluir.
        5. Selecione Atualizar.
        6. No seletor de aplicações, selecione o escopo de aplicação Conector do Service Graph de APIs para Gerenciamento de API do Azure.
        7. Defina a tarefa Atualizar acesso à fonte de dados como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      3. Habilite a criação de um trabalho de importação agendada para a nova conexão do Gerenciamento de API do Azure.
        1. Verifique se você tem permissões de edição para a tabela "Importação Programada de Dados" [scheduled_import_set].
        2. Selecione a tarefa Atualizar acesso à importação de dados agendada.
        3. Para editar o registro, selecione o escopo da aplicação Global no seletor de aplicação.
        4. Na lista relacionada "Acesso à aplicação" do formulário "Importação agendada de dados", marque as caixas de seleção Pode criar, Pode atualizar e Pode excluir.
        5. Selecione Atualizar.
        6. No seletor de aplicações, selecione o escopo de aplicação Conector do Service Graph de APIs para Gerenciamento de API do Azure.
        7. Defina a tarefa Atualizar importação de dados agendada como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      4. Limpe o cache nas tabelas "Fonte de Dados" [sys_data_source] e "Importações Programadas de Dados" [scheduled_import_set].
        1. Selecione a tarefa Limpar cache das tabelas "Fontes de dados" e "Importações agendadas de dados".
        2. Para editar o registro, selecione o escopo da aplicação Global no seletor de aplicações.
        3. No campo Executar Script, insira o código a seguir:
          GlideTableManager.invalidateTable("sys_data_source");
          GlideCacheManager.flushTable("sys_data_source");
          GlideTableManager.invalidateTable("scheduled_import_set");
          GlideCacheManager.flushTable("scheduled_import_set");
          GlideTableManager.invalidateTable("sys_db_object");
          GlideCacheManager.flushTable("sys_db_object");
        4. Selecione Executar script.
        5. No seletor de aplicações, selecione o escopo de aplicação Conector do Service Graph de APIs para Gerenciamento de API do Azure.
        6. Defina a tarefa Limpar cache das tabelas "Fontes de dados" e "Importações de dados agendadas" como concluída selecionando Marcar como concluído.
      5. Adicione outra conexão para a nova instância do Gerenciamento de API do Azure.
        1. Verifique se o escopo da aplicação está definido para a aplicação Conector do Service Graph de APIs para Gerenciamento de API do Azure usando o seletor de aplicações.
        2. Selecione a tarefa Adicionar outra conexão e, em seguida, Clicar aqui.
        3. Na página "Conexões" que abre em outra guia do navegador, selecione Adicionar conexão.
        4. Na janela "Criar conexão", preencha os detalhes de conexão, credenciais e ID de assinatura.
        5. Selecione Criar e obter um Token do OAuth.
        6. Feche a página "Conexões" e volte à guia da configuração assistida.
        7. Defina a tarefa Adicionar outra conexão como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      6. Adicione propriedades para a nova conexão.
        1. Verifique se o escopo da aplicação está definido para a aplicação Conector do Service Graph de APIs para Gerenciamento de API do Azure usando o seletor de aplicações.
        2. Selecione a tarefa Adicionar propriedades à nova configuração.
        3. Na coluna Nome, selecione o nome da conexão criada na etapa 5.e.
        4. Na lista relacionada Propriedades de conexão do Service Graph, insira os valores das propriedades.

          Para mais informações sobre propriedades, consulte 4.c.ii.

          Dica:
          Para inserir um valor de propriedade, clique duas vezes (ou use o atalho de teclado) para inserir um valor na célula Valor da propriedade.
        5. Defina a tarefa Adicionar propriedades à nova conexão como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
      7. Teste a nova conexão.
        1. Selecione a tarefa Testar novas conexões.
        2. Na coluna Nome, selecione o nome da conexão criada na etapa 5.e.
        3. Teste a conexão selecionando o link relacionado Testar conexão.

          O teste de conexão pode levar alguns minutos. A página é atualizada para mostrar os resultados do teste.

        4. Quando o campo Status estiver definido como Êxito, selecione Atualizar.

          Se algum dos testes apresentar algum erro, siga as sugestões de correção.

        5. Defina a tarefa Testar novas conexões como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
    6. Configure o trabalho agendado para a importação de dados do Gerenciamento de API do Azure.
      1. Na seção Configurar trabalhos de importação agendada da página Conector de APIs do Service Graph para Gerenciamento de API do Azure, selecione Iniciar.
      2. Selecione o trabalho agendado Serviços de gerenciamento de API do SGA Azure.
        Para executar uma configuração de várias instâncias, selecione a importação agendada que foi criada com a conexão na etapa 5.e.
      3. No formulário "Importação agendada de dados", verifique os valores dos campos.

        Para obter mais informações, consulte Schedule a data import.

      4. Marque a caixa de seleção Ativo para ativar o trabalho agendado.
      5. No campo Executar, selecione Periodicamente para especificar a frequência de execução do trabalho.
      6. Selecione Atualizar.
      7. Defina a tarefa Configurar trabalhos de importação agendada como concluída marcando a caixa de seleção Marcar como concluída e, em seguida, selecione Continuar.
    7. Na página Conector de APIs do Service Graph para Gerenciamento de API do Azure, selecione Concluído para salvar suas mudanças.
    8. Na caixa de diálogo "Concluir configuração", selecione Concluir para concluir a configuração.
    9. Na caixa de mensagem que é exibida, selecione Concluído.