Skip to content

Commit 3f10cde

Browse files
committed
Create Set-SPOCopilotPromoOptInStatus.md
1 parent 7b40ec7 commit 3f10cde

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOCopilotPromoOptInStatus
5+
applicable: SharePoint Online
6+
title: Set-SPOCopilotPromoOptInStatus.md
7+
schema:
8+
author: swathi.iruvanti
9+
ms.author: siruvanti
10+
ms.reviewer:
11+
---
12+
# Set-SPOCopilotPromoOptInStatus
13+
14+
## SYNOPSIS
15+
16+
Retrieves the IsCopilotPromoStatusEnabled ( "true/false" ) state of the Copilot promo opt-in bit and stores the information.
17+
18+
## SYNTAX
19+
```powershell
20+
Set-SPOCopilotPromoOptInStatus
21+
```
22+
23+
### Parameters:
24+
25+
The following details are returned:
26+
27+
- Copilot promo status set successfully, returns nothing if successful.
28+
29+
- Copilot promo status set failed, returns an error.
30+
31+
## DESCRIPTION
32+
33+
The `Set-SPOCopilotPromoOptInStatus` cmdlet stores the opt-in state. The user must be a SharePoint Admin to run the cmlets.
34+
35+
36+
## EXAMPLES
37+
38+
### Example 1
39+
40+
```powershell
41+
Set-SPOCopilotPromoOptInStatusSetSuccessfully -SPOCopilotPromoOptInStatusEnabled true
42+
```
43+
44+
Example 1: No success message returned, can validate by executing Get-SPOCopilotPromoOptInStatus.
45+
If commandlet fails to execute for Set-CopilotPromoOptInStatus, an error message is shown to user.
46+
47+
### Example 2
48+
49+
```powershell
50+
Set-SPOCopilotPromoOptInStatusSetSuccessfully -SPOCopilotPromoOptInStatusDisabled false
51+
```
52+
53+
Example 2: Success message shown to user when commandlet executes successfully for Set-CopilotPromoOptInStatus
54+
If commandlet fails to execute for Set-CopilotPromoOptInStatus, an error message is shown to user.
55+
56+
57+
## RELATED LINKS
58+
59+
Get-SPOCopilotPromoOptInStatus

0 commit comments

Comments
 (0)