Skip to content

Commit d6336b5

Browse files
authored
Merge pull request MicrosoftDocs#389 from MicrosoftDocs/weekly_v2_docs_update_14-09-2023
Weekly PowerShell Microsoft Graph Reference Docs Refresh
2 parents 4db9001 + de39c0d commit d6336b5

File tree

1,274 files changed

+9588
-3263
lines changed

Some content is hidden

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

1,274 files changed

+9588
-3263
lines changed

microsoftgraph/EscapeDisallowedHtmlTags.ps1

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,7 @@ function Special-Escape{
217217
Move-Item -Path $tempFilePath -Destination $filePath
218218
}
219219
}
220-
#$___location = Get-Location
221-
#Set-Location microsoftgraph-docs-powershell
220+
Remove-Invalid-NextLine-Characters -FilePath $FilePath -GraphProfile $GraphProfile -ModuleName $ModuleName
222221
}catch{
223222
Write-Host "`nError Message: " $_.Exception.Message
224223
Write-Host "`nError in Line: " $_.InvocationInfo.Line
@@ -251,6 +250,36 @@ try{
251250
}
252251
return "NA"
253252
}
253+
function Remove-Invalid-NextLine-Characters{
254+
param (
255+
[ValidateNotNullOrEmpty()]
256+
[string] $FilePath,
257+
[ValidateSet("beta", "v1.0")]
258+
[string] $GraphProfile = "v1.0",
259+
[ValidateNotNullOrEmpty()]
260+
[string] $ModuleName = "Users"
261+
)
262+
$tempFilePath = "$env:TEMP\$($FilePath | Split-Path -Leaf)"
263+
264+
$replace = ""
265+
try{
266+
$text = Get-Content -Path $FilePath
267+
Write-Host $FilePath
268+
foreach($content in $text){
269+
if($content -match "\\n"){
270+
$text = $text -replace "\\n", $replace
271+
}
272+
}
273+
$text > $tempFilePath
274+
Remove-Item -Path $FilePath
275+
Move-Item -Path $tempFilePath -Destination $FilePath
276+
}catch{
277+
Write-Host "`nError Message: " $_.Exception.Message
278+
Write-Host "`nError in Line: " $_.InvocationInfo.Line
279+
Write-Host "`nError in Line Number: "$_.InvocationInfo.ScriptLineNumber
280+
Write-Host "`nError Item Name: "$_.Exception.ItemName
281+
}
282+
}
254283
Set-Location microsoftgraph-docs-powershell
255284
$date = Get-Date -Format "dd-MM-yyyy"
256285
$proposedBranch = "weekly_v2_docs_update_$date"

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.prod: applications
1010

1111
## SYNOPSIS
1212
Create a self-signed signing certificate and return a selfSignedCertificate object, which is the public part of the generated certificate.
13-
The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: \n+ The keyCredentials object with the following objects:\n + A private key object with usage set to Sign.\n + A public key object with usage set to Verify.\n+ The passwordCredentials object.
13+
The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: + The keyCredentials object with the following objects: + A private key object with usage set to Sign. + A public key object with usage set to Verify.+ The passwordCredentials object.
1414
All the objects have the same value of customKeyIdentifier.
1515
The passwordCredential is used to open the PFX file (private key).
1616
It and the associated private key object have the same value of keyId.
@@ -52,7 +52,7 @@ Add-MgServicePrincipalTokenSigningCertificate -InputObject <IApplicationsIdentit
5252

5353
## DESCRIPTION
5454
Create a self-signed signing certificate and return a selfSignedCertificate object, which is the public part of the generated certificate.
55-
The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: \n+ The keyCredentials object with the following objects:\n + A private key object with usage set to Sign.\n + A public key object with usage set to Verify.\n+ The passwordCredentials object.
55+
The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: + The keyCredentials object with the following objects: + A private key object with usage set to Sign. + A public key object with usage set to Verify.+ The passwordCredentials object.
5656
All the objects have the same value of customKeyIdentifier.
5757
The passwordCredential is used to open the PFX file (private key).
5858
It and the associated private key object have the same value of keyId.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Add a strong password or secret to a servicePrincipal object.
3333

3434
### [Add-MgServicePrincipalTokenSigningCertificate](Add-MgServicePrincipalTokenSigningCertificate.md)
3535
Create a self-signed signing certificate and return a selfSignedCertificate object, which is the public part of the generated certificate.
36-
The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: \n+ The keyCredentials object with the following objects:\n + A private key object with usage set to Sign.\n + A public key object with usage set to Verify.\n+ The passwordCredentials object.
36+
The self-signed signing certificate is composed of the following objects, which are added to the servicePrincipal: + The keyCredentials object with the following objects: + A private key object with usage set to Sign. + A public key object with usage set to Verify.+ The passwordCredentials object.
3737
All the objects have the same value of customKeyIdentifier.
3838
The passwordCredential is used to open the PFX file (private key).
3939
It and the associated private key object have the same value of keyId.
@@ -875,9 +875,9 @@ All the progress, including job state, is persisted, and the job will continue f
875875
Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies.
876876
Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group.
877877
To validate the properties of an existing group, use the group: validateProperties function.
878-
The following policy validations are performed for the display name and mail nickname properties:\n1.
879-
Validate the prefix and suffix naming policy\n2.
880-
Validate the custom banned words policy\n3.
878+
The following policy validations are performed for the display name and mail nickname properties:1.
879+
Validate the prefix and suffix naming policy2.
880+
Validate the custom banned words policy3.
881881
Validate that the mail nickname is unique This API only returns the first validation failure that is encountered.
882882
If the properties fail multiple validations, only the first validation failure is returned.
883883
However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy.
@@ -890,9 +890,9 @@ Validate that the credentials are valid in the tenant.
890890
Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies.
891891
Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group.
892892
To validate the properties of an existing group, use the group: validateProperties function.
893-
The following policy validations are performed for the display name and mail nickname properties:\n1.
894-
Validate the prefix and suffix naming policy\n2.
895-
Validate the custom banned words policy\n3.
893+
The following policy validations are performed for the display name and mail nickname properties:1.
894+
Validate the prefix and suffix naming policy2.
895+
Validate the custom banned words policy3.
896896
Validate that the mail nickname is unique This API only returns the first validation failure that is encountered.
897897
If the properties fail multiple validations, only the first validation failure is returned.
898898
However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy.

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ New-MgApplication [-AddIns <IMicrosoftGraphAddIn[]>] [-AdditionalProperties <Has
3636
[-PublicClient <IMicrosoftGraphPublicClientApplication>] [-PublisherDomain <String>]
3737
[-RequestSignatureVerification <IMicrosoftGraphRequestSignatureVerification>]
3838
[-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SamlMetadataUrl <String>]
39-
[-ServiceManagementReference <String>] [-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
39+
[-ServiceManagementReference <String>]
40+
[-ServicePrincipalLockConfiguration <IMicrosoftGraphServicePrincipalLockConfiguration>]
41+
[-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
4042
[-Synchronization <IMicrosoftGraphSynchronization>] [-Tags <String[]>] [-TokenEncryptionKeyId <String>]
4143
[-TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy[]>]
4244
[-TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy[]>]
@@ -727,6 +729,22 @@ Accept pipeline input: False
727729
Accept wildcard characters: False
728730
```
729731

732+
### -ServicePrincipalLockConfiguration
733+
servicePrincipalLockConfiguration
734+
To construct, see NOTES section for SERVICEPRINCIPALLOCKCONFIGURATION properties and create a hash table.
735+
736+
```yaml
737+
Type: IMicrosoftGraphServicePrincipalLockConfiguration
738+
Parameter Sets: CreateExpanded
739+
Aliases:
740+
741+
Required: False
742+
Position: Named
743+
Default value: None
744+
Accept pipeline input: False
745+
Accept wildcard characters: False
746+
```
747+
730748
### -SignInAudience
731749
Specifies the Microsoft accounts that are supported for the current application.
732750
The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount.

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Test-MgApplicationProperty.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ schema: 2.0.0
1111
Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies.
1212
Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group.
1313
To validate the properties of an existing group, use the group: validateProperties function.
14-
The following policy validations are performed for the display name and mail nickname properties:\n1.
15-
Validate the prefix and suffix naming policy\n2.
16-
Validate the custom banned words policy\n3.
14+
The following policy validations are performed for the display name and mail nickname properties:1.
15+
Validate the prefix and suffix naming policy2.
16+
Validate the custom banned words policy3.
1717
Validate that the mail nickname is unique This API only returns the first validation failure that is encountered.
1818
If the properties fail multiple validations, only the first validation failure is returned.
1919
However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy.
@@ -41,9 +41,9 @@ Test-MgApplicationProperty
4141
Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies.
4242
Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group.
4343
To validate the properties of an existing group, use the group: validateProperties function.
44-
The following policy validations are performed for the display name and mail nickname properties:\n1.
45-
Validate the prefix and suffix naming policy\n2.
46-
Validate the custom banned words policy\n3.
44+
The following policy validations are performed for the display name and mail nickname properties:1.
45+
Validate the prefix and suffix naming policy2.
46+
Validate the custom banned words policy3.
4747
Validate that the mail nickname is unique This API only returns the first validation failure that is encountered.
4848
If the properties fail multiple validations, only the first validation failure is returned.
4949
However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy.

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Test-MgServicePrincipalProperty.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ schema: 2.0.0
1111
Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies.
1212
Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group.
1313
To validate the properties of an existing group, use the group: validateProperties function.
14-
The following policy validations are performed for the display name and mail nickname properties:\n1.
15-
Validate the prefix and suffix naming policy\n2.
16-
Validate the custom banned words policy\n3.
14+
The following policy validations are performed for the display name and mail nickname properties:1.
15+
Validate the prefix and suffix naming policy2.
16+
Validate the custom banned words policy3.
1717
Validate that the mail nickname is unique This API only returns the first validation failure that is encountered.
1818
If the properties fail multiple validations, only the first validation failure is returned.
1919
However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy.
@@ -42,9 +42,9 @@ Test-MgServicePrincipalProperty
4242
Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies.
4343
Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group.
4444
To validate the properties of an existing group, use the group: validateProperties function.
45-
The following policy validations are performed for the display name and mail nickname properties:\n1.
46-
Validate the prefix and suffix naming policy\n2.
47-
Validate the custom banned words policy\n3.
45+
The following policy validations are performed for the display name and mail nickname properties:1.
46+
Validate the prefix and suffix naming policy2.
47+
Validate the custom banned words policy3.
4848
Validate that the mail nickname is unique This API only returns the first validation failure that is encountered.
4949
If the properties fail multiple validations, only the first validation failure is returned.
5050
However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy.

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

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ Update-MgApplication -ApplicationId <String> [-AddIns <IMicrosoftGraphAddIn[]>]
3636
[-PublicClient <IMicrosoftGraphPublicClientApplication>] [-PublisherDomain <String>]
3737
[-RequestSignatureVerification <IMicrosoftGraphRequestSignatureVerification>]
3838
[-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SamlMetadataUrl <String>]
39-
[-ServiceManagementReference <String>] [-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
39+
[-ServiceManagementReference <String>]
40+
[-ServicePrincipalLockConfiguration <IMicrosoftGraphServicePrincipalLockConfiguration>]
41+
[-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
4042
[-Synchronization <IMicrosoftGraphSynchronization>] [-Tags <String[]>] [-TokenEncryptionKeyId <String>]
4143
[-TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy[]>]
4244
[-TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy[]>]
@@ -71,7 +73,9 @@ Update-MgApplication -InputObject <IApplicationsIdentity> [-AddIns <IMicrosoftGr
7173
[-PublicClient <IMicrosoftGraphPublicClientApplication>] [-PublisherDomain <String>]
7274
[-RequestSignatureVerification <IMicrosoftGraphRequestSignatureVerification>]
7375
[-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SamlMetadataUrl <String>]
74-
[-ServiceManagementReference <String>] [-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
76+
[-ServiceManagementReference <String>]
77+
[-ServicePrincipalLockConfiguration <IMicrosoftGraphServicePrincipalLockConfiguration>]
78+
[-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
7579
[-Synchronization <IMicrosoftGraphSynchronization>] [-Tags <String[]>] [-TokenEncryptionKeyId <String>]
7680
[-TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy[]>]
7781
[-TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy[]>]
@@ -789,6 +793,22 @@ Accept pipeline input: False
789793
Accept wildcard characters: False
790794
```
791795

796+
### -ServicePrincipalLockConfiguration
797+
servicePrincipalLockConfiguration
798+
To construct, see NOTES section for SERVICEPRINCIPALLOCKCONFIGURATION properties and create a hash table.
799+
800+
```yaml
801+
Type: IMicrosoftGraphServicePrincipalLockConfiguration
802+
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
803+
Aliases:
804+
805+
Required: False
806+
Position: Named
807+
Default value: None
808+
Accept pipeline input: False
809+
Accept wildcard characters: False
810+
```
811+
792812
### -SignInAudience
793813
Specifies the Microsoft accounts that are supported for the current application.
794814
The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount.

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Applications/Update-MgApplicationByAppId.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ Update-MgApplicationByAppId -AppId <String> [-AddIns <IMicrosoftGraphAddIn[]>]
3636
[-PublicClient <IMicrosoftGraphPublicClientApplication>] [-PublisherDomain <String>]
3737
[-RequestSignatureVerification <IMicrosoftGraphRequestSignatureVerification>]
3838
[-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SamlMetadataUrl <String>]
39-
[-ServiceManagementReference <String>] [-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
39+
[-ServiceManagementReference <String>]
40+
[-ServicePrincipalLockConfiguration <IMicrosoftGraphServicePrincipalLockConfiguration>]
41+
[-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
4042
[-Synchronization <IMicrosoftGraphSynchronization>] [-Tags <String[]>] [-TokenEncryptionKeyId <String>]
4143
[-TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy[]>]
4244
[-TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy[]>]
@@ -65,7 +67,9 @@ Update-MgApplicationByAppId [-AppId <String>] -InputObject <IApplicationsIdentit
6567
[-PublicClient <IMicrosoftGraphPublicClientApplication>] [-PublisherDomain <String>]
6668
[-RequestSignatureVerification <IMicrosoftGraphRequestSignatureVerification>]
6769
[-RequiredResourceAccess <IMicrosoftGraphRequiredResourceAccess[]>] [-SamlMetadataUrl <String>]
68-
[-ServiceManagementReference <String>] [-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
70+
[-ServiceManagementReference <String>]
71+
[-ServicePrincipalLockConfiguration <IMicrosoftGraphServicePrincipalLockConfiguration>]
72+
[-SignInAudience <String>] [-Spa <IMicrosoftGraphSpaApplication>]
6973
[-Synchronization <IMicrosoftGraphSynchronization>] [-Tags <String[]>] [-TokenEncryptionKeyId <String>]
7074
[-TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy[]>]
7175
[-TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy[]>]
@@ -790,6 +794,22 @@ Accept pipeline input: False
790794
Accept wildcard characters: False
791795
```
792796

797+
### -ServicePrincipalLockConfiguration
798+
servicePrincipalLockConfiguration
799+
To construct, see NOTES section for SERVICEPRINCIPALLOCKCONFIGURATION properties and create a hash table.
800+
801+
```yaml
802+
Type: IMicrosoftGraphServicePrincipalLockConfiguration
803+
Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded
804+
Aliases:
805+
806+
Required: False
807+
Position: Named
808+
Default value: None
809+
Accept pipeline input: False
810+
Accept wildcard characters: False
811+
```
812+
793813
### -SignInAudience
794814
Specifies the Microsoft accounts that are supported for the current application.
795815
The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount.

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Bookings/Get-MgBookingBusiness.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ external help file: Microsoft.Graph.Bookings-help.xml
33
Module Name: Microsoft.Graph.Bookings
44
online version: https://learn.microsoft.com/powershell/module/microsoft.graph.bookings/get-mgbookingbusiness
55
schema: 2.0.0
6-
ms.prod: bookings
7-
ms.prod: bookings
86
---
97

108
# Get-MgBookingBusiness

microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Bookings/Get-MgBookingBusinessAppointment.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ external help file: Microsoft.Graph.Bookings-help.xml
33
Module Name: Microsoft.Graph.Bookings
44
online version: https://learn.microsoft.com/powershell/module/microsoft.graph.bookings/get-mgbookingbusinessappointment
55
schema: 2.0.0
6-
ms.prod: bookings
7-
ms.prod: bookings
86
---
97

108
# Get-MgBookingBusinessAppointment

0 commit comments

Comments
 (0)