Definições de relatório de runbook

Configure definições centralizadas de entrega por e-mail e armazenamento para runbooks de relatório.

Visão geral

Vários runbooks do RealmJoin incluem capacidades automatizadas 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 e-mail — usando a API do Microsoft Graph em nome de um endereço de remetente configurado
• carregados para uma Azure Storage Account — e disponibilizados como um link de download SAS com tempo limitado

Suportar 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 constante crescimento. Ambos os canais podem ser ativados independentemente ou em combinação.

Todas as definições partilhadas são configuradas uma vez na Personalização de RealmJoin Runbook e aplicam-se automaticamente a todos os runbooks que usam a respetiva funcionalidade. 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 respetivo runbook.

As funções que consomem estas definições — Send-RjRbReportEmail e Publish-RjRbFilesToStorageContainer — são fornecidas pelo RealmJoin.RunbookHelper módulo PowerShell. Consulte Funções de relatório para documentação detalhada de utilização.

Entrega por e-mail

Pré-requisitos

Recomendamos utilizar uma caixa de correio partilhada dedicada, como [e-mail]. Esta caixa de correio será usada como endereço do 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 Personalização Baseada em JSON documentação, navegue até Personalização de RealmJoin Runbook no Portal RealmJoin (Settings > Runbook Customizations).

No bloco "Settings", adicione ou modifique a seção RJReport para incluir a EmailSender propriedade com o endereço de e-mail do remetente desejado:

{
    "Settings": {
        "RJReport": {
            "EmailSender": "[e-mail]"
        }
    }
}

Substitua [e-mail] pelo endereço real da sua caixa de correio partilhada.

Informações de contacto do Service Desk (opcional)

Esta configuração central fornece apenas os valores unificados do Service Desk para todos os runbooks. Se as informações de contacto são efetivamente incluídas num e-mail 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 respetivos e-mails.

Para fornecer as informações de contacto do Service Desk para estes runbooks, adicione as seguintes propriedades à RJReport seção:

{
    "Settings": {
        "RJReport": {
            "EmailSender": "[e-mail]",
            "ServiceDesk_DisplayName": "IT Service Desk",
            "ServiceDesk_EMail": "[e-mail]",
            "ServiceDesk_Phone": "[phone]",
            "ServiceDesk_PortalUrl": "https://servicedesk.domain.com"
        }
    }
}

Parâmetros:

• ServiceDesk_DisplayName — Nome de exibição do seu Service Desk (por exemplo, "IT Support", "Help Desk")
• ServiceDesk_EMail — Endereço de e-mail do Service Desk (mostrado como um mailto: link clicável)
• ServiceDesk_Phone — Número de telefone do Service Desk em formato internacional (mostrado como um tel: link clicável)
• ServiceDesk_PortalUrl — URL do portal ou website do seu Service Desk (mostrado como um link clicável)

Todos os parâmetros são opcionais. Se configurados, aparecerão no rodapé do e-mail como links clicáveis.

Nota: Alguns runbooks também aceitam um link 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 por Storage Account

Os runbooks de relatórios que suportam este canal de entrega podem carregar a sua saída para um contentor de Azure Blob Storage. Após um carregamento bem-sucedido, o runbook devolve um link SAS com tempo limitado que pode ser usado para descarregar o ficheiro diretamente. Este canal pode ser usado isoladamente ou em complemento da entrega por e-mail.

Pré-requisitos

É necessária uma Azure Storage Account existente. A identidade gerida da Automation Account (ou o service principal usado pelos runbooks) precisa de, no mínimo, Storage Blob Data Contributor permissões na Storage Account ou no seu grupo de recursos.

Configuração

Navegue até Personalização de RealmJoin Runbook e adicione uma StorageAccount subsecção ao RJReport bloco:

{
    "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	Antecede um carimbo de data/hora (yyyyMMdd-HHmmss) ao nome do blob para evitar substituições
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 excerto seguinte mostra uma configuração completa RJReport com todas as funcionalidades ativadas:

{
    "Settings": {
        "RJReport": {
            "EmailSender": "[e-mail]",
            "ServiceDesk_DisplayName": "IT Service Desk",
            "ServiceDesk_EMail": "[e-mail]",
            "ServiceDesk_Phone": "[phone]",
            "ServiceDesk_PortalUrl": "https://servicedesk.domain.com", 
            "StorageAccount": {
                "ResourceGroup": "rg-reports",
                "StorageAccountName": "stcontosoreports",
                "LinkExpiryDays": 6,
                "AddBlobNamePrefix": true,
                "UseRandomPrefix": false
            }
        }
    }
}