Subscription
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| Id | String | Subscription ID. | [required] |
| Name | String | Subscription name. | [required] |
| Description | String | Subscription description. | [optional] |
| TriggerId | String | ID of trigger subscribed to. | [required] |
| TriggerName | String | Trigger name of trigger subscribed to. | [required] |
| Type | SubscriptionType | [required] | |
| ResponseDeadline | String | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] |
| HttpConfig | HttpConfig | [optional] | |
| EventBridgeConfig | EventBridgeConfig | [optional] | |
| Enabled | Boolean | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [required][default to $true] |
| VarFilter | String | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] |
Examples
- Prepare the resource
$Subscription = Initialize-V2024Subscription -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-Name Access request subscription `
-Description Access requested to site xyz `
-TriggerId idn:access-request-post-approval `
-TriggerName Access Requested `
-Type null `
-ResponseDeadline PT1H `
-HttpConfig null `
-EventBridgeConfig null `
-Enabled true `
-VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")]
- Convert the resource to JSON
$Subscription | ConvertTo-JSON