Skip to content

Commit 6509e39

Browse files
committed
Corrected titles
1 parent f785237 commit 6509e39

File tree

4,012 files changed

+24535
-20461
lines changed

Some content is hidden

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

4,012 files changed

+24535
-20461
lines changed

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ 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+
### Example 1: Add a new key credential to an application
5859

59-
### EXAMPLE 1
6060
```powershell
61+
6162
Import-Module Microsoft.Graph.Applications
62-
```
6363
6464
$params = @{
6565
keyCredential = @{
@@ -73,10 +73,14 @@ $params = @{
7373
7474
Add-MgApplicationKey -ApplicationId $applicationId -BodyParameter $params
7575
76-
### EXAMPLE 2
76+
```
77+
This example will add a new key credential to an application
78+
79+
### Example 2: Add a key credential and an associated password for the key
80+
7781
```powershell
82+
7883
Import-Module Microsoft.Graph.Applications
79-
```
8084
8185
$params = @{
8286
keyCredential = @{
@@ -92,6 +96,10 @@ $params = @{
9296
9397
Add-MgApplicationKey -ApplicationId $applicationId -BodyParameter $params
9498
99+
```
100+
This example will add a key credential and an associated password for the key
101+
102+
95103
## PARAMETERS
96104

97105
### -AdditionalProperties

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: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ 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+
### Example 1: Adding a new key credential to a servicePrincipal
5556

56-
### EXAMPLE 1
5757
```powershell
58+
5859
Import-Module Microsoft.Graph.Applications
59-
```
6060
6161
$params = @{
6262
keyCredential = @{
@@ -70,10 +70,14 @@ $params = @{
7070
7171
Add-MgServicePrincipalKey -ServicePrincipalId $servicePrincipalId -BodyParameter $params
7272
73-
### EXAMPLE 2
73+
```
74+
This example shows adding a new key credential to a serviceprincipal
75+
76+
### Example 2: Adding a key credential and an associated password for the key
77+
7478
```powershell
79+
7580
Import-Module Microsoft.Graph.Applications
76-
```
7781
7882
$params = @{
7983
keyCredential = @{
@@ -89,6 +93,10 @@ $params = @{
8993
9094
Add-MgServicePrincipalKey -ServicePrincipalId $servicePrincipalId -BodyParameter $params
9195
96+
```
97+
This example shows adding a key credential and an associated password for the key
98+
99+
92100
## PARAMETERS
93101

94102
### -AdditionalProperties

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

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

4444
## EXAMPLES
45+
### Example 1: Code snippet
4546

46-
### EXAMPLE 1
4747
```powershell
48+
4849
Import-Module Microsoft.Graph.Applications
49-
```
5050
5151
$params = @{
5252
passwordCredential = @{
@@ -56,6 +56,10 @@ $params = @{
5656
5757
Add-MgServicePrincipalPassword -ServicePrincipalId $servicePrincipalId -BodyParameter $params
5858
59+
```
60+
This example shows how to use the Add-MgServicePrincipalPassword Cmdlet.
61+
62+
5963
## PARAMETERS
6064

6165
### -AdditionalProperties

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

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

6262
## EXAMPLES
63+
### Example 1: Code snippet
6364

64-
### EXAMPLE 1
6565
```powershell
66+
6667
Import-Module Microsoft.Graph.Applications
67-
```
6868
6969
$params = @{
7070
displayName = "CN=customDisplayName"
@@ -73,6 +73,10 @@ $params = @{
7373
7474
Add-MgServicePrincipalTokenSigningCertificate -ServicePrincipalId $servicePrincipalId -BodyParameter $params
7575
76+
```
77+
This example shows how to use the Add-MgServicePrincipalTokenSigningCertificate Cmdlet.
78+
79+
7680
## PARAMETERS
7781

7882
### -AdditionalProperties

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

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

3535
## EXAMPLES
36+
### Example 1: Code snippet
3637

37-
### EXAMPLE 1
3838
```powershell
39+
3940
Import-Module Microsoft.Graph.Applications
40-
```
4141
4242
Clear-MgApplicationVerifiedPublisher -ApplicationId $applicationId
4343
44+
```
45+
This example shows how to use the Clear-MgApplicationVerifiedPublisher Cmdlet.
46+
47+
4448
## PARAMETERS
4549

4650
### -ApplicationId

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,6 @@ Because Microsoft 365 groups cannot contain other groups, membership in a Micros
5454

5555
## EXAMPLES
5656

57-
### EXAMPLE 1
58-
```powershell
59-
{{ Add code here }}
60-
```
61-
62-
### EXAMPLE 2
63-
```powershell
64-
{{ Add code here }}
65-
```
66-
6757
## PARAMETERS
6858

6959
### -AdditionalProperties

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,6 @@ Because Microsoft 365 groups cannot contain other groups, membership in a Micros
5454

5555
## EXAMPLES
5656

57-
### EXAMPLE 1
58-
```powershell
59-
{{ Add code here }}
60-
```
61-
62-
### EXAMPLE 2
63-
```powershell
64-
{{ Add code here }}
65-
```
66-
6757
## PARAMETERS
6858

6959
### -AdditionalProperties

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: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,6 @@ Some common uses for this function are to:
3737

3838
## EXAMPLES
3939

40-
### EXAMPLE 1
41-
```powershell
42-
{{ Add code here }}
43-
```
44-
45-
### EXAMPLE 2
46-
```powershell
47-
{{ Add code here }}
48-
```
49-
5040
## PARAMETERS
5141

5242
### -AdditionalProperties

0 commit comments

Comments
 (0)