Skip to content

Commit

Permalink
updated entra doc with switch parameter (#800)
Browse files Browse the repository at this point in the history
  • Loading branch information
snehalkotwal authored Jun 6, 2024
1 parent a05eefe commit f57aadd
Show file tree
Hide file tree
Showing 36 changed files with 66 additions and 96 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The second command gets the direct reports for $Contact.
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This command gets top two memberships for specified contact.
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -98,7 +98,6 @@ Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -ObjectId
Specifies the ID of a contact in Microsoft Entra ID.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ This command gets all contracts in the Microsoft Entra ID.
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -89,7 +89,6 @@ Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -Filter
Specifies an oData v3.0 filter statement.
This parameter controls which objects are returned.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ This cmdlet retrieves deleted applications having specified display name.
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ This command gets all devices that match the value of SearchString against the f
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ This command retrieves top one registered owner of a device.
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -109,7 +109,6 @@ Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -ObjectId
Specifies the ID of an object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ This command gets two registered users of the specified device.
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -116,7 +116,6 @@ Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -ObjectId
Specifies an object ID of a device.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Gets a group.
```powershell
Get-EntraGroup
[-Top <Int32>]
[-All <Boolean>]
[-All]
[-Filter <String>]
[<CommonParameters>]
```
Expand All @@ -38,7 +38,7 @@ Get-EntraGroup
```powershell
Get-EntraGroup
[-SearchString <String>]
[-All <Boolean>]
[-All]
[<CommonParameters>]
```

Expand All @@ -47,7 +47,7 @@ Get-EntraGroup
```powershell
Get-EntraGroup
-ObjectId <String>
[-All <Boolean>]
[-All]
[<CommonParameters>]
```

Expand Down Expand Up @@ -145,22 +145,19 @@ This example demonstrates how to retrieve groups that include the text new in th
## PARAMETERS

### -All

If true, return all groups.
If false, return the number of objects specified by the Top parameter.
List all pages.

```yaml
Type: System.Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -Filter
Specifies an oData v3.0 filter statement.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Gets a group application role assignment.
```powershell
Get-EntraGroupAppRoleAssignment
-ObjectId <String>
[-All <Boolean>]
[-All]
[-Top <Int32>]
[<CommonParameters>]
```
Expand Down Expand Up @@ -94,19 +94,17 @@ This command gets top two application role assignments of the specified group.
## PARAMETERS

### -All

If true, return all application role assignments.
If false, return the number of objects specified by the Top parameter.
List all pages.

```yaml
Type: System.Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Gets a member of a group.
```powershell
Get-EntraGroupMember
-ObjectId <String>
[-All <Boolean>]
[-All]
[-Top <Int32>]
[<CommonParameters>]
```
Expand Down Expand Up @@ -115,19 +115,17 @@ This command is used to retrieve all members of a specific group. The `-ObjectId
## PARAMETERS

### -All

If true, return all group members.
If false, return the number of objects specified by the Top parameter.
List all pages.

```yaml
Type: System.Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Gets an owner of a group.
```powershell
Get-EntraGroupOwner
-ObjectId <String>
[-All <Boolean>]
[-All]
[-Top <Int32>]
[<CommonParameters>]
```
Expand Down Expand Up @@ -116,22 +116,19 @@ This example demonstrates how to retrieve the top two owners of a specific group
## PARAMETERS

### -All

If true, return all group owners.
If false, return the number of objects specified by the Top parameter.
List all pages.

```yaml
Type: System.Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -ObjectId
Specifies the ID of a group in Microsoft Entra ID.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ This example returns the specified top administrative units.
List all pages.

```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Accept wildcard characters: False
List all pages.
```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ Accept wildcard characters: False
List all pages.
```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Accept wildcard characters: False
List all pages.
```yaml
Type: Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -110,7 +110,6 @@ Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -Top
Specifies the maximum number of records to return.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This cmdlet is used to retrieve the soft deleted groups in a directory.
```powershell
Get-EntraMSDeletedGroup
[-Top <Int32>]
[-All <Boolean>]
[-All]
[-Filter <String>]
[<CommonParameters>]
```
Expand All @@ -38,7 +38,7 @@ Get-EntraMSDeletedGroup
```powershell
Get-EntraMSDeletedGroup
[-SearchString <String>]
[-All <Boolean>]
[-All]
[<CommonParameters>]
```

Expand All @@ -47,7 +47,7 @@ Get-EntraMSDeletedGroup
```powershell
Get-EntraMSDeletedGroup
-Id <String>
[-All <Boolean>]
[-All]
[<CommonParameters>]
```

Expand Down Expand Up @@ -164,19 +164,17 @@ This cmdlet retrieves the deleted group specified by Id.
## PARAMETERS

### -All

If true, return all group members.
If false, return the number of objects specified by the Top parameter.
List all pages.

```yaml
Type: System.Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Gets information about groups in Microsoft Entra ID.
```powershell
Get-EntraMSGroup
[-Top <Int32>]
[-All <Boolean>]
[-All]
[-Filter <String>]
[<CommonParameters>]
```
Expand All @@ -38,7 +38,7 @@ Get-EntraMSGroup
```powershell
Get-EntraMSGroup
[-SearchString <String>]
[-All <Boolean>]
[-All]
[<CommonParameters>]
```

Expand All @@ -47,7 +47,7 @@ Get-EntraMSGroup
```powershell
Get-EntraMSGroup
-Id <String>
[-All <Boolean>]
[-All]
[<CommonParameters>]
```

Expand Down Expand Up @@ -147,19 +147,17 @@ This example demonstrates how to retrieve groups using SearchString against the
## PARAMETERS

### -All

If true, return all groups.
If false, return the number of objects specified by the Top parameter.
List all pages.

```yaml
Type: System.Boolean
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Loading

0 comments on commit f57aadd

Please sign in to comment.