> 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/fr/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md). # Publish-RjRbFilesToStorageContainer ## Vue d'ensemble `Publish-RjRbFilesToStorageContainer` est l’utilitaire standard pour la livraison de fichiers de rapport (CSV, XLSX, ZIP, …) depuis les runbooks de reporting RealmJoin via Azure Blob Storage. Il téléverse un ou plusieurs fichiers locaux vers un conteneur cible et retourne pour chaque blob un lien de téléchargement SAS limité dans le temps, adapté à l’inclusion dans des e-mails de rapport, des messages Teams ou la sortie des runbooks. Caractéristiques principales : * **Aucune `Az.Storage` dépendance** — les opérations blob sont effectuées directement via l’API REST Azure Storage (création du conteneur, téléversement, génération de jetons SAS). Cela élimine le conflit d’assembly bien connu entre `Az.Storage` et `ExchangeOnlineManagement` qui apparaît dans les runbooks de reporting mixtes. * **Auto-connexion** — si aucun `Az` contexte n’est actif, la fonction appelle automatiquement `Connect-RjRbAzAccount`. Un paramètre facultatif `-SubscriptionId` bascule le contexte avant toute opération de stockage. * **Conteneur créé automatiquement** — si le conteneur cible n’existe pas encore, il est créé à la volée ; un conteneur existant (HTTP 409) est considéré comme un succès. * **Téléversements basés sur HttpClient** — utilise `System.Net.Http.HttpClient` directement, car l’intercepteur Invoke-RestMethod d’Azure Automation supprime les en-têtes personnalisés requis ( `Invoke-RestMethod` avec les corps binaires.`x-ms-blob-type`) * **Liens SAS en lecture seule** — chaque URL renvoyée est signée avec la clé du Storage Account, limitée à un seul blob, en HTTPS uniquement et valide pendant `LinkExpiryDays` jours (6 par défaut). Les paramètres centraux de stockage (groupe de ressources, nom du compte, jours d’expiration, préfixe du nom de blob) utilisés par un runbook typique se trouvent dans le JSON de personnalisation RealmJoin et sont documentés dans [Paramètres du rapport de runbook — livraison du Storage Account](/fr/automatisation/runbooks/runbook-report-settings.md#storage-account-delivery). Ce document se concentre sur l’appel de la fonction depuis un runbook. ## Prérequis ### Azure Storage Account Un Azure Storage Account existant (v2 à usage général recommandé) est requis. Le conteneur cible n’a pas besoin d’exister à l’avance — il est créé automatiquement lors de la première utilisation. ### Azure RBAC sur le Storage Account L’identité managée du Automation Account (ou le Service Principal utilisé par le runbook) a besoin des autorisations suivantes sur le Storage Account ou son groupe de ressources : | Action | Requis pour | | --------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `Microsoft.Storage/storageAccounts/read` | Lecture du Storage Account | | `Microsoft.Storage/storageAccounts/listKeys/action` | Récupération de la clé du compte utilisée pour la signature SharedKey et la génération de SAS | Le rôle intégré **Storage Account Contributor** couvre les deux. **Storage Blob Data Contributor** seul est *pas* suffisant, car la fonction signe les requêtes avec la clé du compte plutôt que d’utiliser des opérations blob reposant sur AAD. ### Connexion des modules La fonction requiert le `Az.Accounts` module dans l’environnement du runbook (`Get-AzContext`, `Set-AzContext`, `Connect-AzAccount`, `Invoke-AzRestMethod`). Déclarez-le explicitement dans le runbook consommateur : ```powershell #Requires -Modules @{ModuleName = "RealmJoin.RunbookHelper"; ModuleVersion = "0.8.6" } #Requires -Modules @{ModuleName = "Az.Accounts"; ModuleVersion = "5.3.4" } ``` Si `Az.Accounts` n’est pas disponible à l’exécution, la fonction échoue immédiatement avec un message d’erreur clair — elle vérifie `Get-AzContext` en amont et lève *"Publish-RjRbFilesToStorageContainer nécessite le module 'Az.Accounts'. Ajoutez #Requires -Modules @{ModuleName = 'Az.Accounts'; ModuleVersion = '5.3.4'} au runbook appelant."* avant tout appel à Azure. > **Pourquoi n’est-ce pas `Az.Accounts` déclaré comme une `RequiredModules` entrée dans `RealmJoin.RunbookHelper.psd1`?** > > `Az.Accounts` est intentionnellement répertorié uniquement sous `ExternalModuleDependencies` (à titre informatif) et *pas* sous `RequiredModules` (appliqué au `Import-Module` moment) : > > * **Payez uniquement ce que vous utilisez.** Beaucoup de runbooks consomment uniquement des assistants basés sur Graph (p. ex. `Send-RjRbReportEmail` sans `-UseNativeGraphRequest`, ou `Invoke-RjRbRestMethodGraph`) et n’utilisent jamais de cmdlet Az.\*. Promouvoir `Az.Accounts` vers `RequiredModules` forcerait chaque runbook consommateur à embarquer le module même lorsqu’aucune partie de son code n’en a besoin — ce qui augmente sensiblement le temps de démarrage à froid dans Azure Automation. > * **Évitez les conflits de versions.** Une `RequiredModules` contrainte déclenche une résolution automatique à l’import et peut entraîner une `Az.Accounts` version qui entre en conflit avec ce que le runbook lui-même épingle (les sous-modules Az.\* sont notoirement sensibles aux versions). Laisser le runbook déclarer ses propres `#Requires -Modules` laisse le choix de la version à l’appelant. > * **Autorité par runbook.** Dans Azure Automation, l’endroit canonique pour déclarer les exigences de modules se situe au niveau du runbook via `#Requires`, et non au niveau du module utilitaire. Le module utilitaire expose la dépendance à titre informatif (via `ExternalModuleDependencies` dans le manifeste) et via la vérification d’exécution ci-dessus, de sorte qu’une mauvaise configuration échoue bruyamment avec un message exploitable plutôt que de masquer silencieusement un conflit de versions. `Az.Storage` est **pas** requis et ne doit pas être importé dans le même runbook afin d’éviter le conflit d’assembly mentionné ci-dessus. ## Démarrage rapide L’appel minimal viable nécessite le(s) chemin(s) de fichier local, le nom du conteneur, le groupe de ressources et le nom du Storage Account : ```powershell $csvPath = Join-Path $env:TEMP 'devices.csv' $exportData | Export-Csv -Path $csvPath -NoTypeInformation -Encoding UTF8 $results = Publish-RjRbFilesToStorageContainer ` -FilePaths $csvPath ` -ContainerName 'reports' ` -ResourceGroupName 'rg-reports' ` -StorageAccountName 'stcontosoreports' $results | Format-Table BlobName, EndTime, SASLink ``` Cela téléverse `devices.csv` vers le `reports` conteneur dans `stcontosoreports` et retourne un objet contenant le nom du blob, l’horodatage d’expiration du SAS et une URL de téléchargement prête à partager, valable pendant les 6 jours par défaut. ## Paramètres ### Requis | Paramètre | Type | Description | | -------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `FilePaths` | `string[]` | Un ou plusieurs chemins de fichiers locaux à téléverser. Chaque chemin doit pointer vers un fichier existant (`Test-Path -PathType Leaf`) ; la fonction lève une erreur en amont si une entrée est manquante. | | `ContainerName` | `string` | Conteneur blob cible. Créé automatiquement s’il n’existe pas. Doit respecter les règles de nommage des conteneurs Azure (minuscules, 3 à 63 caractères, alphanumériques + tiret). Le nom du conteneur est une *par runbook* décision et est défini dans le runbook, pas dans les paramètres centraux. | | `ResourceGroupName` | `string` | Groupe de ressources qui contient le Storage Account. Généralement relié au paramètre central `RJReport.AzureStorage.ResourceGroup`. | | `StorageAccountName` | `string` | Nom du Azure Storage Account. Généralement relié au paramètre central `RJReport.AzureStorage.StorageAccountName`. | ### Facultatif | Paramètre | Type | Valeur par défaut | Description | | ------------------- | -------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SubscriptionId` | `string` | contexte actuel | Abonnement Azure qui héberge le Storage Account. Si fourni, `Set-AzContext -Subscription` est appelé avant toute opération de stockage. Ommettez-le pour utiliser le `Az` contexte. | | `LinkExpiryDays` | `int` | `6` | Validité du lien SAS en jours. Validée à `[1, 3650]`. Le même horodatage d’expiration est appliqué à tous les blobs d’un même appel. Généralement relié au paramètre central `RJReport.AzureStorage.LinkExpiryDays`. | | `AddBlobNamePrefix` | `bool` | `$false` | Lorsque `$true`, les noms de blob sont préfixés par `yyyyMMdd-HHmmss-` (horodatage de `Get-Date` au moment du téléversement) afin d’éviter les écrasements lors d’exécutions répétées. Le nom de fichier d’origine est conservé comme suffixe. | > **Remarque :** Le mappage entre ces paramètres et le JSON de personnalisation central RealmJoin (y compris les valeurs par défaut recommandées) est documenté dans [Paramètres du rapport de runbook — livraison du Storage Account](/fr/automatisation/runbooks/runbook-report-settings.md#storage-account-delivery). ## Exemples d’utilisation ### Modèle de runbook recommandé C’est le modèle canonique utilisé par les runbooks de reporting. La configuration de stockage est récupérée depuis la personnalisation centrale RealmJoin via `Use-RJInterface -Type Setting`, le conteneur est codé en dur par runbook, et une configuration manquante provoque l’arrêt du runbook avec un message exploitable : ```powershell #Requires -Modules @{ModuleName = "RealmJoin.RunbookHelper"; ModuleVersion = "0.8.6" } #Requires -Modules @{ModuleName = "Az.Accounts"; ModuleVersion = "5.3.4" } param( [string] $ContainerName = "my-runbook-output", [ValidateScript( { Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process; Use-RJInterface -Type Setting -Attribute "RJReport.AzureStorage.ResourceGroup" } )] [string] $ResourceGroupName, [ValidateScript( { Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process; Use-RJInterface -Type Setting -Attribute "RJReport.AzureStorage.StorageAccountName" } )] [string] $StorageAccountName, [ValidateScript( { Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process; Use-RJInterface -Type Setting -Attribute "RJReport.AzureStorage.LinkExpiryDays" } )] [ValidateRange(1, 3650)] [int] $LinkExpiryDays = 6 ) Connect-RjRbAzAccount if ((-not $ResourceGroupName) -or (-not $StorageAccountName)) { "## Pour exporter vers un Storage Account, veuillez utiliser la personnalisation RJ Runbooks" "## ( https://portal.realmjoin.com/settings/runbooks-customizations ) pour configurer :" "## - RJReport.AzureStorage.ResourceGroup" "## - RJReport.AzureStorage.StorageAccountName" throw "Configuration du Storage Account manquante." } # … produire le fichier d’export … $exportPath = "myReport.csv" $uploadResults = Publish-RjRbFilesToStorageContainer ` -FilePaths @($exportPath) ` -ContainerName $ContainerName ` -ResourceGroupName $ResourceGroupName ` -StorageAccountName $StorageAccountName ` -LinkExpiryDays $LinkExpiryDays ` -AddBlobNamePrefix $true $uploadResult = $uploadResults[0] "## Export créé." "## Expiration du lien : $($uploadResult.EndTime)" $uploadResult.SASLink | Out-String ``` Quelques conventions à conserver lors de l’adoption de ce modèle : * Les trois paramètres centraux (`ResourceGroup`, `StorageAccountName`, `LinkExpiryDays`) sont exposés comme paramètres de runbook reliés via `Use-RJInterface -Type Setting`, mais généralement *masqués* dans la personnalisation du runbook (`"Hide": true`) afin que les utilisateurs finaux ne les voient jamais. * Le nom du conteneur est codé en dur par runbook (souvent via un `param` par défaut) afin que les stratégies de cycle de vie et les contrôles d’accès puissent être ajustés par type d’export — ce n’est intentionnellement *pas* un paramètre central. * `AddBlobNamePrefix $true` est la valeur par défaut sûre pour les exports périodiques qui produisent un nom de fichier fixe à chaque exécution. * La fonction est appelée dans le principal du runbook `bloc try { … } catch { throw $_ } finally { Disconnect-AzAccount … }` afin que les échecs partiels remontent vers le job Automation et que le contexte Az soit libéré même en cas de succès. ### Plusieurs fichiers dans un seul appel `FilePaths` accepte un tableau ; chaque fichier est téléversé séquentiellement et un objet résultat est renvoyé pour chaque blob téléversé. ```powershell $results = Publish-RjRbFilesToStorageContainer ` -FilePaths @($csvPath, $xlsxPath) ` -ContainerName 'reports' ` -ResourceGroupName $ResourceGroupName ` -StorageAccountName $StorageAccountName foreach ($r in $results) { "Téléversé $($r.BlobName) — téléchargeable jusqu’au $($r.EndTime) : $($r.SASLink)" } ``` ### Durée de vie du lien personnalisée et abonnement explicite ```powershell Publish-RjRbFilesToStorageContainer ` -FilePaths $exportPaths ` -ContainerName 'quarterly-reports' ` -ResourceGroupName $ResourceGroupName ` -StorageAccountName $StorageAccountName ` -SubscriptionId '00000000-0000-0000-0000-000000000000' ` -LinkExpiryDays 30 ``` Utile lorsque le runbook couvre plusieurs abonnements, ou lorsque les destinataires en aval ont besoin d’une fenêtre plus longue que la valeur par défaut de 6 jours. ### En combinaison avec `Send-RjRbReportEmail` Un modèle courant consiste à téléverser des données volumineuses dans le stockage blob et à intégrer le lien SAS dans un e-mail de rapport, en maintenant l’e-mail bien en dessous de la limite Graph de 4 Mo `sendMail` limite : ```powershell $uploaded = Publish-RjRbFilesToStorageContainer ` -FilePaths $csvPath ` -ContainerName 'reports' ` -ResourceGroupName $ResourceGroupName ` -StorageAccountName $StorageAccountName ` -AddBlobNamePrefix $true $linkLine = "[Download {0}]({1}) (valid until {2:yyyy-MM-dd HH:mm} UTC)" -f ` $uploaded[0].BlobName, $uploaded[0].SASLink, $uploaded[0].EndTime.ToUniversalTime() $reportMd = @" # Inventaire des appareils La liste complète des appareils est disponible en téléchargement : $linkLine "@ Send-RjRbReportEmail ` -EmailFrom $emailFrom ` -EmailTo 'it-reports@contoso.com' ` -Subject "Device Inventory — $(Get-Date -Format 'yyyy-MM-dd')" ` -MarkdownContent $reportMd ``` Voir [Send-RjRbReportEmail](/fr/dev-reference/report-functions/send-rjrbreportemail.md) pour la partie e-mail de ce modèle. ## Comportement et gestion des erreurs ### Validation préalable des fichiers Avant tout appel à Azure, la fonction parcourt `FilePaths` et lève `Le fichier '' est introuvable.` pour la première entrée manquante. Cela empêche les téléversements partiels lorsque l’appelant a fait une faute de frappe. ### Résolution du contexte Azure `Get-AzContext` est vérifié en premier. S’il n’y a pas de contexte ou si le contexte n’a pas de `Compte` (par ex. une nouvelle exécution de runbook), la fonction appelle `Connect-RjRbAzAccount` pour authentifier l’identité managée. Si `-SubscriptionId` est fourni, `Set-AzContext -Subscription` est invoqué ensuite. ### Création du conteneur Le conteneur est créé via une `PUT …?restype=container` requête : * **HTTP 201** — conteneur créé. * **HTTP 409** — le conteneur existe déjà ; considéré comme un succès. * **Tout autre statut** — la fonction lève `Échec de la création du conteneur () : `. ### Échecs de téléversement Chaque fichier est téléversé via `HttpClient.SendAsync`. Un statut non réussi met fin à l’appel avec `Échec du téléversement du blob () : `, y compris l’erreur brute renvoyée par Azure Storage. Les fichiers déjà téléversés lors du même appel restent dans le Storage Account — l’appelant peut vouloir encapsuler l’appel dans un try/catch et exécuter un nettoyage si les téléversements partiels sont inacceptables. ### Échecs de récupération des clés `Invoke-AzRestMethod` est utilisé pour appeler le point de terminaison ARM `listKeys` . Si le statut de réponse est autre chose que 200, la fonction lève `Échec de la récupération des clés du Storage Account pour '' dans le groupe de ressources ''. Statut : `. Les causes les plus courantes sont : * Absence de `Microsoft.Storage/storageAccounts/listKeys/action` sur l’identité managée. * Contexte d’abonnement incorrect (à combiner avec `-SubscriptionId`). * Faute de frappe dans `StorageAccountName` ou `ResourceGroupName`. * Les paramètres centraux `RJReport.AzureStorage.ResourceGroup` / `RJReport.AzureStorage.StorageAccountName` non configurés — voir [Paramètres du rapport de runbook](/fr/automatisation/runbooks/runbook-report-settings.md#storage-account-delivery). ### Caractéristiques du jeton SAS Les jetons générés utilisent : * `sv=2023-11-03` (version signée) * `sr=b` (portée blob) * `sp=r` (lecture seule) * `spr=https` (HTTPS uniquement) * `st` réglé à 5 minutes dans le passé (tolérance au décalage d’horloge) et `se` vers `LinkExpiryDays` à partir du moment de l’appel. Les jetons sont signés avec la clé du compte de stockage. **Toute personne disposant du lien peut télécharger le blob jusqu’à l’expiration** — traitez l’URL SAS renvoyée comme un secret. ## Sorties Chaque envoi réussi produit un `PSCustomObject` avec ces propriétés : | Propriété | Type | Description | | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------- | | `BlobName` | `string` | Le nom final du blob dans le conteneur, y compris le préfixe d’horodatage si `AddBlobNamePrefix` est `$true`. | | `EndTime` | `datetime` | Expiration du SAS à l’heure locale (également encodée dans l’URL en UTC). | | `SASLink` | `string` | URL de téléchargement HTTPS entièrement qualifiée avec jeton SAS intégré. | Les résultats sont renvoyés dans le même ordre que `FilePaths`. Même lorsqu’un seul fichier est téléversé, la valeur renvoyée est un tableau — indexez-le (`$results[0]`) ou itérez avec `foreach` plutôt que de le traiter comme un scalaire. ## Voir aussi * [Paramètres du rapport de runbook — livraison du Storage Account](/fr/automatisation/runbooks/runbook-report-settings.md#storage-account-delivery) — configuration centrale du compte de stockage, de l’expiration du lien et du préfixe de nom de blob utilisés par les runbooks de reporting. * [Send-RjRbReportEmail](/fr/dev-reference/report-functions/send-rjrbreportemail.md) — fonction d’assistance complémentaire pour l’envoi de rapports par e-mail ; souvent combinée à cette fonction pour garder la charge utile de l’e-mail petite. * Documentation Microsoft : [Autoriser avec une clé partagée](https://learn.microsoft.com/en-us/rest/api/storageservices/authorize-with-shared-key) — schéma de signature utilisé par l’assistant. * Documentation Microsoft : [Créer un SAS de service](https://learn.microsoft.com/en-us/rest/api/storageservices/create-service-sas) — format du jeton SAS renvoyé dans `SASLink`. --- # 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: ``` GET https://docs.realmjoin.com/fr/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.