Below lists the PowerShell cmdlets, group by feature set that can be used to manage Piraeus.
| Cmdlet | Definition |
|---|---|
| Get-PiraeusManagmentToken | Returns a security token used for subsequent calls to the management api using other cmdlets. |
See CAPL Intro
| Cmdlet | Definition |
|---|---|
| Add-CaplPolicy | Adds or updates a CAPL Authorization Policy to Piraeus. |
| Get-CaplPolicy | Gets a CAPL Authorization Policy from Piraeus. |
| Remove-CaplPolicy | Deletes a CAPL Authorization Policy from Piraeus. |
| New-CaplPolicy | Returns a CAPL authorization. |
| New-CaplRule | Returns a new CAPL Rule used by one of the following (Policy, LogicalAnd, or LogicalOr) |
| New-CaplOperation | Return a new CAPL Operation used by a Rule. |
| New-CaplMatch | Returns a new CAPL Match Expression used by a Rule. |
| New-CaplLogicalAnd | Returns a CAPL Logical AND connective used by one of the following (LogicalOr, LogicalAnd, or Policy). |
| New-CaplLogicalOr | Returns a CAPL Logical OR connective used by one of the following (LogicalOr, LogicalAnd, or Policy). |
| New-CaplTransform | Returns a CAPL Transform used by a Policy. |
| New-CaplLiteralClaim | Returns a CAPL Literal Claim used by a Transform. |
See π-systems
π-systems are a fundamental primitive in Piraeus. This is the point of agreement between senders and receivers for specific events or message types.
| Cmdlet | Definition |
|---|---|
| Add-PiraeusEventMetadata | Adds or updates a π-system in Piraeus. |
| Get-PiraeusEventMetadata | Gets a π-system from Piraeus. |
| Get-PiraeusSigmaAlgebra | Gets a list of π-system from Piraeus. |
| Remove-PiraeusEvent | Removes a π-system from Piraeus and any subscriptions to the π-system. |
Durable subscriptions are static routes attached to a π-system. Most of time these are used by passive agents, i.e., agents that do not initialize connections to a Piraeus gateway. For example, a Storage account or Web service. However, they can be used by active agents, which are automatically subscribed to a durable subscription by matching the active agents identity to the subscription. Neither an active or passive agent can self-unsubscribe from a durable subscription. This must be perform by an administrator using the Management API.
| Cmdlet | Definition |
|---|---|
| Add-PiraeusSubscriptionMetadata | Adds or updates a subscription to a π-system in Piraeus. Use for active receivers with durable subscriptions. |
| Get-PiraeusSubscriptionMetadata | Gets a π-system from Piraeus. |
| Remove-PiraeusSubscription | Deletes a subscription to a π-system from Piraeus. |
| Add-PiraeusBlobStorageSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure blob storage receiver. |
| Add-PiraeusCosmosDbSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure Cosmos DB receiver. |
| Add-PiraeusDataLakeSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure Data Lake receiver. |
| Add-PiraeusEventGridSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure Event Grid receiver. |
| Add-PiraeusEventHubSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure Event Hub receiver. |
| Add-PiraeusIotHubCommandSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure IoT Hub command receiver. This means the subscription will send a message to an Azure IoT Hub device. |
| Add-PiraeusIotHubDeviceSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure IoT Hub device receiver. This means the subscription acts as an Azure IoT Hub device and sends the subscription message to Azure IoT Hub. |
| Add-PiraeusIotHubDirectMethodSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure IoT Hub direct method receiver. This means the subscription will forward the message as a direct method to an Azure IoT device or Azure IoT Edge module. |
| Add-PiraeusQueueStorageSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure Storage Queue receiver. |
| Add-PiraeusServiceBusSubscription | Adds or updates a subscription to a π-system in Piraeus for an Azure Service Bus receiver. This requires use of a Servie Bus Topic, Service Bus queues are not allowed. |
| Add-PiraeusWebServiceSubscription | Adds or updates a subscription to a π-system in Piraeus sends to a Web service as an HTTP-POST. This also can be used to send to Azure Functions. |
| Add-PiraeusRedisCacheSubscription | Adds or updates a subscription to a π-system in Piraeus for a Redis cache receiver. |
| Get-PiraeusSubscriptionList | Gets a list of subscriptions from a π-system in Piraeus. |
| Get-PiraeusSubscriberSubscriptions | Gets a list of durable subscriptions for an identity. |
These cmdlets retrieve metrics from π-systems orsubscriptions, e.g. number of messages, total bytes sent/received, and errors.
| Cmdlet | Definition |
|---|---|
| Get-PiraeusEventMetrics | Gets metrics from a π-system. |
| Get-PiraeusSubscriptionMetrics | Gets metrics from a subscription. |
These cmdlets can be used (if needed) to configure the Piraeus service identity. The service identity is used only when sending to a durable subscription that requires an identity, e.g., most Web services.
| Cmdlet | Definition |
|---|---|
| Add-PiraeusServiceIdentityClaims | Add or update Piraeus service identity claims used in symmetric key based security tokens. This is seldom used as it is also configure on deployment. |
| Add-PiraeusServiceIdentityCertificate | Specifies the location of a X.509 certificate to be used as a security token if required. This is seldom used as it is also configure on deployment. |
These cmdlets are used to manage PSKs for gateways that require them. PSKs allow an active agent to connect using TLSv2, an encrypted channel, without using X.509 certificates. They are not a substitute for identity. A security token is required for identity.
| Cmdlet | Definition |
|---|---|
| Add-PiraeusPskSecret | Add or update a PSK secret. |
| Get-PiraeusPskSecret | Gets a PSK secret. |
| Get-PiraeusPskKeys | Gets PSK identities. |
| Remove-PiraeusPskSecret | Remove a PSK secret. |