# microsoft/reportingservicestools architecture

> Architecture diagram of the GitHub repository microsoft/reportingservicestools, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/microsoft/reportingservicestools
- Repository: https://github.com/microsoft/reportingservicestools

## Overview

ReportingServicesTools is a PowerShell command suite for administering SSRS and Power BI Report Server. Operators invoke commands to configure a server, inspect or deploy catalog content, manage subscriptions, use REST-specific features, and administer access. The README explicitly documents deployment-config output piped to project publishing, subscription export/import, and credential objects used by a REST data-source setter. Source excerpts were unavailable, so other command-to-command relationships are omitted; the server interaction shown reflects the README’s general description.

Main entry points: [`ReportingServicesTools/Functions/Admin/Initialize-Rs.ps1`](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Initialize-Rs.ps1) (Initialize server), [`ReportingServicesTools/Functions/CatalogItems/Publish-RsProject.ps1`](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Publish-RsProject.ps1) (Publish project), [`ReportingServicesTools/Functions/CatalogItems/Rest/Set-RsRestItemDataSource.ps1`](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/Set-RsRestItemDataSource.ps1) (REST data sources), [`ReportingServicesTools/Functions/Utilities/Connect-RsReportServer.ps1`](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Utilities/Connect-RsReportServer.ps1) (Connect server)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_connection["Connection"]
  node_connect["Connect server"]
  node_session["REST session"]
end

subgraph group_admin["Server administration"]
  node_initialize["Initialize server<br/>[Initialize-Rs.ps1]"]
  node_database["Configure database<br/>[Set-RsDatabase.ps1]"]
  node_urls["Reserve URLs"]
  node_encryption["Encryption keys"]
end

subgraph group_catalog["Catalog operations"]
  node_deploymentconfig["Deployment config"]
  node_publish["Publish project"]
  node_catalogitems["Catalog items"]
  node_datasources["Data sources"]
  node_subscriptions["Subscriptions"]
  node_exportxml["Export subscriptions"]
  node_importxml["Import subscriptions"]
end

subgraph group_rest["REST operations"]
  node_restcatalog["REST catalog<br/>[Get-RsRestItem.ps1]"]
  node_cacheplans["Cache refresh plans"]
  node_restdatasource["REST data sources"]
  node_credentials["REST credentials"]
end

subgraph group_security["Security"]
  node_soapaccess["Catalog roles"]
  node_restaccess["REST access policies"]
end

node_operator(("PowerShell operator"))
node_server(("SSRS / PBIRS"))

node_operator -->|"invokes"| node_connect
node_operator -->|"invokes"| node_session
node_operator -->|"invokes"| node_initialize
node_operator -->|"invokes"| node_database
node_operator -->|"invokes"| node_urls
node_operator -->|"invokes"| node_encryption
node_operator -->|"invokes"| node_deploymentconfig
node_operator -->|"invokes"| node_publish
node_operator -->|"invokes"| node_catalogitems
node_operator -->|"invokes"| node_datasources
node_operator -->|"invokes"| node_subscriptions
node_operator -->|"invokes"| node_exportxml
node_operator -->|"invokes"| node_importxml
node_operator -->|"invokes"| node_restcatalog
node_operator -->|"invokes"| node_cacheplans
node_operator -->|"invokes"| node_restdatasource
node_operator -->|"invokes"| node_soapaccess
node_operator -->|"invokes"| node_restaccess
node_deploymentconfig -->|"pipelines into"| node_publish
node_exportxml -->|"can supply"| node_importxml
node_credentials -->|"provides object"| node_restdatasource
node_initialize -->|"requires first"| node_database
node_initialize -->|"requires first"| node_urls
node_connect -->|"connects to"| node_server
node_session -->|"REST calls"| node_server
node_publish -->|"deploys to"| node_server
node_catalogitems -->|"operates on"| node_server
node_datasources -->|"operates on"| node_server
node_subscriptions -->|"operates on"| node_server
node_restcatalog -->|"REST requests"| node_server
node_cacheplans -->|"REST requests"| node_server
node_restdatasource -->|"REST requests"| node_server
node_soapaccess -->|"grants access"| node_server
node_restaccess -->|"REST grants"| node_server

click node_connect "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Utilities/Connect-RsReportServer.ps1"
click node_session "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Utilities/New-RsRestSession.ps1"
click node_initialize "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Initialize-Rs.ps1"
click node_database "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Set-RsDatabase.ps1"
click node_urls "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Set-RsUrlReservation.ps1"
click node_encryption "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Backup-RsEncryptionKey.ps1"
click node_deploymentconfig "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Get-RsDeploymentConfig.ps1"
click node_publish "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Publish-RsProject.ps1"
click node_catalogitems "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Write-RsCatalogItem.ps1"
click node_datasources "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/New-RsDataSource.ps1"
click node_subscriptions "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Get-RsSubscription.ps1"
click node_exportxml "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Export-RsSubscriptionXml.ps1"
click node_importxml "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Import-RsSubscriptionXml.ps1"
click node_restcatalog "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/Get-RsRestItem.ps1"
click node_cacheplans "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/New-RsRestCacheRefreshPlan.ps1"
click node_restdatasource "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/Set-RsRestItemDataSource.ps1"
click node_credentials "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/New-RsRestCredentialsByUserObject.ps1"
click node_soapaccess "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Security/Grant-RsCatalogItemRole.ps1"
click node_restaccess "https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Security/Rest/Grant-RsRestItemAccessPolicy.ps1"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_connect,node_session toneBlue
class node_initialize,node_database,node_urls,node_encryption toneAmber
class node_deploymentconfig,node_publish,node_catalogitems,node_datasources,node_subscriptions,node_exportxml,node_importxml toneMint
class node_restcatalog,node_cacheplans,node_restdatasource,node_credentials toneRose
class node_soapaccess,node_restaccess,node_operator,node_server toneIndigo
```

## Components

### Connection

- [Connect server](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Utilities/Connect-RsReportServer.ps1): `ReportingServicesTools/Functions/Utilities/Connect-RsReportServer.ps1`
- [REST session](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Utilities/New-RsRestSession.ps1): `ReportingServicesTools/Functions/Utilities/New-RsRestSession.ps1`

### Server administration

- [Initialize server](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Initialize-Rs.ps1): `ReportingServicesTools/Functions/Admin/Initialize-Rs.ps1`
- [Configure database](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Set-RsDatabase.ps1): `ReportingServicesTools/Functions/Admin/Set-RsDatabase.ps1`
- [Reserve URLs](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Set-RsUrlReservation.ps1): `ReportingServicesTools/Functions/Admin/Set-RsUrlReservation.ps1`
- [Encryption keys](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Admin/Backup-RsEncryptionKey.ps1): `ReportingServicesTools/Functions/Admin/Backup-RsEncryptionKey.ps1`

### Catalog operations

- [Deployment config](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Get-RsDeploymentConfig.ps1): `ReportingServicesTools/Functions/CatalogItems/Get-RsDeploymentConfig.ps1`
- [Publish project](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Publish-RsProject.ps1): `ReportingServicesTools/Functions/CatalogItems/Publish-RsProject.ps1`
- [Catalog items](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Write-RsCatalogItem.ps1): `ReportingServicesTools/Functions/CatalogItems/Write-RsCatalogItem.ps1`
- [Data sources](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/New-RsDataSource.ps1): `ReportingServicesTools/Functions/CatalogItems/New-RsDataSource.ps1`
- [Subscriptions](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Get-RsSubscription.ps1): `ReportingServicesTools/Functions/CatalogItems/Get-RsSubscription.ps1`
- [Export subscriptions](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Export-RsSubscriptionXml.ps1): `ReportingServicesTools/Functions/CatalogItems/Export-RsSubscriptionXml.ps1`
- [Import subscriptions](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Import-RsSubscriptionXml.ps1): `ReportingServicesTools/Functions/CatalogItems/Import-RsSubscriptionXml.ps1`

### REST operations

- [REST catalog](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/Get-RsRestItem.ps1): `ReportingServicesTools/Functions/CatalogItems/Rest/Get-RsRestItem.ps1`
- [Cache refresh plans](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/New-RsRestCacheRefreshPlan.ps1): `ReportingServicesTools/Functions/CatalogItems/Rest/New-RsRestCacheRefreshPlan.ps1`
- [REST data sources](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/Set-RsRestItemDataSource.ps1): `ReportingServicesTools/Functions/CatalogItems/Rest/Set-RsRestItemDataSource.ps1`
- [REST credentials](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/CatalogItems/Rest/New-RsRestCredentialsByUserObject.ps1): `ReportingServicesTools/Functions/CatalogItems/Rest/New-RsRestCredentialsByUserObject.ps1`

### Security

- [Catalog roles](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Security/Grant-RsCatalogItemRole.ps1): `ReportingServicesTools/Functions/Security/Grant-RsCatalogItemRole.ps1`
- [REST access policies](https://github.com/microsoft/reportingservicestools/blob/master/ReportingServicesTools/Functions/Security/Rest/Grant-RsRestItemAccessPolicy.ps1): `ReportingServicesTools/Functions/Security/Rest/Grant-RsRestItemAccessPolicy.ps1`

### Other components

- **PowerShell operator**
- **SSRS / PBIRS**

## Connections

- PowerShell operator → Connect server: invokes (evidence: `README.md`)
- PowerShell operator → REST session: invokes (evidence: `README.md`)
- PowerShell operator → Initialize server: invokes (evidence: `README.md`)
- PowerShell operator → Configure database: invokes (evidence: `README.md`)
- PowerShell operator → Reserve URLs: invokes (evidence: `README.md`)
- PowerShell operator → Encryption keys: invokes (evidence: `README.md`)
- PowerShell operator → Deployment config: invokes (evidence: `README.md`)
- PowerShell operator → Publish project: invokes (evidence: `README.md`)
- PowerShell operator → Catalog items: invokes (evidence: `README.md`)
- PowerShell operator → Data sources: invokes (evidence: `README.md`)
- PowerShell operator → Subscriptions: invokes (evidence: `README.md`)
- PowerShell operator → Export subscriptions: invokes (evidence: `README.md`)
- PowerShell operator → Import subscriptions: invokes (evidence: `README.md`)
- PowerShell operator → REST catalog: invokes (evidence: `README.md`)
- PowerShell operator → Cache refresh plans: invokes (evidence: `README.md`)
- PowerShell operator → REST data sources: invokes (evidence: `README.md`)
- PowerShell operator → Catalog roles: invokes (evidence: `README.md`)
- PowerShell operator → REST access policies: invokes (evidence: `README.md`)
- Deployment config → Publish project: pipelines into (evidence: `README.md`)
- Export subscriptions → Import subscriptions: can supply (evidence: `README.md`)
- REST credentials → REST data sources: provides object (evidence: `README.md`)
- Initialize server → Configure database: requires first (evidence: `README.md`)
- Initialize server → Reserve URLs: requires first (evidence: `README.md`)
- Connect server → SSRS / PBIRS: connects to (evidence: `README.md`)
- REST session → SSRS / PBIRS: REST calls (evidence: `README.md`)
- Publish project → SSRS / PBIRS: deploys to (evidence: `README.md`)
- Catalog items → SSRS / PBIRS: operates on (evidence: `README.md`)
- Data sources → SSRS / PBIRS: operates on (evidence: `README.md`)
- Subscriptions → SSRS / PBIRS: operates on (evidence: `README.md`)
- REST catalog → SSRS / PBIRS: REST requests (evidence: `README.md`)
- Cache refresh plans → SSRS / PBIRS: REST requests (evidence: `README.md`)
- REST data sources → SSRS / PBIRS: REST requests (evidence: `README.md`)
- Catalog roles → SSRS / PBIRS: grants access (evidence: `README.md`)
- REST access policies → SSRS / PBIRS: REST grants (evidence: `README.md`)
