> 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-report-settings.md). # Definições de relatório de runbook ## Visão geral Vários runbooks do RealmJoin incluem capacidades automatizadas de geração de relatórios para entregar relatórios, notificações e alertas diretamente aos administradores. Dependendo da configuração, os relatórios podem ser: * **enviados por email** — usando a API do Microsoft Graph em nome de um endereço remetente configurado * **carregados para uma Azure Storage Account** — e disponibilizados como um link de download SAS com validade limitada O suporte a ambos os canais de entrega é o padrão pretendido para todos os runbooks de relatórios daqui em diante. Nem todos os runbooks de relatórios podem ainda suportar ambos os canais, mas o conjunto de runbooks suportados está em crescimento contínuo. Ambos os canais podem ser ativados independentemente ou em conjunto. Todas as definições partilhadas são configuradas uma única vez na [Personalização de Runbook do RealmJoin](https://portal.realmjoin.com/settings/runbooks-customizations) e aplicam-se automaticamente a todos os runbooks que usam a funcionalidade correspondente. As definições que diferem por runbook (como o nome do contentor de destino) não fazem parte desta configuração central e são definidas diretamente no runbook respetivo. As funções que consomem estas definições — [`Send-RjRbReportEmail`](/pt/dev-reference/report-functions/send-rjrbreportemail.md) e [`Publish-RjRbFilesToStorageContainer`](/pt/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md) — são fornecidas pelo **RealmJoin.RunbookHelper** módulo PowerShell. Consulte [Funções de relatório](/pt/dev-reference/report-functions.md) para documentação detalhada de utilização. ## Entrega por email ### Pré-requisitos Recomendamos usar uma caixa de correio partilhada dedicada, como `realmjoin-report@contoso.com`. Esta caixa de correio será usada como endereço remetente para todos os relatórios. Pode usar um endereço sem resposta, uma vez que não se espera que os destinatários respondam a relatórios automatizados. ### Configuração Conforme descrito em detalhe na [documentação Personalização baseada em JSON](https://docs.realmjoin.com/automation/runbooks/runbook-customization#json-based-customizing) , navegue até [Personalização de Runbook do RealmJoin](https://portal.realmjoin.com/settings/runbooks-customizations) no RealmJoin Portal (Definições > Personalizações de Runbook). No `bloco Definições` , adicione ou modifique a `RJReport` secção para incluir a `EmailSender` propriedade com o endereço de email do remetente pretendido: ```json { "Settings": { "RJReport": { "EmailSender": "realmjoin-report@contoso.com" } } } ``` Substitua `realmjoin-report@contoso.com` pelo endereço real da sua caixa de correio partilhada. ### Informações de contacto do Service Desk (opcional) Esta configuração central apenas fornece os valores unificados do Service Desk para todos os runbooks. Se as informações de contacto são efetivamente incluídas num email de notificação é determinado pelo próprio runbook correspondente — apenas os runbooks que implementam os parâmetros correspondentes do Service Desk (por exemplo, `ServiceDeskDisplayName`, `ServiceDeskPortalUrl`) leem estes valores e apresentam-nos nos seus emails. Para fornecer as informações de contacto do Service Desk para estes runbooks, adicione as seguintes propriedades à `RJReport` secção: ```json { "Settings": { "RJReport": { "EmailSender": "realmjoin-report@contoso.com", "ServiceDesk_DisplayName": "IT Service Desk", "ServiceDesk_EMail": "servicedesk@domain.com", "ServiceDesk_Phone": "+49123456789", "ServiceDesk_PortalUrl": "https://servicedesk.domain.com" } } } ``` **Parâmetros:** * `ServiceDesk_DisplayName` — Nome de apresentação do seu Service Desk (por exemplo, "IT Support", "Help Desk") * `ServiceDesk_EMail` — Endereço de email do Service Desk (mostrado como uma `mailto:` ligação) * `ServiceDesk_Phone` — Número de telefone do Service Desk em formato internacional (mostrado como uma `tel:` ligação) * `ServiceDesk_PortalUrl` — URL do portal ou website do Service Desk (mostrada como uma ligação clicável) Todos os parâmetros são opcionais. Se configurados, aparecerão no rodapé do email como ligações clicáveis. > **Nota:** Alguns runbooks também aceitam uma ligação de ticket por execução (por exemplo, `ServiceDeskTicketUrl`) para referenciar o ticket específico que desencadeou o pedido. Este é um parâmetro do runbook, não faz parte desta configuração central. ## Entrega via Storage Account Os runbooks de relatórios que suportam este canal de entrega podem carregar o respetivo resultado para um contentor Azure Blob Storage. Após um carregamento bem-sucedido, o runbook devolve um link SAS com validade limitada que pode ser usado para descarregar o ficheiro diretamente. Este canal pode ser usado de forma independente ou em adição à entrega por email. ### Pré-requisitos É necessária uma Azure Storage Account existente. A identidade gerida da Automation Account (ou o Service Principal usado pelos runbooks) precisa, no mínimo, de **Storage Blob Data Contributor** permissões na Storage Account ou no respetivo grupo de recursos. ### Configuração Navegue até [Personalização de Runbook do RealmJoin](https://portal.realmjoin.com/settings/runbooks-customizations) e adicione uma `StorageAccount` subsecção ao `RJReport` bloco: ```json { "Settings": { "RJReport": { "StorageAccount": { "ResourceGroup": "rg-reports", "StorageAccountName": "stcontosoreports", "LinkExpiryDays": 6, "AddBlobNamePrefix": true, "UseRandomPrefix": false } } } } ``` **Parâmetros:** | Definição | Obrigatório | Predefinição | Descrição | | -------------------- | ----------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ResourceGroup` | sim | — | Grupo de recursos que contém a Storage Account | | `StorageAccountName` | sim | — | Nome da Azure Storage Account | | `LinkExpiryDays` | não | `6` | Número de dias até o link de download SAS gerado expirar | | `AddBlobNamePrefix` | não | `verdadeiro` | Antepõe um carimbo de data/hora (`yyyyMMdd-HHmmss`) ao nome do blob para evitar sobrescritas | | `UseRandomPrefix` | não | `falso` | Usa uma cadeia aleatória alfanumérica de 6 caracteres como prefixo em vez de um carimbo de data/hora; aplica-se apenas quando `AddBlobNamePrefix` é `verdadeiro` | > **Nota:** As definições específicas de um runbook individual — como o nome do contentor de destino ou um nome de blob personalizado — são configuradas diretamente nesse runbook e, intencionalmente, não fazem parte desta configuração central. ## Exemplo combinado O trecho seguinte mostra uma configuração completa `RJReport` configuração com todos os recursos ativados: ```json { "Settings": { "RJReport": { "EmailSender": "realmjoin-report@contoso.com", "ServiceDesk_DisplayName": "IT Service Desk", "ServiceDesk_EMail": "servicedesk@domain.com", "ServiceDesk_Phone": "+49123456789", "ServiceDesk_PortalUrl": "https://servicedesk.domain.com", "StorageAccount": { "ResourceGroup": "rg-reports", "StorageAccountName": "stcontosoreports", "LinkExpiryDays": 6, "AddBlobNamePrefix": true, "UseRandomPrefix": false } } } } ``` --- # 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-report-settings.md?ask=&goal= ``` `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.