Office 365 (Microsoft Graph): Subscriptions
Summary
This module contains actions for managing subscriptions in Office 365.
Actions
microsoft_graph.subscriptions.
assign_to_user
Assign a subscription licence to a user.
Minimum Plugin Version: 5.0.0
Input
-
client: a GraphClient
-
user_principal_name: the User's principal name
-
sku_id: the subscription SKU ID
-
disabled_plans: optional list of ServicePlans to disable while assigning the subscription
Enabling & Disabling Plans
You can also use this action to update a user's plans for a given subscription.
To disable plans for a subscription the user already has:
- assign them the subscription
- use the disabled_plans input to turn off the relevant plans
To enable plans for a subscription the user already has:
- assign them the subscription
- make sure the plans you want to enable are not supplied in disabled_plans
Users can select plans using actions in the service_plans module.
Each Subscription contains its associated ServicePlans.
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 |
|
microsoft_graph.subscriptions.
display
Display subscriptions in a table.
The table will have the following columns:
- Part Number
- SKU ID
- Consumed Units
- Paid Units
Minimum Plugin Version: 1.0.0
Input
-
text: the title of the table
-
subscriptions: any number of Subscriptions
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 6 7 8 9 |
|
microsoft_graph.subscriptions.
display_for_users
Generate & display a table of Subscriptions & the Users assigned to each.
Minimum Plugin Version: 1.0.0
Input
-
client: a GraphClient
-
users: a list of Users to get subscriptions for
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 6 7 8 9 |
|
microsoft_graph.subscriptions.
get_all
Get all company subscriptions.
Minimum Plugin Version: 1.0.0
Input
- client: a GraphClient
Output
A list of Subscriptions.
Example
1 2 3 4 |
|
microsoft_graph.subscriptions.
get_by_part_number
Get the company subscription with the supplied part number.
Minimum Plugin Version: 1.1.0
Input
-
client: a GraphClient
-
part_number: the subscription part number
Part Numbers
Subscription part numbers can be found here in the String ID column.
Output
A Subscription.
Example
1 2 3 4 5 |
|
microsoft_graph.subscriptions.
get_for_user
Get all subscriptions assigned to a user.
Minimum Plugin Version: 1.0.0
Input
-
client: a GraphClient
-
user_principal_name: the User's principal name
Output
A list of Subscriptions.
Example
1 2 3 4 5 |
|
microsoft_graph.subscriptions.
remove_from_user
Remove a subscription licence from a user.
Minimum Plugin Version: 1.0.0
Input
-
client: a GraphClient
-
user_principal_name: the User's principal name
-
sku_id: the subscription SKU ID
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 |
|
microsoft_graph.subscriptions.
select
Display subscriptions in a table & prompt the task operator to make a selection.
The table will have the following columns:
- Part Number
- SKU ID
- Consumed Units
- Paid Units
Minimum Plugin Version: 1.0.0
Input
-
text: the title of the table
-
subscriptions: any number of Subscriptions
-
minimum: the minimum number of selections
-
maximum: the maximum number of selections
Output
A Selection containing:
-
total: the number of selected Subscriptions
-
all: a list of selected Subscriptions
-
first: the first selected Subscriptions
Example
1 2 3 4 5 6 7 8 9 10 |
|
microsoft_graph.subscriptions.
select_one
Display subscriptions in a table & prompt the task operator to select one.
The table will have the following columns:
- Part Number
- SKU ID
- Consumed Units
- Paid Units
Minimum Plugin Version: 1.0.0
Input
-
text: the title of the table
-
subscriptions: any number of Subscriptions
Output
A single Subscription.
Example
1 2 3 4 5 6 7 8 9 10 |
|