Skip to content

Office 365 (Retired) Office 365 (Retired): Service Plans

Summary

This module contains actions for viewing & selecting subscription Service Plans.

Minimum Plugin Version: 5.0.0

Deprecated Plugin

This plugin will be retired in the future, please use the Azure AD plugin instead.

Actions

microsoft_graph.service_plans.

display

Display service plans in a table.

The table will have the following columns:

  • Name
  • ID
  • Applies To

Minimum Plugin Version: 5.0.0

Input

  • text: the title of the table

  • service_plans: any number of ServicePlans

Output

Nothing is outputted by this action.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
- microsoft_graph.subscriptions.get_by_part_number:
    part_number: cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46
  load:
    client: graph_secrets
  save: subscription

- microsoft_graph.service_plans.display:
    text: Subscription Service Plans
  load:
    service_plans: subscription.service_plans

microsoft_graph.service_plans.

display_tabbed

Display service plans in a table with multiple tabs.

The table will have the following columns:

  • Name
  • ID
  • Applies To

Minimum Plugin Version: 5.0.0

Input

  • text: the title of the table

  • tabs: a dictionary where each key is a tab name & each value is any number of ServicePlans

Output

Nothing is outputted by this action.

Example

Auditing a user's enabled & disabled service plans for a given licence & displaying them in a tabbed table:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
- microsoft_graph.service_plans.get_enabled_for_user:
    user_principal_name: example.user@domain.net
    part_number: cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46
  load:
    client: graph_secret
  save: enabled_plans

- microsoft_graph.service_plans.get_disabled_for_user:
    user_principal_name: example.user@domain.net
    part_number: cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46
  load:
    client: graph_secret
  save: disabled_plans

- ppa_tools.dictionaries.create:
  load:
    Enabled: enabled_plans
    Disabled: disabled_plans
  save: table_tabs

- microsoft_graph.service_plans.display_tabbed:
    text: Enabled & Disabled Service Plans
  load:
    tabs: table_tabs

microsoft_graph.service_plans.

get_disabled_for_user

Get a user's disabled service plans for a given subscription.

Minimum Plugin Version: 5.0.0

Input

  • client: a GraphClient

  • user_principal_name: the User's principal name

  • part_number: the Subscription part number

  • user_only: set to true to only get plans that apply to user objects (defaults to false)

Output

A list of ServicePlans.

Example
1
2
3
4
5
6
- microsoft_graph.service_plans.get_disabled_for_user:
    part_number: O365_BUSINESS_PREMIUM
    user_principal_name: example.user@domain.net
  load:
    client: graph_secrets
  save: disabled_service_plans

microsoft_graph.service_plans.

get_enabled_for_user

Get a user's enabled service plans for a given subscription.

Minimum Plugin Version: 5.0.0

Input

  • client: a GraphClient

  • user_principal_name: the User's principal name

  • part_number: the Subscription part number

  • user_only: set to true to only get plans that apply to user objects (defaults to false)

Output

A list of ServicePlans.

Example
1
2
3
4
5
6
- microsoft_graph.service_plans.get_enabled_for_user:
    part_number: O365_BUSINESS_PREMIUM
    user_principal_name: example.user@domain.net
  load:
    client: graph_secrets
  save: enabled_service_plans

microsoft_graph.service_plans.

select

Display service plans in a table & prompt the task operator to make a selection.

The table will have the following columns:

  • Name
  • ID
  • Applies To

Minimum Plugin Version: 5.0.0

Input

  • text: the title of the table

  • service_plans: any number of ServicePlans

  • minimum: the minimum number of selections

  • maximum: the maximum number of selections

Output

A Selection containing:

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
- microsoft_graph.subscriptions.get_by_part_number:
    part_number: cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46
  load:
    client: graph_secrets
  save: subscription

- microsoft_graph.service_plans.select:
    text: Select Service Plans
  load:
    service_plans: subscription.service_plans
  save: selection

microsoft_graph.service_plans.

select_one

Display service plans in a table & prompt the task operator to select one.

The table will have the following columns:

  • Name
  • ID
  • Applies To

Minimum Plugin Version: 5.0.0

Input

  • text: the title of the table

  • service_plans: any number of ServicePlans

Output

A single ServicePlan.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
- microsoft_graph.subscriptions.get_by_part_number:
    part_number: cbdc14ab-d96c-4c30-b9f4-6ada7cdc1d46
  load:
    client: graph_secrets
  save: subscription

- microsoft_graph.service_plans.select_one:
    text: Select Service Plan
  load:
    service_plans: subscription.service_plans
  save: service_plan