> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/pt/automacao/runbooks/runbook-references/overview.md).

# Visão Geral

Este documento fornece uma visão geral abrangente de todos os runbooks atualmente disponíveis no portal RealmJoin. Cada runbook é listado juntamente com uma breve descrição ou sinopse para dar uma compreensão clara do seu propósito e funcionalidade.

Para garantir uma navegação fácil, os runbooks são categorizados em diferentes secções com base na sua área de aplicação. As seguintes categorias estão atualmente disponíveis:

* Dispositivo
* Grupo
* Organização
* Utilizador

Cada categoria contém vários runbooks que são ainda divididos em subcategorias com base na sua funcionalidade. Os runbooks são listados por ordem alfabética em cada subcategoria.

### Dispositivo

#### AVD

| Nome do Runbook           | Sinopse                                                                                   |
| ------------------------- | ----------------------------------------------------------------------------------------- |
| Reiniciar Host            | Reinicia um Host de Sessão AVD específico.                                                |
| Alternar Modo de Drenagem | Define o modo de drenagem como verdadeiro ou falso para um Host de Sessão AVD específico. |

#### Geral

| Nome do Runbook                         | Sinopse                                                                                       |
| --------------------------------------- | --------------------------------------------------------------------------------------------- |
| Atribuir Grupos Por Modelo              | Atribuir grupos apenas na cloud a um dispositivo com base num modelo                          |
| Alterar Grouptag                        | Atribui uma nova AutoPilot GroupTag a este dispositivo.                                       |
| Verificar Conformidade do Dispositivo   | Verifica o estado de conformidade de um dispositivo                                           |
| Verificar Ativos Atualizáveis           | Verifica se um dispositivo está registado no Windows Update for Business                      |
| Registar Ativos Atualizáveis            | Registar dispositivo no Windows Update for Business                                           |
| Desativar Dispositivo                   | Remover/Desativar um dispositivo Windows                                                      |
| Remover Utilizador Principal            | Remove o utilizador principal de um dispositivo.                                              |
| Renomear Dispositivo                    | Renomeia um dispositivo.                                                                      |
| Definir Utilizador Principal            | Define um novo utilizador principal num dispositivo Managed Intune                            |
| Cancelar Registo de Ativos Atualizáveis | Cancelar o registo do dispositivo do Windows Update for Business.                             |
| Limpar Dispositivo                      | Limpar um dispositivo Windows ou MacOS                                                        |
| Limpar Dados de Aplicações Geridas      | Limpeza seletiva da aplicação - remove os dados da aplicação da empresa deste dispositivo MAM |

#### Segurança

| Nome do Runbook                           | Sinopse                                                                                                           |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Verificar Estado do Defender              | Verifica a presença e o estado de risco de um dispositivo em Entra ID e Microsoft Defender for Endpoint           |
| Ativar ou Desativar Dispositivo           | Ativa ou desativa um dispositivo em Entra ID                                                                      |
| Isolar ou Libertar Dispositivo            | Isola este dispositivo.                                                                                           |
| Repor PIN de Dispositivo Móvel            | Repor a palavra-passe/código PIN de um dispositivo móvel.                                                         |
| Restringir ou Libertar Execução de Código | Permitir apenas a execução de código assinado pela Microsoft num dispositivo, ou remover uma restrição existente. |
| Mostrar Chave de Recuperação do BitLocker | Mostrar todas as chaves de recuperação BitLocker de um dispositivo                                                |
| Mostrar Chave de Recuperação do Filevault | Mostrar a chave de recuperação do FileVault do macOS                                                              |
| Mostrar Palavra-passe LAPS                | Mostra uma palavra-passe de administrador local para um dispositivo.                                              |

### Grupo

#### Dispositivos

| Nome do Runbook                                    | Sinopse                                                                                  |
| -------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| Verificar Ativos Atualizáveis                      | Verifica se os dispositivos de um grupo estão registados no Windows Update for Business. |
| Cancelar Registo de Ativos Atualizáveis (Agendado) | Cancelar o registo dos dispositivos do Windows Update for Business.                      |

#### Geral

| Nome do Runbook                     | Sinopse                                                                                                                 |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| Adicionar ou Remover Grupo Aninhado | Adicionar/remover um grupo aninhado a/de um grupo                                                                       |
| Adicionar ou Remover Proprietário   | Adicionar ou remover um proprietário de grupo do Office 365                                                             |
| Adicionar ou Remover Utilizador     | Adicionar ou remover um membro do grupo                                                                                 |
| Alterar Visibilidade                | Alterar a visibilidade de um grupo                                                                                      |
| Listar Todos os Membros             | Listar todos os membros de um grupo, incluindo membros que fazem parte de grupos aninhados                              |
| Listar Proprietários                | Listar todos os proprietários de um grupo do Office 365.                                                                |
| Listar Dispositivos do Utilizador   | Listar os dispositivos pertencentes a membros do grupo.                                                                 |
| Remover Grupo                       | Remover um grupo. Para grupos Microsoft 365, também os recursos associados (Teams, site do SharePoint) serão removidos. |
| Renomear Grupo                      | Renomear um grupo.                                                                                                      |

#### Correio

| Nome do Runbook                          | Sinopse                                                                              |
| ---------------------------------------- | ------------------------------------------------------------------------------------ |
| Ativar ou Desativar Correio Externo      | Permitir ou impedir que partes externas enviem emails para um grupo do Microsoft 365 |
| Mostrar ou Ocultar na Lista de Endereços | Mostrar ou ocultar um grupo na lista de endereços                                    |

#### Teams

| Nome do Runbook | Sinopse             |
| --------------- | ------------------- |
| Arquivar Equipa | Arquivar uma equipa |

### Organização

#### Aplicações

| Nome do Runbook                                            | Sinopse                                                                                     |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| Adicionar Registo de Aplicação                             | Adicionar um registo de aplicação ao Azure AD                                               |
| Adicionar Registo de Aplicação Gsa                         | Adicionar um registo de aplicação GSA ao Azure AD                                           |
| Eliminar Registo de Aplicação                              | Eliminar um registo de aplicação do Azure AD                                                |
| Eliminar Registo de Aplicação Gsa                          | Eliminar um registo de aplicação GSA do Azure AD, incluindo objetos associados              |
| Exportar Utilizadores de Aplicações Empresariais           | Exportar um relatório de todos os proprietários e utilizadores de aplicações (empresariais) |
| Listar Aplicações Empresariais Inativas                    | Listar aplicações empresariais sem início de sessão recente                                 |
| Relatório de Registo de Aplicação                          | Gerar e enviar por email um relatório abrangente de Registo de Aplicação                    |
| Relatório de Credenciais de Aplicação a Expirar (Agendado) | Listar a data de expiração de todas as credenciais de Registo de Aplicação                  |
| Atualizar Registo de Aplicação                             | Atualizar um registo de aplicação no Azure AD                                               |

#### Dispositivos

| Nome do Runbook                                                     | Sinopse                                                                                                             |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Adicionar Dispositivo Autopilot                                     | Importar um dispositivo Windows para o Windows Autopilot                                                            |
| Adicionar Dispositivo Via Identificador Corporativo                 | Importar um dispositivo para o Intune através de identificador corporativo                                          |
| Aprovar Automaticamente Atualizações de Controladores (Agendado)    | Aprovar automaticamente novas atualizações de controladores nas políticas de atualização de controladores do Intune |
| Limpeza de Dispositivos Autopilot (Agendado)                        | Limpar registos de dispositivos Windows Autopilot órfãos e desatualizados                                           |
| Criar Linha de Base do Endpoint Analytics                           | Cria linhas de base do Endpoint Analytics no Microsoft Intune com um esquema de nomenclatura especificado.          |
| Eliminar Duplicação de Nomes de Dispositivo (Agendado)              | Deteta e renomeia nomes de apresentação de dispositivos Intune duplicados usando um prefixo e um sufixo aleatório   |
| Eliminar Dispositivos Desatualizados (Agendado)                     | Eliminação agendada de dispositivos desatualizados com base na data da última atividade e na plataforma             |
| Obter Chave de Recuperação do BitLocker                             | Obter a chave de recuperação do BitLocker                                                                           |
| Notificar Utilizadores Sobre Dispositivos Desatualizados (Agendado) | Notificar os utilizadores principais sobre os seus dispositivos desatualizados por email                            |
| Desativar Dispositivos                                              | Remover ou desativar vários dispositivos                                                                            |
| Relatório de Dispositivos Sem Utilizador Principal (Agendado)       | Relata todos os dispositivos geridos no Intune que não têm um utilizador principal atribuído.                       |
| Relatório de Desfasamento do Utilizador Principal (Agendado)        | Compara as atribuições de utilizador principal no Intune com o RealmJoin para dispositivos Windows geridos          |
| Relatório de Dispositivos Desatualizados (Agendado)                 | Relatório agendado de dispositivos desatualizados com base na data da última atividade e na plataforma.             |
| Relatório de Utilizadores com Mais de 5 Dispositivos (Agendado)     | Relatar utilizadores com mais de cinco dispositivos registados                                                      |
| Relatório de Dispositivos Windows Sem Autopilot (Agendado)          | Relata todos os dispositivos Windows Entra que não têm um objeto Windows Autopilot associado.                       |
| Sincronizar Números de Série de Dispositivos com Entraid (Agendado) | Sincronizar números de série do Intune com atributos de extensão do Entra ID                                        |

#### Geral

| Nome do Runbook                                                       | Sinopse                                                                                                                   |
| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| Adicionar Dispositivos dos Utilizadores ao Grupo (Agendado)           | Sincronizar os dispositivos de utilizadores de um grupo específico para outro grupo de dispositivos                       |
| Adicionar Parceiro de Gestão                                          | Listar ou adicionar ligações de parceiro de gestão (PAL)                                                                  |
| Adicionar Logótipos de Aplicações da Microsoft Store                  | Atualizar logótipos de aplicações da Microsoft Store (nova) no Intune                                                     |
| Adicionar Grupo do Office365                                          | Criar um grupo do Office 365 e um site do SharePoint, opcionalmente criar uma equipa do Teams.                            |
| Adicionar ou Remover Exclusão Safelinks                               | Adicionar ou remover uma exclusão de URL do SafeLinks de uma política                                                     |
| Adicionar ou Remover Exclusão Smartscreen                             | Adicionar ou remover um indicador de URL do SmartScreen no Microsoft Defender                                             |
| Adicionar ou Remover Site de Confiança                                | Adicionar ou remover uma entrada de URL na política de Sites de Confiança do Intune                                       |
| Adicionar Utilizadores Principais de Dispositivos ao Grupo (Agendado) | Sincronizar utilizadores principais de dispositivos Managed Intune por plataforma para um grupo do Entra ID               |
| Adicionar Grupo de Segurança                                          | Criar um grupo de segurança do Microsoft Entra ID                                                                         |
| Adicionar Utilizador                                                  | Criar uma nova conta de utilizador                                                                                        |
| Adicionar Comunidade Viva Engage                                      | Criar uma comunidade Viva Engage (Yammer)                                                                                 |
| Atribuir Grupos Por Modelo (Agendado)                                 | Atribuir grupos apenas na cloud a muitos utilizadores com base num modelo predefinido                                     |
| Eliminar em Massa Dispositivos do Autopilot                           | Eliminar em massa objetos Autopilot por número de série                                                                   |
| Transferir em Massa Dispositivos do Intune                            | Transferir em massa dispositivos do Intune usando números de série                                                        |
| Verificar Estado de Sincronização do AAD (Agendado)                   | Verificar o último estado de sincronização do Azure AD Connect                                                            |
| Verificar Atribuições de Dispositivos                                 | Verificar atribuições do Intune para um ou mais nomes de dispositivos                                                     |
| Verificar Atribuições de Grupos                                       | Verificar atribuições do Intune para um ou mais nomes de grupos                                                           |
| Verificar Atribuições de Utilizadores                                 | Verificar atribuições do Intune para um ou mais nomes principais de utilizador                                            |
| Verificar Números de Série do Autopilot                               | Verificar se os números de série fornecidos estão presentes no Autopilot                                                  |
| Verificar Exclusão de Registo do Dispositivo (Agendado)               | Adicionar dispositivos Autopilot não registados a um grupo de exclusão                                                    |
| Relatório de Dispositivos Registados (Agendado)                       | Mostrar os registos recentes de dispositivos pela primeira vez                                                            |
| Exportar Todos os Dispositivos Autopilot                              | Listar ou exportar todos os dispositivos Windows Autopilot                                                                |
| Exportar Todos os Dispositivos Intune                                 | Exportar uma lista de todos os dispositivos Intune e onde estão registados                                                |
| Exportar Utilização do Cloudpc (Agendado)                             | Escrever dados diários de utilização do Windows 365 para o Azure Table Storage                                            |
| Exportar Dispositivos Não Conformes                                   | Exportar dispositivos e definições Intune não conformes                                                                   |
| Exportar Relatório de Política                                        | Criar um relatório das políticas do tenant do Intune e do Entra ID.                                                       |
| Convidar Utilizadores Convidados Externos                             | Convidar utilizadores convidados externos para a organização                                                              |
| Listar Todas as Políticas de Modelo Administrativo                    | Listar todas as políticas de Modelo Administrativo e as respetivas atribuições                                            |
| Listar Erros de Atribuição de Licença de Grupo                        | Relatar grupos que têm erros de atribuição de licença                                                                     |
| Relatório de Licenças do Office365                                    | Gerar um relatório de licenciamento do Office 365                                                                         |
| Relatório de Expiração do Certificado Apple MDM (Agendado)            | Monitorizar/Relatar a expiração de certificados de gestão de dispositivos Apple                                           |
| Relatório de Atribuição de Licença (Agendado)                         | Gerar e enviar por email um relatório de disponibilidade de licenças com base em limites                                  |
| Relatório de Ativações PIM (Agendado)                                 | Relatório agendado sobre ativações PIM                                                                                    |
| Sincronizar Todos os Dispositivos                                     | Sincronizar todos os dispositivos Windows do Intune                                                                       |
| Sincronizar Tokens Apple                                              | Sincronizar os Tokens do Apple Enrollment Program e os Tokens VPP com o Intune                                            |
| Sincronizar Membros do Canal ou do Grupo (Agendado)                   | Sincronizar membros entre um Shared Channel do Teams ou um grupo e um grupo de segurança do Entra                         |
| Sincronizar Proprietários do Shared Channel (Agendado)                | Assegura que os membros de um grupo de segurança são proprietários de Teams mapeados e dos respetivos canais partilhados. |

#### Correio

| Nome do Runbook                                         | Sinopse                                                                                                                    |
| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Adicionar Lista de Distribuição                         | Criar um grupo de distribuição clássico                                                                                    |
| Adicionar Caixa de Correio de Equipamento               | Criar uma caixa de correio de equipamento                                                                                  |
| Adicionar Contacto de Correio                           | Criar um novo contacto de correio do Exchange Online com definições opcionais de nome de apresentação e lista de endereços |
| Adicionar ou Remover Pasta Pública                      | Adicionar ou remover uma pasta pública                                                                                     |
| Adicionar ou Remover Contacto de Correio dos Teams      | Criar/Remover um contacto para permitir endereços de email elegantes para canais do Teams.                                 |
| Adicionar ou Remover Lista Permitir/ Bloquear do Tenant | Adicionar ou remover entradas da Lista Permitir/Bloquear do Tenant                                                         |
| Adicionar Caixa de Correio de Sala                      | Criar um recurso de caixa de correio de sala                                                                               |
| Adicionar Caixa de Correio Partilhada                   | Criar uma caixa de correio partilhada                                                                                      |
| Ocultar Caixas de Correio (Agendado)                    | Ocultar ou revelar caixas de correio especiais na Lista Global de Endereços                                                |
| Definir Configuração de Reserva                         | Configurar as definições do Microsoft Bookings para a organização                                                          |

#### Telefone

| Nome do Runbook                                 | Sinopse                                                              |
| ----------------------------------------------- | -------------------------------------------------------------------- |
| Obter Atribuição de Número de Telefone do Teams | Verificar se um número de telefone está atribuído no Microsoft Teams |

#### Segurança

| Nome do Runbook                                            | Sinopse                                                                                                                     |
| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| Adicionar Indicador do Defender                            | Criar um novo indicador do Microsoft Defender for Endpoint                                                                  |
| Backup de Políticas de Conditional Access                  | Exportar políticas de Conditional Access para uma conta de armazenamento Azure                                              |
| Encontrar Número de Telefone de Autenticação SMS           | Encontrar o utilizador associado a um número de telefone específico de autenticação por SMS                                 |
| Listar Utilizadores Administradores                        | Listar os titulares de funções do Entra ID e, opcionalmente, avaliar os respetivos métodos de MFA                           |
| Listar Atribuições de Funções a Expirar                    | Listar atribuições de funções do Azure AD que expiram dentro de um determinado número de dias                               |
| Listar Dispositivos Inativos                               | Listar ou exportar dispositivos inativos sem início de sessão recente ou sincronização do Intune                            |
| Listar Utilizadores Inativos                               | Listar utilizadores sem inícios de sessão interativos recentes                                                              |
| Listar Etiquetas de Proteção da Informação                 | Listar etiquetas do Microsoft Information Protection                                                                        |
| Listar Grupos de Funções PIM sem Proprietários (Agendado)  | Listar grupos atribuíveis a funções com atribuições de funções elegíveis, mas sem proprietários                             |
| Listar Utilizadores Por Contagem de Métodos MFA            | Relatar utilizadores pela contagem dos seus métodos MFA registados                                                          |
| Listar Registos de Aplicações Vulneráveis                  | Listar registos de aplicações potencialmente vulneráveis à CVE-2021-42306                                                   |
| Monitorizar Pedidos EPM Pendentes (Agendado)               | Monitorizar e relatar pedidos de elevação pendentes do Endpoint Privilege Management (EPM)                                  |
| Notificar Políticas CA Alteradas                           | Enviar email de notificação se as políticas de Conditional Access tiverem sido criadas ou modificadas nas últimas 24 horas. |
| Relatório de Pedidos de Elevação EPM (Agendado)            | Gerar relatório para pedidos de elevação do Endpoint Privilege Management (EPM)                                             |
| Sincronizar Utilizadores MFA Seguros Para Grupo (Agendado) | Sincronizar utilizadores com métodos MFA seguros registados para um grupo do Entra ID                                       |

### Utilizador

#### AVD

| Nome do Runbook               | Sinopse                                                                  |
| ----------------------------- | ------------------------------------------------------------------------ |
| Terminar Sessão do Utilizador | Remove (Termina a Sessão de) um Utilizador específico da sua sessão AVD. |

#### Geral

| Nome do Runbook                      | Sinopse                                                                       |
| ------------------------------------ | ----------------------------------------------------------------------------- |
| Atribuir Grupos Por Modelo           | Atribuir grupos apenas na cloud a um utilizador com base num modelo           |
| Atribuir ou Desatribuir Licença      | Atribuir ou remover uma licença de um utilizador através da pertença ao grupo |
| Atribuir Windows365                  | Atribuir e provisionar um Windows 365 Cloud PC para um utilizador             |
| Listar Participações em Grupos       | Listar participações em grupos para este utilizador                           |
| Listar Titularidades de Grupos       | Listar titularidades de grupos para este utilizador.                          |
| Listar Gestor                        | Listar informações do gestor para este utilizador                             |
| Desativar Utilizador Permanentemente | Desativar um utilizador permanentemente                                       |
| Desativar Utilizador Temporariamente | Desativar um utilizador temporariamente                                       |
| Reprovisionar Windows365             | Reprovisionar um Windows 365 Cloud PC                                         |
| Redimensionar Windows365             | Redimensionar um Windows 365 Cloud PC existente para um utilizador            |
| Cancelar Atribuição de Windows365    | Remover e desprovisionar um Windows 365 Cloud PC para um utilizador           |

#### Correio

| Nome do Runbook                                  | Sinopse                                                                                                  |
| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
| Adicionar ou Remover Endereço de Email           | Adicionar ou remover um endereço de email para uma caixa de correio                                      |
| Atribuir Política de Caixa de Correio OWA        | Atribuir uma política de caixa de correio OWA a um utilizador                                            |
| Converter em Caixa de Correio Partilhada         | Converter uma caixa de correio de utilizador numa caixa de correio partilhada e vice-versa               |
| Delegar Acesso Total                             | Delegar permissões FullAccess a outro utilizador numa caixa de correio ou remover a delegação existente  |
| Delegar Enviar Como                              | Delegar permissões SendAs para outro utilizador na sua caixa de correio ou remover a delegação existente |
| Delegar Enviar Em Nome de                        | Delegar permissões SendOnBehalf para a caixa de correio do utilizador                                    |
| Ocultar ou Revelar na Lista de Endereços         | Ocultar ou mostrar uma caixa de correio no livro de endereços                                            |
| Listar permissões da caixa de correio            | Listar permissões da caixa de correio para uma caixa de correio                                          |
| Listar configuração da caixa de correio de sala  | Listar configuração da caixa de correio de sala                                                          |
| Gerir caixa de correio de arquivo                | Gerir a caixa de correio de arquivo do Exchange Online para um utilizador                                |
| Remover caixa de correio                         | Eliminar permanentemente uma caixa de correio partilhada, de sala ou um calendário de reservas           |
| Definir Fora do Escritório                       | Ativar ou desativar as notificações fora do escritório para uma caixa de correio                         |
| Definir configuração da caixa de correio de sala | Definir políticas de recursos da caixa de correio de sala                                                |

#### Telefone

| Nome do Runbook                                        | Sinopse                                                                                                                                          |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Desativar Teams Phone                                  | Desativação de telefonia do Microsoft Teams                                                                                                      |
| Obter informações do utilizador do Teams               | Obter o estado de voz do Microsoft Teams para um utilizador                                                                                      |
| Conceder políticas de utilizador do Teams              | Conceder políticas do Microsoft Teams a um utilizador com Microsoft Teams ativado                                                                |
| Definir encaminhamento permanente de chamadas do Teams | Definir encaminhamento imediato de chamadas para um utilizador do Teams                                                                          |
| Definir Teams Phone                                    | Atribuir um número de telefone a um utilizador com Microsoft Teams ativado, ativar chamadas e conceder políticas específicas do Microsoft Teams. |

#### Segurança

| Nome do Runbook                                  | Sinopse                                                                                |
| ------------------------------------------------ | -------------------------------------------------------------------------------------- |
| Confirmar ou descartar utilizador em risco       | Confirmar comprometimento ou descartar um utilizador em risco                          |
| Criar Temporary Access Pass                      | Criar um Temporary Access Pass para um utilizador                                      |
| Ativar ou desativar a expiração da palavra-passe | Ativar ou desativar a expiração da palavra-passe para um utilizador                    |
| Listar métodos MFA                               | Listar todos os métodos MFA/autenticação de um utilizador                              |
| Repor MFA                                        | Remover todos os métodos de autenticação de aplicações e de telemóvel de um utilizador |
| Repor palavra-passe                              | Repor a palavra-passe de um utilizador                                                 |
| Revogar ou restaurar acesso                      | Revogar ou restaurar o acesso do utilizador                                            |
| Definir ou remover MFA do telemóvel              | Definir ou remover o método MFA do telemóvel de um utilizador                          |

#### Informações do utilizador

| Nome do Runbook      | Sinopse                                         |
| -------------------- | ----------------------------------------------- |
| Renomear utilizador  | Renomear um utilizador ou uma caixa de correio  |
| Definir fotografia   | Definir a fotografia de perfil de um utilizador |
| Atualizar utilizador | Atualizar metadados e associações do utilizador |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.realmjoin.com/pt/automacao/runbooks/runbook-references/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
