Skip to content

Commit 516e031

Browse files
committed
Corrected titles
1 parent 82adf69 commit 516e031

File tree

4,015 files changed

+24491
-20462
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,015 files changed

+24491
-20462
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
@@ -56,11 +56,11 @@ Applications that don't have any existing valid certificates (no certificates ha
5656
You can use the Update application operation to perform an update instead.
5757

5858
## EXAMPLES
59+
### Example 1: Add a new key credential to an application
5960

60-
### EXAMPLE 1
6161
```powershell
62+
6263
Import-Module Microsoft.Graph.Applications
63-
```
6464
6565
$params = @{
6666
keyCredential = @{
@@ -74,10 +74,14 @@ $params = @{
7474
7575
Add-MgApplicationKey -ApplicationId $applicationId -BodyParameter $params
7676
77-
### EXAMPLE 2
77+
```
78+
This example will add a new key credential to an application
79+
80+
### Example 2: Add a key credential and an associated password for the key
81+
7882
```powershell
83+
7984
Import-Module Microsoft.Graph.Applications
80-
```
8185
8286
$params = @{
8387
keyCredential = @{
@@ -93,6 +97,10 @@ $params = @{
9397
9498
Add-MgApplicationKey -ApplicationId $applicationId -BodyParameter $params
9599
100+
```
101+
This example will add a key credential and an associated password for the key
102+
103+
96104
## PARAMETERS
97105

98106
### -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
@@ -46,11 +46,11 @@ Add-MgApplicationPassword -InputObject <IApplicationsIdentity>
4646
Adds a strong password or secret to an application.
4747

4848
## EXAMPLES
49+
### Example 1: Add a password credential to an application with a six month expiry
4950

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

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

104113
## PARAMETERS
105114

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
@@ -53,11 +53,11 @@ ServicePrincipals that don't have any existing valid certificates (i.e.: no cert
5353
Update servicePrincipal can be used to perform an update instead.
5454

5555
## EXAMPLES
56+
### Example 1: Adding a new key credential to a servicePrincipal
5657

57-
### EXAMPLE 1
5858
```powershell
59+
5960
Import-Module Microsoft.Graph.Applications
60-
```
6161
6262
$params = @{
6363
keyCredential = @{
@@ -71,10 +71,14 @@ $params = @{
7171
7272
Add-MgServicePrincipalKey -ServicePrincipalId $servicePrincipalId -BodyParameter $params
7373
74-
### EXAMPLE 2
74+
```
75+
This example shows adding a new key credential to a serviceprincipal
76+
77+
### Example 2: Adding a key credential and an associated password for the key
78+
7579
```powershell
80+
7681
Import-Module Microsoft.Graph.Applications
77-
```
7882
7983
$params = @{
8084
keyCredential = @{
@@ -90,6 +94,10 @@ $params = @{
9094
9195
Add-MgServicePrincipalKey -ServicePrincipalId $servicePrincipalId -BodyParameter $params
9296
97+
```
98+
This example shows adding a key credential and an associated password for the key
99+
100+
93101
## PARAMETERS
94102

95103
### -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
@@ -43,11 +43,11 @@ Add-MgServicePrincipalPassword -InputObject <IApplicationsIdentity>
4343
Add a strong password or secret to a servicePrincipal object.
4444

4545
## EXAMPLES
46+
### Example 1: Code snippet
4647

47-
### EXAMPLE 1
4848
```powershell
49+
4950
Import-Module Microsoft.Graph.Applications
50-
```
5151
5252
$params = @{
5353
passwordCredential = @{
@@ -57,6 +57,10 @@ $params = @{
5757
5858
Add-MgServicePrincipalPassword -ServicePrincipalId $servicePrincipalId -BodyParameter $params
5959
60+
```
61+
This example shows how to use the Add-MgServicePrincipalPassword Cmdlet.
62+
63+
6064
## PARAMETERS
6165

6266
### -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
@@ -61,11 +61,11 @@ The startDateTime is set to the same time the certificate is created using the a
6161
The endDateTime can be up to three years after the certificate is created.
6262

6363
## EXAMPLES
64+
### Example 1: Code snippet
6465

65-
### EXAMPLE 1
6666
```powershell
67+
6768
Import-Module Microsoft.Graph.Applications
68-
```
6969
7070
$params = @{
7171
displayName = "CN=customDisplayName"
@@ -74,6 +74,10 @@ $params = @{
7474
7575
Add-MgServicePrincipalTokenSigningCertificate -ServicePrincipalId $servicePrincipalId -BodyParameter $params
7676
77+
```
78+
This example shows how to use the Add-MgServicePrincipalTokenSigningCertificate Cmdlet.
79+
80+
7781
## PARAMETERS
7882

7983
### -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
@@ -34,14 +34,18 @@ Unset the verifiedPublisher previously set on an application, removing all verif
3434
For more information, see Publisher verification.
3535

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

38-
### EXAMPLE 1
3939
```powershell
40+
4041
Import-Module Microsoft.Graph.Applications
41-
```
4242
4343
Clear-MgApplicationVerifiedPublisher -ApplicationId $applicationId
4444
45+
```
46+
This example shows how to use the Clear-MgApplicationVerifiedPublisher Cmdlet.
47+
48+
4549
## PARAMETERS
4650

4751
### -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
@@ -55,16 +55,6 @@ Because Microsoft 365 groups cannot contain other groups, membership in a Micros
5555

5656
## EXAMPLES
5757

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

7060
### -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
@@ -55,16 +55,6 @@ Because Microsoft 365 groups cannot contain other groups, membership in a Micros
5555

5656
## EXAMPLES
5757

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

7060
### -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
@@ -40,37 +40,50 @@ Get-MgApplication -InputObject <IApplicationsIdentity> [-ExpandProperty <String[
4040
Get the properties and relationships of an application object.
4141

4242
## EXAMPLES
43+
### Example 1: Get a list of applications
4344

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

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

69-
### EXAMPLE 3
7084
```powershell
7185
Connect-MgGraph -Scopes 'Application.Read.All'
7286
Get-MgApplication -ConsistencyLevel eventual -Count appCount
73-
```
7487
7588
Id DisplayName AppId SignInAudience PublisherDomain
7689
-- ----------- ----- -------------- ---------------
@@ -79,28 +92,49 @@ bce20771-2a69-41e5-a0dd-125ac2fa2708 Example 3 App ffdf268a-2fe2-49e1-8cd7-
7992
dcaa0c3a-8dfa-4b47-bc04-0edbab42043a Principal-Test App bd38ad43-6c46-4cc6-b65c-a0db533a2a6f AzureADMyOrg Contoso.com
8093
f6b30057-7095-4e2c-89f8-224149f591b7 Testing App 00e80963-9bc0-4147-b9e0-2ba56093e7e6 AzureADandPersonalMicrosoftAccount Contoso.com
8194
fe4caed6-6182-4aca-b70b-b114c5334a8a New app 641992e9-d176-4aff-a3b6-a867b3ba48c4 AzureADandPersonalMicrosoftAccount Contoso.com
95+
```
96+
97+
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).
98+
99+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
100+
101+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
102+
103+
### Example 4: Use -Search to get all the applications whose display name contains 'Test' including a count of the returned applications
82104

83-
### EXAMPLE 4
84105
```powershell
85106
Connect-MgGraph -Scopes 'Application.Read.All'
86107
Get-MgApplication -ConsistencyLevel eventual -Count appCount -Search '"DisplayName:Test"'
87-
```
88108
89109
Id DisplayName AppId SignInAudience PublisherDomain
90110
-- ----------- ----- -------------- ---------------
91111
dcaa0c3a-8dfa-4b47-bc04-0edbab42043a Principal-Test App bd38ad43-6c46-4cc6-b65c-a0db533a2a6f AzureADMyOrg Contoso.com
92112
f6b30057-7095-4e2c-89f8-224149f591b7 Testing App 00e80963-9bc0-4147-b9e0-2ba56093e7e6 AzureADandPersonalMicrosoftAccount Contoso.com
113+
```
114+
115+
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).
116+
117+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
118+
119+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
120+
121+
### 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
93122

94-
### EXAMPLE 5
95123
```powershell
96124
Connect-MgGraph -Scopes 'Application.Read.All'
97125
Get-MgApplication -ConsistencyLevel eventual -Count appCount -Filter "startsWith(DisplayName, 'New')" -OrderBy DisplayName
98-
```
99126
100127
Id DisplayName AppId SignInAudience PublisherDomain
101128
-- ----------- ----- -------------- ---------------
102129
fe4caed6-6182-4aca-b70b-b114c5334a8a New app 641992e9-d176-4aff-a3b6-a867b3ba48c4 AzureADandPersonalMicrosoftAccount Contoso.com
103130
0672d487-4c0c-475a-bf22-0e714f015597 New apps ced14895-14ac-4dcf-8b93-0779f60c000d AzureADandPersonalMicrosoftAccount Contoso.com
131+
```
132+
133+
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).
134+
135+
To learn about other permissions for this resource, see the [permissions reference](/graph/permissions-reference).
136+
137+
To consent to any of these permissions run `Connect-MgGraph -Scopes Permission`. For example, `Connect-MgGraph -Scopes Application.Read.All, Application.ReadWrite.All`.
104138

105139
## PARAMETERS
106140

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
@@ -38,16 +38,6 @@ Some common uses for this function are to:
3838

3939
## EXAMPLES
4040

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

5343
### -AdditionalProperties

0 commit comments

Comments
 (0)