Skip to content

Commit

Permalink
Minor documentation fixes (#3849)
Browse files Browse the repository at this point in the history
* Update Set-PnPTemporarilyDisableAppBar.md

* Update Set-PnPTeamsTeamPicture.md

* Update Set-PnPTeamsTeamArchivedState.md

* Update Set-PnPTeamsTag.md

---------

Co-authored-by: Gautam Sheth <gautamdsheth@outlook.com>
  • Loading branch information
PowershellScripts and gautamdsheth authored Mar 25, 2024
1 parent cd8ccd3 commit cc55821
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 10 deletions.
10 changes: 6 additions & 4 deletions documentation/Set-PnPTeamsTag.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPTeamsTag.html

* Microsoft Graph API: TeamworkTag.ReadWrite, Group.Read.All

Sets the Microsoft Teams Tag in a Team.
Sets the Microsoft Teams tag in a Team.

## SYNTAX

Expand All @@ -25,18 +25,20 @@ Set-PnPTeamsTag -Team <TeamsTeamPipeBind> -Identity <TeamsTagPipeBind> -DisplayN

## DESCRIPTION

Allows to set a Teams tag in Microsoft Teams.

## EXAMPLES

### EXAMPLE 1
```powershell
Set-PnPTeamsTag -Team 5beb63c5-0571-499e-94d5-3279fdd9b6b5 -Identity "ZmY1ZjdmMjctZDhiNy00MWRkLTk2ZDQtYzcyYmVhMWIwOGYxIyM3ZTVhNGRmZS1kNWNlLTRkOTAtODM4MC04ZDIxM2FkYzYzOGIjI3RiVlVpR01rcg==" -DisplayName "Updated Tag"
```
Sets the Tag with the specified Id from the Teams team.
Sets the tag with the specified Id from the Teams team.

## PARAMETERS

### -DisplayName
The updated display name of the Teams tag
The updated display name of the Teams tag.

```yaml
Type: String
Expand All @@ -50,7 +52,7 @@ Accept wildcard characters: False
```
### -Identity
Specify the id of the Tag
Specify the id of the Tag.
```yaml
Type: TeamsTagPipeBind
Expand Down
18 changes: 16 additions & 2 deletions documentation/Set-PnPTeamsTeamArchivedState.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Sets the archived state of a team.

```powershell
Set-PnPTeamsTeamArchivedState -Identity <TeamsTeamPipeBind> -Archived <Boolean>
[-SetSiteReadOnlyForMembers <Boolean>]
[-SetSiteReadOnlyForMembers <Boolean>] [-Connection <PnPConnection>]
```

## DESCRIPTION
Expand Down Expand Up @@ -49,7 +49,7 @@ Un-archives the team as identified.
Set-PnPTeamsTeamArchivedState -Identity "My Team" -Archived $true -SetSiteReadOnlyForMembers $true
```

Archives the team as identified and sets the underlying SharePoint Online Site Collection as read only for members
Archives the team as identified and sets the underlying SharePoint Online Site Collection as read only for members.

## PARAMETERS

Expand All @@ -67,6 +67,20 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
```yaml
Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Identity
Specify the group id, mailNickname or display name of the team to use.
Expand Down
18 changes: 16 additions & 2 deletions documentation/Set-PnPTeamsTeamPicture.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Sets the picture of an existing team.
## SYNTAX

```powershell
Set-PnPTeamsTeamPicture -Team <TeamsTeamPipeBind> -Path <String>
Set-PnPTeamsTeamPicture -Team <TeamsTeamPipeBind> -Path <String> [-Connection <PnPConnection>]
```

## DESCRIPTION
Expand All @@ -36,6 +36,20 @@ Updates a picture for the team called 'MyTeam' with the available at "c:\myimage

## PARAMETERS

### -Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

```yaml
Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Path
The path to the image file.
Expand Down Expand Up @@ -66,4 +80,4 @@ Accept wildcard characters: False
## RELATED LINKS
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
18 changes: 16 additions & 2 deletions documentation/Set-PnPTemporarilyDisableAppBar.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Allows the SharePoint Online App Bar to be disabled. It may take some time for t
## SYNTAX

```powershell
Set-PnPTemporarilyDisableAppBar -Enabled <Boolean>
Set-PnPTemporarilyDisableAppBar -Enabled <Boolean> [-Connection <PnPConnection>]
```

## DESCRIPTION
Expand All @@ -45,7 +45,21 @@ Shows the SharePoint Online App Bar.

## PARAMETERS

### -Enable
### -Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

```yaml
Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Enabled
Specifies whether to show or hide SharePoint Online App Bar.
```yaml
Expand Down

0 comments on commit cc55821

Please sign in to comment.