Skip to content

Commit bc9232e

Browse files
committed
Corrected titles
1 parent 7bdf646 commit bc9232e

File tree

3,732 files changed

+25413
-14293
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,732 files changed

+25413
-14293
lines changed

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Add-MgApplicationKey.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ Applications that don't have any existing valid certificates (no certificates ha
5555
You can use the Update application operation to perform an update instead.
5656

5757
## EXAMPLES
58-
59-
### EXAMPLE 1
58+
### Example 1: Using the Add-MgApplicationKey Cmdlet
6059
```powershell
6160
Import-Module Microsoft.Graph.Applications
6261
$params = @{
@@ -70,8 +69,9 @@ $params = @{
7069
}
7170
Add-MgApplicationKey -ApplicationId $applicationId -BodyParameter $params
7271
```
73-
74-
### EXAMPLE 2
72+
This example shows how to use the Add-MgApplicationKey Cmdlet.
73+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
74+
### Example 2: Using the Add-MgApplicationKey Cmdlet
7575
```powershell
7676
Import-Module Microsoft.Graph.Applications
7777
$params = @{
@@ -87,6 +87,8 @@ $params = @{
8787
}
8888
Add-MgApplicationKey -ApplicationId $applicationId -BodyParameter $params
8989
```
90+
This example shows how to use the Add-MgApplicationKey Cmdlet.
91+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
9092

9193
## PARAMETERS
9294

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Add-MgApplicationPassword.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ Add-MgApplicationPassword -InputObject <IApplicationsIdentity>
4545
Adds a strong password or secret to an application.
4646

4747
## EXAMPLES
48+
### Example 1: Add a password credential to an application with a six month expiry
4849

49-
### EXAMPLE 1
5050
```powershell
51+
5152
Connect-MgGraph -Scopes 'Application.ReadWrite.All'
52-
```
5353
5454
$appObjectId = 'eaf1e531-0d58-4874-babe-b9a9f436e6c3'
5555
@@ -70,11 +70,15 @@ SecretText : Q_e8Q~ZDWJD.bkgajbREp-VFFUayCuEk8b1hDcr9
7070
StartDateTime : 26/5/2022 1:03:31 pm
7171
AdditionalProperties : {[@odata.context,
7272
https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.passwordCredential]}
73+
```
74+
75+
Add a password to an application that expires in six months from the current date.
76+
77+
### Example 2: Add a password credential to an application with a start date
7378

74-
### EXAMPLE 2
7579
```powershell
80+
7681
Connect-MgGraph -Scopes 'Application.ReadWrite.All'
77-
```
7882
7983
$appObjectId = 'eaf1e531-0d58-4874-babe-b9a9f436e6c3'
8084
@@ -99,6 +103,11 @@ SecretText : TiA8Q~Zs7ej1cGtlW0qnmuFi~JlxXTZew_tU1bGA
99103
StartDateTime : 26/5/2022 2:00:00 pm
100104
AdditionalProperties : {[@odata.context,
101105
https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.passwordCredential]}
106+
```
107+
108+
Add a password to an application that becomes valid at 12:00 am the next day and is valid for six months.
109+
110+
Use `$secret.StartDateTime.ToLocalTime()` to convert the returned dates from UTC to the local timezone.
102111

103112
## PARAMETERS
104113

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Add-MgServicePrincipalKey.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ ServicePrincipals that don't have any existing valid certificates (i.e.: no cert
5252
Update servicePrincipal can be used to perform an update instead.
5353

5454
## EXAMPLES
55-
56-
### EXAMPLE 1
55+
### Example 1: Using the Add-MgServicePrincipalKey Cmdlet
5756
```powershell
5857
Import-Module Microsoft.Graph.Applications
5958
$params = @{
@@ -67,8 +66,9 @@ $params = @{
6766
}
6867
Add-MgServicePrincipalKey -ServicePrincipalId $servicePrincipalId -BodyParameter $params
6968
```
70-
71-
### EXAMPLE 2
69+
This example shows how to use the Add-MgServicePrincipalKey Cmdlet.
70+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
71+
### Example 2: Using the Add-MgServicePrincipalKey Cmdlet
7272
```powershell
7373
Import-Module Microsoft.Graph.Applications
7474
$params = @{
@@ -84,6 +84,8 @@ $params = @{
8484
}
8585
Add-MgServicePrincipalKey -ServicePrincipalId $servicePrincipalId -BodyParameter $params
8686
```
87+
This example shows how to use the Add-MgServicePrincipalKey Cmdlet.
88+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
8789

8890
## PARAMETERS
8991

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Add-MgServicePrincipalPassword.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ Add-MgServicePrincipalPassword -InputObject <IApplicationsIdentity>
4242
Add a strong password or secret to a servicePrincipal object.
4343

4444
## EXAMPLES
45-
46-
### EXAMPLE 1
45+
### Example 1: Using the Add-MgServicePrincipalPassword Cmdlet
4746
```powershell
4847
Import-Module Microsoft.Graph.Applications
4948
$params = @{
@@ -53,6 +52,8 @@ $params = @{
5352
}
5453
Add-MgServicePrincipalPassword -ServicePrincipalId $servicePrincipalId -BodyParameter $params
5554
```
55+
This example shows how to use the Add-MgServicePrincipalPassword Cmdlet.
56+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
5657

5758
## PARAMETERS
5859

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Add-MgServicePrincipalTokenSigningCertificate.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ The **startDateTime** is set to the same time the certificate is created using t
6060
The **endDateTime** can be up to three years after the certificate is created.
6161

6262
## EXAMPLES
63-
64-
### EXAMPLE 1
63+
### Example 1: Using the Add-MgServicePrincipalTokenSigningCertificate Cmdlet
6564
```powershell
6665
Import-Module Microsoft.Graph.Applications
6766
$params = @{
@@ -70,6 +69,8 @@ $params = @{
7069
}
7170
Add-MgServicePrincipalTokenSigningCertificate -ServicePrincipalId $servicePrincipalId -BodyParameter $params
7271
```
72+
This example shows how to use the Add-MgServicePrincipalTokenSigningCertificate Cmdlet.
73+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
7374

7475
## PARAMETERS
7576

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Clear-MgApplicationVerifiedPublisher.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,13 @@ Unset the verifiedPublisher previously set on an application, removing all verif
3333
For more information, see Publisher verification.
3434

3535
## EXAMPLES
36-
37-
### EXAMPLE 1
36+
### Example 1: Using the Clear-MgApplicationVerifiedPublisher Cmdlet
3837
```powershell
3938
Import-Module Microsoft.Graph.Applications
4039
Clear-MgApplicationVerifiedPublisher -ApplicationId $applicationId
4140
```
41+
This example shows how to use the Clear-MgApplicationVerifiedPublisher Cmdlet.
42+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
4243

4344
## PARAMETERS
4445

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Confirm-MgApplicationMemberGroup.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,46 @@ Unset the verifiedPublisher previously set on an application, removing all verif
3333
For more information, see Publisher verification.
3434

3535
## EXAMPLES
36+
### Example 1: Check group memberships for a directory object
3637

37-
### EXAMPLE 1
3838
```powershell
39-
Import-Module Microsoft.Graph.Applications
40-
Clear-MgApplicationVerifiedPublisher -ApplicationId $applicationId
39+
Import-Module Microsoft.Graph.DirectoryObjects
40+
41+
$params = @{
42+
GroupIds = @(
43+
"f448435d-3ca7-4073-8152-a1fd73c0fd09"
44+
"bd7c6263-4dd5-4ae8-8c96-556e1c0bece6"
45+
"93670da6-d731-4366-94b5-abed40b6016b"
46+
"f5484ab1-4d4d-41ec-a9b8-754b3957bfc7"
47+
"c9103f26-f3cf-4004-a611-2a14e81b8f79"
48+
)
49+
}
50+
51+
Confirm-MgDirectoryObjectMemberGroup -DirectoryObjectId $directoryObjectId -BodyParameter $params
4152
```
53+
This example shows how to use the Confirm-MgApplicationMemberGroup Cmdlet.
54+
55+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
56+
57+
### Example 2: Check group memberships for the signed-in user
58+
59+
```powershell
60+
Import-Module Microsoft.Graph.Users.Actions
61+
62+
$params = @{
63+
GroupIds = @(
64+
"fee2c45b-915a-4a64b130f4eb9e75525e"
65+
"4fe90ae065a-478b9400e0a0e1cbd540"
66+
)
67+
}
68+
69+
# A UPN can also be used as -UserId.
70+
Confirm-MgUserMemberGroup -UserId $userId -BodyParameter $params
71+
```
72+
This example shows how to use the Confirm-MgApplicationMemberGroup Cmdlet.
73+
74+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
75+
4276

4377
## PARAMETERS
4478

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Confirm-MgServicePrincipalMemberGroup.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,46 @@ Confirm-MgApplicationMemberObject -InputObject <IApplicationsIdentity>
4545
Invoke action checkMemberObjects
4646

4747
## EXAMPLES
48+
### Example 1: Check group memberships for a directory object
4849

49-
### EXAMPLE 1
5050
```powershell
51-
{{ Add code here }}
51+
Import-Module Microsoft.Graph.DirectoryObjects
52+
53+
$params = @{
54+
GroupIds = @(
55+
"f448435d-3ca7-4073-8152-a1fd73c0fd09"
56+
"bd7c6263-4dd5-4ae8-8c96-556e1c0bece6"
57+
"93670da6-d731-4366-94b5-abed40b6016b"
58+
"f5484ab1-4d4d-41ec-a9b8-754b3957bfc7"
59+
"c9103f26-f3cf-4004-a611-2a14e81b8f79"
60+
)
61+
}
62+
63+
Confirm-MgDirectoryObjectMemberGroup -DirectoryObjectId $directoryObjectId -BodyParameter $params
5264
```
65+
This example shows how to use the Confirm-MgServicePrincipalMemberGroup Cmdlet.
66+
67+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
5368

54-
{{ Add output here }}
69+
### Example 2: Check group memberships for the signed-in user
5570

56-
### EXAMPLE 2
5771
```powershell
58-
{{ Add code here }}
72+
Import-Module Microsoft.Graph.Users.Actions
73+
74+
$params = @{
75+
GroupIds = @(
76+
"fee2c45b-915a-4a64b130f4eb9e75525e"
77+
"4fe90ae065a-478b9400e0a0e1cbd540"
78+
)
79+
}
80+
81+
# A UPN can also be used as -UserId.
82+
Confirm-MgUserMemberGroup -UserId $userId -BodyParameter $params
5983
```
84+
This example shows how to use the Confirm-MgServicePrincipalMemberGroup Cmdlet.
85+
86+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
6087

61-
{{ Add output here }}
6288

6389
## PARAMETERS
6490

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Get-MgApplication.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,37 +38,50 @@ Get-MgApplication -InputObject <IApplicationsIdentity> [-ExpandProperty <String[
3838
Get the properties and relationships of an application object.
3939

4040
## EXAMPLES
41+
### Example 1: Get a list of applications
4142

42-
### EXAMPLE 1
4343
```powershell
4444
Connect-MgGraph -Scopes 'Application.Read.All'
4545
Get-MgApplication |
4646
Format-List Id, DisplayName, AppId, SignInAudience, PublisherDomain
47-
```
4847
4948
Id : 8ea936e0-cb74-46c0-8408-d4614a596267
5049
DisplayName : Test App
5150
AppId : 39b09640-ec3e-44c9-b3de-f52db4e1cf66
5251
SignInAudience : AzureADandPersonalMicrosoftAccount
5352
PublisherDomain : Contoso.com
53+
```
54+
55+
This examples gets a list of all the applications.
56+
57+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
58+
59+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
60+
61+
### Example 2: Get an application by Id
5462

55-
### EXAMPLE 2
5663
```powershell
5764
Connect-MgGraph -Scopes 'Application.Read.All'
5865
Get-MgApplication -Filter "AppId eq '39b09640-ec3e-44c9-b3de-f52db4e1cf66'" |
5966
Format-List Id, DisplayName, AppId, SignInAudience, PublisherDomain
60-
```
6167
6268
DisplayName : Test App
6369
AppId : 39b09640-ec3e-44c9-b3de-f52db4e1cf66
6470
SignInAudience : AzureADandPersonalMicrosoftAccount
6571
PublisherDomain : Contoso.com
72+
```
73+
74+
This examples gets the application by the specified Id.
75+
76+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
77+
78+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
79+
80+
### Example 3: Get a count of all applications
6681

67-
### EXAMPLE 3
6882
```powershell
6983
Connect-MgGraph -Scopes 'Application.Read.All'
7084
Get-MgApplication -ConsistencyLevel eventual -Count appCount
71-
```
7285
7386
Id DisplayName AppId SignInAudience PublisherDomain
7487
-- ----------- ----- -------------- ---------------
@@ -77,28 +90,49 @@ bce20771-2a69-41e5-a0dd-125ac2fa2708 Example 3 App ffdf268a-2fe2-49e1-8cd7-
7790
dcaa0c3a-8dfa-4b47-bc04-0edbab42043a Principal-Test App bd38ad43-6c46-4cc6-b65c-a0db533a2a6f AzureADMyOrg Contoso.com
7891
f6b30057-7095-4e2c-89f8-224149f591b7 Testing App 00e80963-9bc0-4147-b9e0-2ba56093e7e6 AzureADandPersonalMicrosoftAccount Contoso.com
7992
fe4caed6-6182-4aca-b70b-b114c5334a8a New app 641992e9-d176-4aff-a3b6-a867b3ba48c4 AzureADandPersonalMicrosoftAccount Contoso.com
93+
```
94+
95+
This example gets a list of all applications. The $appCount variable contains the count of the objects in the result. Advanced query requires the ConsistencyLevel parameter set to `eventual` and the Count parameter in the command. For more information about *ConsistencyLevel* and *Count*, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
96+
97+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
98+
99+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
100+
101+
### Example 4: Use -Search to get all the applications whose display name contains 'Test' including a count of the returned applications
80102

81-
### EXAMPLE 4
82103
```powershell
83104
Connect-MgGraph -Scopes 'Application.Read.All'
84105
Get-MgApplication -ConsistencyLevel eventual -Count appCount -Search '"DisplayName:Test"'
85-
```
86106
87107
Id DisplayName AppId SignInAudience PublisherDomain
88108
-- ----------- ----- -------------- ---------------
89109
dcaa0c3a-8dfa-4b47-bc04-0edbab42043a Principal-Test App bd38ad43-6c46-4cc6-b65c-a0db533a2a6f AzureADMyOrg Contoso.com
90110
f6b30057-7095-4e2c-89f8-224149f591b7 Testing App 00e80963-9bc0-4147-b9e0-2ba56093e7e6 AzureADandPersonalMicrosoftAccount Contoso.com
111+
```
112+
113+
This example returns all applications whose display name contains 'Test'. The $appCount variable contains the count of the objects in the result. Advanced query requires the ConsistencyLevel parameter set to `eventual` and the Count parameter in the command. For more information about *ConsistencyLevel* and *Count*, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
114+
115+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
116+
117+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
118+
119+
### Example 5: Use -Filter to get all the applications with a display name that starts with 'New' including a count of the returned applications, with the results ordered by display name
91120

92-
### EXAMPLE 5
93121
```powershell
94122
Connect-MgGraph -Scopes 'Application.Read.All'
95123
Get-MgApplication -ConsistencyLevel eventual -Count appCount -Filter "startsWith(DisplayName, 'New')" -OrderBy DisplayName
96-
```
97124
98125
Id DisplayName AppId SignInAudience PublisherDomain
99126
-- ----------- ----- -------------- ---------------
100127
fe4caed6-6182-4aca-b70b-b114c5334a8a New app 641992e9-d176-4aff-a3b6-a867b3ba48c4 AzureADandPersonalMicrosoftAccount Contoso.com
101128
0672d487-4c0c-475a-bf22-0e714f015597 New apps ced14895-14ac-4dcf-8b93-0779f60c000d AzureADandPersonalMicrosoftAccount Contoso.com
129+
```
130+
131+
This example returns all applications whose display name starts with 'New'. The $appCount variable contains the count of the objects in the result. Advanced query requires the ConsistencyLevel parameter set to `eventual` and the Count parameter in the command. For more information about *ConsistencyLevel* and *Count*, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
132+
133+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
134+
135+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
102136

103137
## PARAMETERS
104138

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Get-MgApplicationById.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,10 @@ Return the directory objects specified in a list of IDs.
3434
Some common uses for this function are to:
3535

3636
## EXAMPLES
37+
### Example 1: Code snippet
3738

38-
### EXAMPLE 1
3939
```powershell
4040
Import-Module Microsoft.Graph.DirectoryObjects
41-
```
4241
4342
$params = @{
4443
Ids = @(
@@ -55,6 +54,11 @@ $params = @{
5554
}
5655
5756
Get-MgDirectoryObjectById -BodyParameter $params
57+
```
58+
This example shows how to use the Get-MgApplicationById Cmdlet.
59+
60+
To learn about permissions for this resource, see the [permissions reference](/graph/permissions-reference).
61+
5862

5963
## PARAMETERS
6064

0 commit comments

Comments
 (0)