Skip to content
Draft
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, Calendars.ReadWrite.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": "id-value",
"name": "name-value",
"changeKey": "changeKey-value",
"classId": "classId-value"
Comment on lines +85 to +88
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please improve the response? It would be better use some "real" values instead of the id-value, etc.
Check the response for the similar command outlook calendargroup list

}
```

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

```text
id | name
------------------------------------------------------------------ ----------------
id-value name-value
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please improve the response? It would be better use some "real" values instead of the id-value, etc.
Check the response for the similar command outlook calendargroup list

```

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

```csv
id,name
id-value,name-value
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please improve the response? It would be better use some "real" values instead of the id-value, etc.
Check the response for the similar command outlook calendargroup list

```

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

```md
# outlook calendargroup get

Date: 3/20/2026

Property | Value
---------|-------
id | id-value
name | name-value
Comment on lines +119 to +120
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please improve the response? It would be better use some "real" values instead of the id-value, etc.
Check the response for the similar command outlook calendargroup list

```

</TabItem>
</Tabs>

5 changes: 5 additions & 0 deletions docs/src/config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1308,6 +1308,11 @@ const sidebars: SidebarsConfig = {
type: 'doc',
label: 'calendargroup list',
id: 'cmd/outlook/calendargroup/calendargroup-list'
},
{
type: 'doc',
label: 'calendargroup get',
id: 'cmd/outlook/calendargroup/calendargroup-get'
}
]
},
Expand Down
1 change: 1 addition & 0 deletions src/m365/outlook/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ const prefix: string = 'outlook';

export default {
CALENDARGROUP_LIST: `${prefix} calendargroup list`,
CALENDARGROUP_GET: `${prefix} calendargroup get`,
MAIL_SEARCHFOLDER_ADD: `${prefix} mail searchfolder add`,
MAIL_SEND: `${prefix} mail send`,
MAILBOX_SETTINGS_GET: `${prefix} mailbox settings get`,
Expand Down
Loading