Skip to content

Commit 9979a2a

Browse files
Docs improvement for 0.15.0 preview release batch two (#1040)
1 parent 9ff885e commit 9979a2a

28 files changed

+472
-288
lines changed

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaApplicationServiceEndpoint.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ Get-EntraBetaApplicationServiceEndpoint
3434
## Description
3535

3636
The `Get-EntraBetaApplicationServiceEndpoint` cmdlet retrieves the service endpoint(s) of an application.
37-
The service endpoint entity contains service discovery information.
38-
The serviceEndpoints property of the Application entity is of type ServiceEndpoint.
37+
38+
The service endpoint entity contains service discovery information. The serviceEndpoints property of the Application entity is of type ServiceEndpoint.
39+
3940
Other services can use the information stored in the ServiceEndpoint entity to find this service and its addressable endpoints.
4041

4142
## Examples
@@ -44,30 +45,36 @@ Other services can use the information stored in the ServiceEndpoint entity to f
4445

4546
```powershell
4647
Connect-Entra -Scopes 'Application.Read.All'
47-
Get-EntraBetaApplicationServiceEndpoint -ObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
48+
$application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
49+
Get-EntraBetaApplicationServiceEndpoint -ObjectId $application.ObjectId
4850
```
4951

5052
This example demonstrates how to retrieve service endpoint of the application that is specified through the Object ID parameter.
53+
5154
`-ObjectId` parameter specifies the ID of an application object in Microsoft Entra ID.
5255

5356
### Example 2: Get all service endpoints
5457

5558
```powershell
5659
Connect-Entra -Scopes 'Application.Read.All'
57-
Get-EntraBetaApplicationServiceEndpoint -ObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -All
60+
$application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
61+
Get-EntraBetaApplicationServiceEndpoint -ObjectId $application.ObjectId -All
5862
```
5963

6064
This example demonstrates how to retrieve all service endpoints of a specified application.
65+
6166
`-ObjectId` parameter specifies the ID of an application object in Microsoft Entra ID.
6267

6368
### Example 3: Get top five service endpoints
6469

6570
```powershell
6671
Connect-Entra -Scopes 'Application.Read.All'
67-
Get-EntraBetaApplicationServiceEndpoint -ObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Top 5
72+
$application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'"
73+
Get-EntraBetaApplicationServiceEndpoint -ObjectId $application.ObjectId -Top 5
6874
```
6975

7076
This example demonstrates how to retrieve five service endpoints of a specified application.
77+
7178
`-ObjectId` parameter specifies the ID of an application object in Microsoft Entra ID.
7279

7380
## Parameters
@@ -154,3 +161,5 @@ System.Nullable\`1\[\[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral
154161
## Notes
155162

156163
## Related Links
164+
165+
[Get-EntraBetaApplication](Get-EntraBetaApplication.md)

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaApplicationTemplate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The `Get-EntraBetaApplicationTemplate` cmdlet allows users to get a list of all
4848

4949
## Examples
5050

51-
### 1. Gets a list of application template objects
51+
### Example 1. Gets a list of application template objects
5252

5353
```powershell
5454
Connect-Entra -Scopes 'Application.Read.All'
@@ -57,7 +57,7 @@ Get-EntraBetaApplicationTemplate
5757

5858
This command gets all the application template objects
5959

60-
### 2. Gets an application template object
60+
### Example 2. Gets an application template object
6161

6262
```powershell
6363
Connect-Entra -Scopes 'Application.Read.All'

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaAttributeSet.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,16 @@ Get-EntraBetaAttributeSet
4242

4343
## Description
4444

45-
Gets a list of Microsoft Entra ID attribute sets. Specify `Id` parameter to retrieve an attribute set.
45+
The `Get-EntraABetaAttributeSet` cmdlet gets a list of Microsoft Entra ID attribute sets.
46+
47+
In delegated scenarios with work or school accounts, the signed-in user must have a supported Microsoft Entra role or a custom role with the necessary permissions. The supported roles for this operation are:
48+
49+
- Attribute Assignment Reader
50+
- Attribute Definition Reader
51+
- Attribute Assignment Administrator
52+
- Attribute Definition Administrator
53+
54+
By default, other administrator roles cannot read, define, or assign custom security attributes.
4655

4756
## Examples
4857

@@ -83,7 +92,9 @@ This example demonstrates how to retrieve an attribute set by Id.
8392

8493
### -Id
8594

86-
Unique identifier for the attribute set within a tenant. This identifier can be up to 32 characters long and may include Unicode characters. It cannot contain spaces or special characters, and it cannot be changed later. The identifier is case insensitive.
95+
Unique identifier for the attribute set within a tenant.
96+
97+
This identifier can be up to 32 characters long and may include Unicode characters. It cannot contain spaces or special characters, and it cannot be changed later. The identifier is case insensitive.
8798

8899
```yaml
89100
Type: System.String

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaAuditDirectoryLogs.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Get-EntraBetaAuditDirectoryLogs
3737
## Description
3838

3939
The `Get-EntraBetaAuditDirectoryLogs` cmdlet gets a Microsoft Entra ID audit log.
40+
4041
Retrieve audit logs from Microsoft Entra ID, covering logs from various services such as user, app, device, and group management, privileged identity management (PIM), access reviews, terms of use, identity protection, password management (SSPR and admin resets), and self-service group management.
4142

4243
## Examples
@@ -81,7 +82,6 @@ This example returns the first N logs.
8182

8283
```powershell
8384
Connect-Entra -Scopes 'AuditLog.Read.All, Directory.Read.All'
84-
Get-EntraBetaAuditDirectoryLogs -Filter "ActivityDisplayName eq 'Update rollout policy of feature'"
8585
Get-EntraBetaAuditDirectoryLogs -Filter "ActivityDisplayName eq 'Update rollout policy of feature'" -Top 1
8686
```
8787

@@ -97,7 +97,6 @@ This command shows how to get audit logs by ActivityDisplayName.
9797

9898
```powershell
9999
Connect-Entra -Scopes 'AuditLog.Read.All, Directory.Read.All'
100-
Get-EntraBetaAuditDirectoryLogs -Filter "result eq 'success'"
101100
Get-EntraBetaAuditDirectoryLogs -Filter "result eq 'failure'" -All
102101
```
103102

@@ -110,7 +109,7 @@ This command shows how to get audit logs by the result.
110109
List all pages.
111110

112111
```yaml
113-
Type: System.Management.Automation.SwitchParameter
112+
Type: System.Management.Automation.SwitchParameter
114113
Parameter Sets: (All)
115114
Aliases:
116115

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaAuditSignInLogs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ This example returns the first two audit logs of sign-ins.
8585

8686
```powershell
8787
Connect-Entra -Scopes 'AuditLog.Read.All','Directory.Read.All'
88-
Get-EntraBetaAuditSignInLogs -Filter "AppDisplayName eq 'Graph Explorer'"
8988
Get-EntraBetaAuditSignInLogs -Filter "AppDisplayName eq 'Graph Explorer'" -Top 1
9089
```
9190

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaAuthorizationPolicy.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,14 @@ The `Get-EntraBetaAuthorizationPolicy` cmdlet gets a Microsoft Entra ID authoriz
4646

4747
## Examples
4848

49-
### Example 1: Get an authorization policy by ID
49+
### Example 1: Get all policies
50+
51+
```powershell
52+
Connect-Entra -Scopes 'Policy.Read.All'
53+
Get-EntraBetaAuthorizationPolicy
54+
```
55+
56+
### Example 2: Get an authorization policy by ID
5057

5158
```powershell
5259
Connect-Entra -Scopes 'Policy.Read.All'

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaContact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The `Get-EntraBetaContact` cmdlet gets a contact from Microsoft Entra ID.
5050

5151
## Examples
5252

53-
### Example 1 Retrieve all contact objects in the directory
53+
### Example 1: Retrieve all contact objects in the directory
5454

5555
```powershell
5656
Connect-Entra -Scopes 'OrgContact.Read.All'

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaContactDirectReport.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,17 @@ $Contact = Get-EntraBetaContact -Top 1
4747
Get-EntraBetaContactDirectReport -ObjectId $Contact.ObjectId
4848
```
4949

50-
This example shows how to retrieve direct reports for an organizational contact. You can use the command `Get-EntraBetaContact` to get organizational contact.
50+
This example shows how to retrieve direct reports for an organizational contact.
51+
You can use the command `Get-EntraBetaContact` to get organizational contact.
5152

5253
- `-ObjectId` parameter specifies the contact Id.
5354

5455
### Example 2: Get all direct reports of a contact
5556

5657
```powershell
5758
Connect-Entra -Scopes 'OrgContact.Read.All'
58-
Get-EntraBetaContactDirectReport -ObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -All
59+
$Contact = Get-EntraBetaContact -Top 1
60+
Get-EntraBetaContactDirectReport -ObjectId $Contact.ObjectId -All
5961
```
6062

6163
This example shows how to retrieve all direct reports for an organizational contact.
@@ -66,7 +68,8 @@ This example shows how to retrieve all direct reports for an organizational cont
6668

6769
```powershell
6870
Connect-Entra -Scopes 'OrgContact.Read.All'
69-
Get-EntraBetaContactDirectReport -ObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Top 2
71+
$Contact = Get-EntraBetaContact -Top 1
72+
Get-EntraBetaContactDirectReport -ObjectId $Contact.ObjectId -Top 2
7073
```
7174

7275
This example shows how to retrieve top two direct reports for an organizational contact.

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaDeletedApplication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,4 +236,4 @@ System.Nullable\`1\[\[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral
236236

237237
## Related Links
238238

239-
[Get-EntraBetaApplication](Get-EntraBetaApplication.md)
239+
[Get-EntraBetaApplication](Get-EntraBetaApplication.md)

module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaDeletedDirectoryObject.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Get-EntraBetaDeletedDirectoryObject
3434
## Description
3535

3636
The `Get-EntraBetaDeletedDirectoryObject` cmdlet retrieves a soft deleted directory object from the directory.
37+
3738
Note that soft delete for groups is currently only implemented for Unified Groups (also known as
3839
Office 365 Groups).
3940

0 commit comments

Comments
 (0)