Microsoft Azure Microsoft Azure: AD - Groups

Summary

This module contains actions for viewing and managing Azure AD Groups.

Actions

azure.ad.groups.

get_all

Get all AD groups.

Minimum Plugin Version: 1.0.0

Input
Output

A list of ADGroup dictionaries.

Example
1
2
3
4
- azure.ad.groups.get_all:
  load:
    azure_client: azure_secrets
  save: all_groups

azure.ad.groups.

get_by_name

Get an AD group by name

Minimum Plugin Version: 1.0.0

Input
  • azure_client: an AzureClient dictionary

  • name: Group name

Output

A single ADGroup dictionary.

Example
1
2
3
4
5
- azure.ad.groups.get_by_name:
    name: ppa
  load:
    azure_client: azure_secrets
  save: ppa_group

azure.ad.groups.

get_users

Get users from an Azure AD group's membership list.

Minimum Plugin Version: 1.0.0

Input
  • azure_client: an AzureClient dictionary

  • group_id: the ID of the group

Output

A list of ADUser dictionaries.

Example

Getting all users in a group & saving them as a new variable called user_list.

1
2
3
4
5
- azure.ad.groups.get_users:
  load:
    group_id: selected_group_id
    azure_client: azure_secrets
  save: user_list

azure.ad.groups.

output_table

Display a list of groups in a table. The table will have the following columns:

The table will have the following columns:

  • Display Name
  • Object ID

Minimum Plugin Version: 1.0.0

Input
  • text: the title of the table

  • group_list: a list of ADGroup dictionaries to display in the table

Output

Nothing is outputted by this action.

Example
  • Show a list of groups in a table
1
2
3
4
- azure.ad.groups.output_table:
    text: All groups for user: Jon Smith
  load:
    group_list: user_groups