Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions docs/docs/cmd/outlook/calendargroup/calendargroup-get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
import Global from '../../_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# outlook calendargroup get

Retrieves a calendar group for a user.

## Usage

```sh
m365 outlook calendargroup get [options]
```

## Options

```md definition-list
`--id [id]`
: ID of the calendar group. Specify either `id` or `name`, but not both.

`--name [name]`
: Name of the calendar group. Specify either `id` or `name`, but not both.

`--userId [userId]`
: ID of the user. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.

`--userName [userName]`
: UPN of the user. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
```

<Global />

## Permissions

<Tabs>
<TabItem value="Delegated">

| Resource | Permissions |
|-----------------|------------------------------------------------------------|
| Microsoft Graph | Calendars.ReadBasic, Calendars.Read, Calendars.Read.Shared |

</TabItem>
<TabItem value="Application">

| Resource | Permissions |
|-----------------|-------------------------------------|
| Microsoft Graph | Calendars.ReadBasic, Calendars.Read |

</TabItem>
</Tabs>

:::note

When using delegated permissions, specifying `userId` or `userName` for a different user requires the `Calendars.Read.Shared` or `Calendars.ReadWrite.Shared` scope. When the specified user matches the signed-in user, no shared scope is needed.

:::

## Examples

Get the calendar group specified by name for the signed-in user.

```sh
m365 outlook calendargroup get --name "Personal Events"
```

Get the calendar group specified by name for a user using application permissions.

```sh
m365 outlook calendargroup get --name "Personal Events" --userId "44288f7d-7710-4293-8c8e-36f310ed2e6a"
```

Get the calendar group specified by id for a user using application permissions.

```sh
m365 outlook calendargroup get --id "AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAAABuC34AAA=" --userId "44288f7d-7710-4293-8c8e-36f310ed2e6a"
```

## Response

<Tabs>
<TabItem value="JSON">

```json
{
"id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmYyY2I5NTM3ZAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAbfYq5lmBxQ6a4t1fGbeYAAAAAAEOAAA=",
"name": "My Calendars",
"changeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w==",
"classId": "0006f0b7-0000-0000-c000-000000000046"
}
```

</TabItem>
<TabItem value="Text">

```text
id name
----------------------------------------------------------------------------------------------------------------------- ----------------
AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmYyY2I5NTM3ZAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAbfYq5lmBxQ6a4t1fGbeYAAAAAAEOAAA= My Calendars
```

</TabItem>
<TabItem value="CSV">

```csv
id,name
AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmYyY2I5NTM3ZAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAbfYq5lmBxQ6a4t1fGbeYAAAAAAEOAAA=,My Calendars
```

</TabItem>
<TabItem value="Markdown">

```md
# outlook calendargroup get

Date: 3/20/2026

Property | Value
---------|-------
id | AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmYyY2I5NTM3ZAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAbfYq5lmBxQ6a4t1fGbeYAAAAAAEOAAA=
name | My Calendars
```

</TabItem>
</Tabs>

1 change: 1 addition & 0 deletions src/m365/outlook/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export default {
CALENDAR_ADD: `${prefix} calendar add`,
CALENDAR_GET: `${prefix} calendar get`,
CALENDAR_REMOVE: `${prefix} calendar remove`,
CALENDARGROUP_GET: `${prefix} calendargroup get`,
CALENDARGROUP_LIST: `${prefix} calendargroup list`,
CALENDARGROUP_SET: `${prefix} calendargroup set`,
EVENT_CANCEL: `${prefix} event cancel`,
Expand Down
Loading