-
Notifications
You must be signed in to change notification settings - Fork 152
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Pre Auth Setting PS Cmdlet Documentation #760
base: main
Are you sure you want to change the base?
Add Pre Auth Setting PS Cmdlet Documentation #760
Conversation
Learn Build status updates of commit bde128f: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue. This comment lists only the first 25 files in the pull request. sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantPreAuthSettings.yml
sharepoint/sharepoint-ps/sharepoint-online/index.yml
sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.yml
sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.yml
sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.yml
sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.yml
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.yml
sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchResource.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchSpelltuning.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPAppDeniedEndpoint.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPDistributedCacheServiceInstance.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachineInfo.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachinePool.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingRule.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPScaleOutDatabase.yml
This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
Learn Build status updates of commit 0cf993c: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue. sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md
sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-cmdlets.md
sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-sub-cmdlets.md
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoOptInStatus.yml
sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedContainer.yml
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantPreAuthSettings.yml
sharepoint/sharepoint-ps/sharepoint-online/index.yml
This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
Learn Build status updates of commit 70cf629: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Learn Build status updates of commit e135d60: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Learn Build status updates of commit d6f0034: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Learn Build status updates of commit e5ee158: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Learn Build status updates of commit 3b08c7c: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Learn Build status updates of commit dee1661: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue. This comment lists only the first 25 files in the pull request. sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.yml
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantPreAuthSettings.yml
sharepoint/sharepoint-ps/sharepoint-online/index.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchResource.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-FASTSearchSpelltuning.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPAppDeniedEndpoint.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPDistributedCacheServiceInstance.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachineInfo.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingMachinePool.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPRoutingRule.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPScaleOutDatabase.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPSecureStoreSystemAccount.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPServerScaleOutDatabase.yml
sharepoint/sharepoint-ps/sharepoint-server/Add-SPThrottlingRule.yml
This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
|
||
## SYNOPSIS | ||
|
||
Gets the pre auth settings for the tenant. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a brief sentence that explains what "pre auth" is. Alternatively, if pre auth is already documented somewhere else in learn.microsoft.com, link it here:
See the [pre auth documentation](xxx) for more information.
|
||
Sets the pre auth settings for the tenant. | ||
|
||
**What is pre auth?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this header is not allowed. See the platyPS schema for what's expected.
Options:
- Move this explanation to the DESCRIPTION section
- Have a separate documentation for pre auth, and link it here
|
||
`https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...` | ||
|
||
However, pre auth is currently being deprecated. So this command lets you control whether you want to disable the use of pre auth overall and define any special cases to allow or deny the use of pre auth in based on app id and feature. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> 3. IsDisabled | ||
|
||
> [!NOTE] | ||
> The -IncludedApps and -IncludedFeatures parameters alone should be enough for simpler configurations. However, there are some cases (like example 3) where the -ExcludedApps and -ExcludedFeatures parameters are useful to define exactly which apps are allowed/denied from using pre auth. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" | ||
``` | ||
This example disables pre auth for the tenant overall and adds a setting that allows two apps continue using pre auth for all features, while the rest of the apps and features are denied from using pre auth. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
```powershell | ||
Set-SPOTenantPreAuthSettings -IsDisabled $true | ||
|
||
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "00000000-0000-0000-0000-000000000000,11111111-1111-1111-1111-111111111111" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
``` | ||
This example disables pre auth for the tenant overall and allows all apps apart from 1 to continue using pre auth for all features except for Download and Embed. | ||
|
||
In this case, the app with id 00000000-0000-0000-0000-000000000000 will not be allowed to use pre auth for any feature because it is not an included app for the setting. Therefore, we will default to the IsDisabled setting, which disables the use of preAuth overall. Any other app will be allowed to use pre auth for all features except for Download and Embed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
Indicates whether pre auth is disabled for the tenant. | ||
|
||
PARAMVALUE: $true | $false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- "S2SPAC" | ||
- "PAC" | ||
- "VideoPlayback" | ||
- "AudioTrackUpload" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sort them for readability
also, maybe have them as markdown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🕐
@lw-msft please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
No description provided.