Updates
Родитель
defb1f0c63
Коммит
6353f29ef3
|
@ -0,0 +1,84 @@
|
|||
# AADApplication
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Attribute | DataType | Description | Allowed Values |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| **DisplayName** | Key | String | DisplayName of the app ||
|
||||
| **ObjectId** | Write | String | ObjectID of the app. ||
|
||||
| **AvailableToOtherTenants** | Write | Boolean | Indicates whether this application is available in other tenants. ||
|
||||
| **GroupMembershipClaims** | Write | String | A bitmask that configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. The bitmask values are: 0: None, 1: Security groups and Azure AD roles, 2: Reserved, and 4: Reserved. Setting the bitmask to 7 will get all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of. ||
|
||||
| **Homepage** | Write | String | The URL to the application's homepage. ||
|
||||
| **IdentifierUris** | Write | StringArray[] | User-defined URI(s) that uniquely identify a Web application within its Azure AD tenant, or within a verified custom domain. ||
|
||||
| **KnownClientApplications** | Write | StringArray[] | Client applications that are tied to this resource application. ||
|
||||
| **LogoutURL** | Write | String | The logout url for this application. ||
|
||||
| **Oauth2AllowImplicitFlow** | Write | Boolean | Specifies whether this web application can request OAuth2.0 implicit flow tokens. The default is false. ||
|
||||
| **Oauth2AllowUrlPathMatching** | Write | Boolean | Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow path matching of the redirect URI against the application's replyUrls. The default is false. ||
|
||||
| **Oauth2RequirePostResponse** | Write | Boolean | Set this to true if an Oauth2 psot response is required. ||
|
||||
| **PublicClient** | Write | Boolean | Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false. ||
|
||||
| **ReplyURLs** | Write | StringArray[] | Specifies the URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to. ||
|
||||
| **SamlMetadataUrl** | Write | String | The URL to the SAML metadata for the application. ||
|
||||
| **Ensure** | Write | String | Specify if the Azure AD App should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Azure AD Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# AADApplication
|
||||
|
||||
### Description
|
||||
|
||||
This resource configures an Azure Active Directory Application.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* None
|
||||
* **Export**
|
||||
* None
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
||||
This example is used to test new resources and showcase the usage of new resources being worked on.
|
||||
It is not meant to use as a production baseline.
|
||||
|
||||
```powershell
|
||||
Configuration Example
|
||||
{
|
||||
param(
|
||||
[Parameter(Mandatory = $true)]
|
||||
[PSCredential]
|
||||
$credsGlobalAdmin
|
||||
)
|
||||
Import-DscResource -ModuleName Microsoft365DSC
|
||||
|
||||
node localhost
|
||||
{
|
||||
AADApplication DSCApp1
|
||||
{
|
||||
DisplayName = "AppDisplayName"
|
||||
AvailableToOtherTenants = $false
|
||||
GroupMembershipClaims = "0"
|
||||
Homepage = "https://app.contoso.com"
|
||||
IdentifierUris = "https://app.contoso.com"
|
||||
KnownClientApplications = ""
|
||||
LogoutURL = "https://app.contoso.com/logout"
|
||||
Oauth2AllowImplicitFlow = $false
|
||||
Oauth2AllowUrlPathMatching = $false
|
||||
Oauth2RequirePostResponse = $false
|
||||
PublicClient = $false
|
||||
ReplyURLs = "https://app.contoso.com"
|
||||
SamlMetadataUrl = ""
|
||||
Ensure = "Present"
|
||||
GlobalAdminAccount = $credsGlobalAdmin
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -9,7 +9,12 @@
|
|||
| **DomainType** | Write | String | The type of AcceptedDomain. Currently the EXOAcceptedDomain DSC Resource accepts a value of 'Authoritative' and 'InternalRelay'. |Authoritative, InternalRelay|
|
||||
| **MatchSubDomains** | Write | Boolean | The MatchSubDomains parameter must be false on Authoritative domains. The default value is false. ||
|
||||
| **OutboundOnly** | Write | Boolean | The OutboundOnly must be false on Authoritative domains. The default value is false. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAcceptedDomain
|
||||
|
||||
|
|
|
@ -9,7 +9,12 @@
|
|||
| **Characteristic** | Write | String | The Characteristic parameter specifies the device characteristic or category that's used by the rule. |DeviceModel, DeviceType, DeviceOS, UserAgent, XMSWLHeader|
|
||||
| **QueryString** | Write | String | The QueryString parameter specifies the device identifier that's used by the rule. This parameter uses a text value that's used with Characteristic parameter value to define the device. ||
|
||||
| **Ensure** | Write | String | Specify if the Active Sync Device Access Rule should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOActiveSyncDeviceAccessRule
|
||||
|
||||
|
|
|
@ -10,7 +10,12 @@
|
|||
| **OfflineAddressBook** | Write | String | The OfflineAddressBook parameter specifies the identity of the offline address book (OAB) that will be used by mailbox users who are assigned this address book policy. You can specify only one OAB for each address book policy. ||
|
||||
| **RoomList** | Write | String | The RoomList parameter specifies the name of the room address list. ||
|
||||
| **Ensure** | Write | String | Specify if the Address Book Policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAddressBookPolicy
|
||||
|
||||
|
|
|
@ -27,7 +27,12 @@
|
|||
| **IncludedRecipients** | Write | StringArray[] | The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. |AllRecipients, MailboxUsers, MailContacts, MailGroups, MailUsers, Resources|
|
||||
| **RecipientFilter** | Write | String | The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. ||
|
||||
| **Ensure** | Write | String | Specifies if this AddressList should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAddressList
|
||||
|
||||
|
|
|
@ -27,7 +27,12 @@
|
|||
| **TargetedDomainsToProtect** | Write | StringArray[] | The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. ||
|
||||
| **TargetedUserActionRecipients** | Write | StringArray[] | Theâ¯TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the valueâ¯Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. ||
|
||||
| **TargetedUsersToProtect** | Write | StringArray[] | The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAntiPhishPolicy
|
||||
|
||||
|
|
|
@ -16,7 +16,12 @@
|
|||
| **RecipientDomainIs** | Write | StringArray[] | The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. ||
|
||||
| **SentTo** | Write | StringArray[] | The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. ||
|
||||
| **SentToMemberOf** | Write | StringArray[] | The SentToMemberOf parameter looks for messages sent to members of groups. You can use any value that uniquely identifies the group. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAntiPhishRule
|
||||
|
||||
|
|
|
@ -10,7 +10,12 @@
|
|||
| **PolicyScopeGroupId** | Write | String | The PolicyScopeGroupID parameter specifies the recipient to define in the policy. You can use any value that uniquely identifies the recipient. ||
|
||||
| **Description** | Write | String | The Description parameter specifies a description for the policy. ||
|
||||
| **Ensure** | Write | String | Specify if the Application Access Policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOApplicationAccessPolicy
|
||||
|
||||
|
|
|
@ -12,7 +12,12 @@
|
|||
| **EnableATPForSPOTeamsODB** | Write | Boolean | The EnableATPForSPOTeamsODB parameter specifies whether ATP is enabled for SharePoint Online, OneDrive for Business and Microsoft Teams. Default is $false. ||
|
||||
| **EnableSafeLinksForClients** | Write | Boolean | The EnableSafeLinksForClients parameter specifies whether Safe Links is enabled for Office 365 ProPlus clients. Default is $false. ||
|
||||
| **TrackClicks** | Write | Boolean | The TrackClicks parameter specifies whether to track user clicks related to blocked URLs. Default is $true. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAtpPolicyForO365
|
||||
|
||||
|
|
|
@ -10,7 +10,12 @@
|
|||
| **ForestName** | Write | String | The ForestName parameter specifies the SMTP domain name of the target forest for users whose free/busy data must be retrieved. If your users are distributed among multiple SMTP domains in the target forest, run the Add-AvailabilityAddressSpace command once for each SMTP domain. ||
|
||||
| **TargetAutodiscoverEpr** | Write | String | The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests. ||
|
||||
| **Ensure** | Write | String | Specifies if this AvailabilityAddressSpace should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAvailabilityAddressSpace
|
||||
|
||||
|
|
|
@ -6,7 +6,12 @@
|
|||
| --- | --- | --- | --- | --- |
|
||||
| **OrgWideAccount** | Key | String | Specify the OrgWideAccount for the AvailabilityConfig. ||
|
||||
| **Ensure** | Write | String | Specify if the AvailabilityConfig should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOAvailabilityConfig
|
||||
|
||||
|
|
|
@ -10,7 +10,12 @@
|
|||
| **ImapEnabled** | Write | Boolean | The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. The default value is $true for all CAS mailbox plans except ExchangeOnlineDeskless which is $false by default. ||
|
||||
| **OwaMailboxPolicy** | Write | String | The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailbox plan. The default value is OwaMailboxPolicy-Default. You can use the Get-OwaMailboxPolicy cmdlet to view the available Outlook on the web mailbox policies. ||
|
||||
| **PopEnabled** | Write | Boolean | The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. Default is $true. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOCASMailboxPlan
|
||||
|
||||
|
|
|
@ -19,7 +19,12 @@
|
|||
| **UserRecipientFilter** | Write | String | The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPath filter syntax to identify the user. ||
|
||||
| **UsernameMatchesAnyOfPatterns** | Write | StringArray[] | The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that is based on the user's account name. ||
|
||||
| **Ensure** | Write | String | Specifies if this Client Access Rule should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOClientAccessRule
|
||||
|
||||
|
|
|
@ -11,7 +11,12 @@
|
|||
| **KeySize** | Write | UInt16 | The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. The only available value is 1024. |1024|
|
||||
| **Enabled** | Write | Boolean | The Enabled parameter specifies whether the DKIM Signing Configuration is enabled or disabled. Default is $true. ||
|
||||
| **Ensure** | Write | String | Specifies if this Client Access Rule should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXODkimSigningConfig
|
||||
|
||||
|
|
|
@ -10,7 +10,12 @@
|
|||
| **EnabledPrimarySMTPAddressTemplate** | Write | StringArray[] | The EnabledPrimarySMTPAddressTemplate parameter specifies the specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. ||
|
||||
| **ManagedByFilter** | Write | String | The ManagedByFilter parameter specifies the email address policies to apply to Office 365 groups based on the properties of the users who create the Office 365 groups. ||
|
||||
| **Ensure** | Write | String | Specify if the Email Address Policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOEmailAddressPolicy
|
||||
|
||||
|
|
|
@ -26,7 +26,12 @@
|
|||
| **IncludedRecipients** | Write | StringArray[] | The IncludedRecipients parameter specifies a precanned filter that's based on the recipient type. |, AllRecipients, MailboxUsers, MailContacts, MailGroups, MailUsers, Resources|
|
||||
| **RecipientFilter** | Write | String | The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. ||
|
||||
| **Ensure** | Write | String | Specify if the Global Address List should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOGlobalAddressList
|
||||
|
||||
|
|
|
@ -11,7 +11,12 @@
|
|||
| **IPBlockList** | Write | StringArray[] | The IPBlockList parameter specifies IP addresses from which messages are never allowed. Messages from the IP addresses you specify are blocked without any further spam scanning. Valid values for this parameter are: A single IP address, an IP address range, a CIDR IP. ||
|
||||
| **MakeDefault** | Write | Boolean | The MakeDefault parameter makes the specified policy the default connection filter policy. Default is $false. ||
|
||||
| **Ensure** | Write | String | Specifies if this Hosted Connection Filter Policy should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOHostedConnectionFilterPolicy
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
| **AllowedSenders** | Write | StringArray[] | The AllowedSenders parameter specifies a list of trusted senders that aren't processed by the spam filter. ||
|
||||
| **BlockedSenderDomains** | Write | StringArray[] | The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. ||
|
||||
| **BlockedSenders** | Write | StringArray[] | The BlockedSenders parameter specifies senders that are always marked as spam sources. ||
|
||||
| **BulkSpamAction** | Write | String | The BulkSpamAction parameter specifies the action to take on messages that are classified as bulk email. |MoveToJmf, AddXHeader, ModifySubject, Redirect, Delete, Quarantine|
|
||||
| **BulkSpamAction** | Write | String | The BulkSpamAction parameter specifies the action to take on messages that are classified as bulk email. |MoveToJmf, AddXHeader, ModifySubject, Redirect, Delete, Quarantine, NoAction|
|
||||
| **BulkThreshold** | Write | UInt32 | The BulkThreshold parameter specifies the Bulk Complaint Level (BCL) threshold setting. Valid values are from 1 - 9, where 1 marks most bulk email as spam, and 9 allows the most bulk email to be delivered. The default value is 7. ||
|
||||
| **DownloadLink** | Write | Boolean | The DownloadLink parameter shows or hides a link in end-user spam notification messages to download the Junk Email Reporting Tool plugin for Outlook. Valid input for this parameter is $true or $false. The default value is $false. ||
|
||||
| **EnableEndUserSpamNotifications** | Write | Boolean | The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notification messages. Valid input for this parameter is $true or $false. The default value is $false. ||
|
||||
|
@ -52,7 +52,12 @@
|
|||
| **TestModeBccToRecipients** | Write | StringArray[] | The TestModeBccToRecipients parameter specifies the blind carbon copy recipients to add to spam messages when the TestModeAction action parameter is set to the value BccMessage. ||
|
||||
| **ZapEnabled** | Write | Boolean | The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for spam. ZAP detects unread spam messages that have already been delivered to the user's Inbox. The default value is $true ||
|
||||
| **Ensure** | Write | String | Specify if this policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOHostedContentFilterPolicy
|
||||
|
||||
|
|
|
@ -16,7 +16,12 @@
|
|||
| **SentTo** | Write | StringArray[] | The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. ||
|
||||
| **SentToMemberOf** | Write | StringArray[] | The SentToMemberOf parameter looks for messages sent to members of groups. You can use any value that uniquely identifies the group. ||
|
||||
| **Ensure** | Write | String | Specify if this rule should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOHostedContentFilterRule
|
||||
|
||||
|
|
|
@ -11,7 +11,12 @@
|
|||
| **NotifyOutboundSpam** | Write | Boolean | The NotifyOutboundSpam parameter enables or disables sending notification messages to administrators when an outgoing message is determined to be spam. Valid input for this parameter is $true or $false. The default value is $false. You specify the administrators to notify by using the NotifyOutboundSpamRecipients parameter. ||
|
||||
| **NotifyOutboundSpamRecipients** | Write | StringArray[] | The NotifyOutboundSpamRecipients parameter specifies the administrators to notify when an outgoing message is determined to be spam. Valid input for this parameter is an email address. Separate multiple email addresses with commas. ||
|
||||
| **Ensure** | Write | String | Specify if this rule should exist or not. This value must be 'Present' as the Default policy cannot be deleted. |Present|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOHostedOutboundSpamFilterPolicy
|
||||
|
||||
|
|
|
@ -19,7 +19,12 @@
|
|||
| **TlsSenderCertificateName** | Write | String | The TlsSenderCertificateName parameter specifies the certificate used by the sender's domain when the RequireTls parameter is set to $true. Valid input for the TlsSenderCertificateName parameter is an SMTP domain. ||
|
||||
| **TreatMessagesAsInternal** | Write | Boolean | The TreatMessagesAsInternal parameter specifies an alternative method to identify messages sent from an on-premises organization as internal messages. You should only consider using this parameter when your on-premises organization doesn't use Exchange. ||
|
||||
| **Ensure** | Write | String | Specifies if this Outbound connector should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOInboundConnector
|
||||
|
||||
|
|
|
@ -9,7 +9,12 @@
|
|||
| **Enabled** | Write | Boolean | Specifies whether connector is enabled. ||
|
||||
| **TargetAddressDomains** | Write | StringArray[] | The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-organization connector. These domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. You can specify multiple domains separated by commas. ||
|
||||
| **Ensure** | Write | String | Specifies if this Intra-Organization connector should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOIntraOrganizationConnector
|
||||
|
||||
|
|
|
@ -11,7 +11,12 @@
|
|||
| **MailTipsMailboxSourcedTipsEnabled** | Write | Boolean | Specifies whether MailTips that rely on mailbox data (out-of-office or full mailbox) are enabled. ||
|
||||
| **MailTipsExternalRecipientsTipsEnabled** | Write | Boolean | Specifies whether MailTips for external recipients are enabled. ||
|
||||
| **Ensure** | Write | String | |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
@ -8,7 +8,12 @@
|
|||
| **TimeZone** | Write | String | The name of the Time Zone to assign to the mailbox ||
|
||||
| **Locale** | Write | String | The code of the Locale to assign to the mailbox ||
|
||||
| **Ensure** | Write | String | Present ensures the Mailbox Settings are applied |Present|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
@ -26,7 +26,12 @@
|
|||
| **MakeDefault** | Write | Boolean | MakeDefault makes this malware filter policy the default policy. Valid values are: $true|$false. ||
|
||||
| **ZapEnabled** | Write | Boolean | The ZapEnabled parameter enables or disables zero-hour auto purge (ZAP) for malware. ZAP detects malware in unread messages that have already been delivered to the user's Inbox. Valid values are: $true|$false. ||
|
||||
| **Ensure** | Write | String | Specifies if this MalwareFilterPolicy should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOMalwareFilterPolicy
|
||||
|
||||
|
|
|
@ -16,7 +16,12 @@
|
|||
| **SentTo** | Write | StringArray[] | The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. ||
|
||||
| **SentToMemberOf** | Write | StringArray[] | The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. ||
|
||||
| **Ensure** | Write | String | Specifies if the Malware Filter Rule should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOMalwareFilterRule
|
||||
|
||||
|
|
|
@ -8,7 +8,12 @@
|
|||
| **Parent** | Write | String | The Parent parameter specifies the identity of the role to copy. ||
|
||||
| **Description** | Write | String | The Description parameter specifies the description that's displayed when the management role is viewed using the Get-ManagementRole cmdlet. ||
|
||||
| **Ensure** | Write | String | Specify if the Management Role should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOManagementRole
|
||||
|
||||
|
|
|
@ -60,7 +60,12 @@
|
|||
| **UNCAccessEnabled** | Write | Boolean | The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled from the mobile device. ||
|
||||
| **WSSAccessEnabled** | Write | Boolean | The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled from the mobile device. ||
|
||||
| **Ensure** | Write | String | Specify if the Mobile Device Mailbox Policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOMobileDeviceMailboxPolicy
|
||||
|
||||
|
|
|
@ -10,7 +10,12 @@
|
|||
| **DiffRetentionPeriod** | Write | String | The DiffRetentionPeriod parameter specifies the number of days that the OAB difference files are stored on the server. ||
|
||||
| **IsDefault** | Write | Boolean | The IsDefault parameter specifies whether the OAB is used by all mailboxes and mailbox databases that don't have an OAB specified. ||
|
||||
| **Ensure** | Write | String | Specify if the Offline Address Book should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOOfflineAddressBook
|
||||
|
||||
|
|
|
@ -13,7 +13,12 @@
|
|||
| **OrganizationRelationship** | Write | String | The OrganizationRelationship parameter specifies the organization relationship configured by the Hybrid Configuration wizard on the Office 365 tenant as part of a hybrid deployment with an on-premises Exchange organization. This organization relationship defines the federated sharing features enabled on the Office 365 tenant. ||
|
||||
| **Comment** | Write | String | The Comment parameter specifies an optional comment. ||
|
||||
| **Ensure** | Write | String | Specify if the On-Premises Organization should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOOnPremisesOrganization
|
||||
|
||||
|
|
|
@ -68,7 +68,12 @@
|
|||
| **VisibleMeetingUpdateProperties** | Write | String | The VisibleMeetingUpdateProperties parameter specifies whether meeting message updates will be auto-processed on behalf of attendees. Auto-processed updates are applied to the attendee's calendar item, and then the meeting message is moved to the deleted items. The attendee never sees the update in their inbox, but their calendar is updated. ||
|
||||
| **WebPushNotificationsDisabled** | Write | Boolean | The WebPushNotificationsDisabled parameter specifies whether to enable or disable Web Push Notifications in Outlook on the Web. This feature provides web push notifications which appear on a user's desktop while the user is not using Outlook on the Web. This brings awareness of incoming messages while they are working elsewhere on their computer. ||
|
||||
| **WebSuggestedRepliesDisabled** | Write | Boolean | The WebSuggestedRepliesDisabled parameter specifies whether to enable or disable Suggested Replies in Outlook on the web. This feature provides suggested replies to emails so users can easily and quickly respond to messages. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOOrganizationConfig
|
||||
|
||||
|
|
|
@ -23,7 +23,12 @@
|
|||
| **TargetOwaURL** | Write | String | The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook Web App) URL of the external organization that's defined in the organization relationship. It is used for Outlook on the web redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook on the web URL to access Outlook on the web in the external organization. ||
|
||||
| **TargetSharingEpr** | Write | String | The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization. ||
|
||||
| **Ensure** | Write | String | Specify if the OrganizationRelationship should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOOrganizationRelationship
|
||||
|
||||
|
|
|
@ -21,7 +21,12 @@
|
|||
| **TestMode** | Write | Boolean | The TestMode parameter specifies whether you want to enabled or disable test mode for the Outbound connector. Valid values are: $true | $false (default) ||
|
||||
| **ValidationRecipients** | Write | StringArray[] | The ValidationRecipients parameter specifies the email addresses of the validation recipients for the Outbound connector. You can specify multiple email addresses separated by commas. ||
|
||||
| **Ensure** | Write | String | Specifies if this Outbound connector should exist. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOOutboundConnector
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@
|
|||
| **LocalEventsEnabled** | Write | Boolean | The LocalEventsEnabled parameter specifies whether local events calendars are available in Outlook on the web. ||
|
||||
| **LogonAndErrorLanguage** | Write | SInt32 | The LogonAndErrorLanguage parameter specifies the language that used in Outlook on the web for forms-based authentication and for error messages when a user's current language setting can't be read. A valid value is a supported Microsoft Windows Language Code Identifier (LCID). For example, 1033 is US English. ||
|
||||
| **NotesEnabled** | Write | Boolean | The NotesEnabled parameter specifies whether the Notes folder is available in Outlook on the web. ||
|
||||
| **NpsMailboxPolicy** | Write | Boolean | The NPSMailboxPolicy parameter specifies whether to enable or disable the Net Promoter Score (NPS) survey in Outlook on the web. The survey allows uses to rate Outlook on the web on a scale of 1 to 5, and to provide feedback and suggested improvements in free text. ||
|
||||
| **NpsSurveysEnabled** | Write | Boolean | The NpsSurveysEnabled parameter specifies whether to enable or disable the Net Promoter Score (NPS) survey in Outlook on the web. The survey allows uses to rate Outlook on the web on a scale of 1 to 5, and to provide feedback and suggested improvements in free text. ||
|
||||
| **OrganizationEnabled** | Write | Boolean | When the OrganizationEnabled parameter is set to $false, the Automatic Reply option doesn't include external and internal options, the address book doesn't show the organization hierarchy, and the Resources tab in Calendar forms is disabled. ||
|
||||
| **OnSendAddinsEnabled** | Write | Boolean | The OnSendAddinsEnabled parameter specifies whether to enable or disable on send add-ins in Outlook on the web (add-ins that support events when a user clicks Send). ||
|
||||
| **OutboundCharset** | Write | String | The OutboundCharset parameter specifies the character set that's used for outgoing messages in Outlook on the web. |AutoDetect, AlwaysUTF8, UserLanguageChoice|
|
||||
|
@ -81,7 +81,12 @@
|
|||
| **WeatherEnabled** | Write | Boolean | The WeatherEnabled parameter specifies whether to enable or disable weather information in the calendar in Outlook on the web. ||
|
||||
| **WebPartsFrameOptionsType** | Write | String | The WebPartsFrameOptionsType parameter specifies what sources can access web parts in IFRAME or FRAME elements in Outlook on the web. |None, SameOrigin, Deny|
|
||||
| **Ensure** | Write | String | Specify if the OWA Mailbox Policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOOwaMailboxPolicy
|
||||
|
||||
|
|
|
@ -11,7 +11,12 @@
|
|||
| **Enabled** | Write | Boolean | The Enabled parameter specifies whether the partner application is enabled. ||
|
||||
| **LinkedAccount** | Write | String | The LinkedAccount parameter specifies a linked Active Directory user account for the application. ||
|
||||
| **Ensure** | Write | String | Specify if the Partner Application should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOPartnerApplication
|
||||
|
||||
|
|
|
@ -7,7 +7,12 @@
|
|||
| **Name** | Key | String | The Name parameter specifies the custom Policy Tip you want to modify. ||
|
||||
| **Value** | Write | String | The Value parameter specifies the text that's displayed by the Policy Tip. ||
|
||||
| **Ensure** | Write | String | Specify if the Policy Tip Config should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOPolicyTipConfig
|
||||
|
||||
|
|
|
@ -27,7 +27,12 @@
|
|||
| **TrustedMailInboundEnabled** | Write | Boolean | The TrustedMailInboundEnabled parameter specifies whether messages from senders in the remote domain are treated as trusted messages. ||
|
||||
| **TrustedMailOutboundEnabled** | Write | Boolean | The TrustedMailOutboundEnabled parameter specifies whether messages sent to recipients in the remote domain are treated as trusted messages. ||
|
||||
| **UseSimpleDisplayName** | Write | Boolean | The UseSimpleDisplayName parameter specifies whether the sender's simple display name is used for the From email address in messages sent to recipients in the remote domain. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXORemoteDomain
|
||||
|
||||
|
|
|
@ -9,7 +9,12 @@
|
|||
| **IsDefault** | Write | Boolean | The IsDefault switch makes the assignment policy the default assignment policy. ||
|
||||
| **Roles** | Write | StringArray[] | The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. ||
|
||||
| **Ensure** | Write | String | Specify if the Role Assignment Policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXORoleAssignmentPolicy
|
||||
|
||||
|
|
|
@ -12,7 +12,12 @@
|
|||
| **Redirect** | Write | Boolean | The Redirect parameter specifies whether to send detected malware attachments to another email address. Valid values are: $true: Malware attachments are sent to the email address specified by the RedirectAddress parameter. $false: Malware attachments aren't sent to another email address. This is the default value. ||
|
||||
| **RedirectAddress** | Write | String | The RedirectAddress parameter specifies the email address where detected malware attachments are sent when the Redirect parameter is set to the value $true. ||
|
||||
| **Ensure** | Write | String | Specify if this policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOSafeAttachmentPolicy
|
||||
|
||||
|
|
|
@ -16,7 +16,12 @@
|
|||
| **SentTo** | Write | StringArray[] | The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. ||
|
||||
| **SentToMemberOf** | Write | StringArray[] | The SentToMemberOf parameter looks for messages sent to members of groups. You can use any value that uniquely identifies the group. ||
|
||||
| **Ensure** | Write | String | Specify if this rule should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOSafeAttachmentRule
|
||||
|
||||
|
|
|
@ -13,7 +13,12 @@
|
|||
| **EnableForInternalSenders** | Write | Boolean | EnableForInternalSenders $true or $false ||
|
||||
| **IsEnabled** | Write | Boolean | This parameter specifies whether the rule or policy is enabled. ||
|
||||
| **ScanUrls** | Write | Boolean | The ScanUrls parameter specifies whether to enable or disable the scanning of links in email messages. Valid values are: $true: Scanning links in email messages is enabled. $false: Scanning links in email messages is disabled. This is the default value. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOSafeLinksPolicy
|
||||
|
||||
|
|
|
@ -16,7 +16,12 @@
|
|||
| **RecipientDomainIs** | Write | StringArray[] | The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. ||
|
||||
| **SentTo** | Write | StringArray[] | The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. ||
|
||||
| **SentToMemberOf** | Write | StringArray[] | The SentToMemberOf parameter looks for messages sent to members of groups. You can use any value that uniquely identifies the group. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOSafeLinksRule
|
||||
|
||||
|
|
|
@ -8,7 +8,12 @@
|
|||
| **PrimarySMTPAddress** | Write | String | The primary email address of the Shared Mailbox ||
|
||||
| **Aliases** | Write | StringArray[] | Aliases for the Shared Mailbox ||
|
||||
| **Ensure** | Write | String | Present ensures the group exists, absent ensures it is removed |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
@ -9,7 +9,12 @@
|
|||
| **Enabled** | Write | Boolean | The Enabled parameter specifies whether to enable the sharing policy. Valid values for this parameter are $true or $false. ||
|
||||
| **Domains** | Write | StringArray[] | The Domains parameter specifies domains to which this policy applies and the sharing policy action. ||
|
||||
| **Ensure** | Write | String | Specify if the Sharing Policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# EXOSharingPolicy
|
||||
|
||||
|
|
|
@ -7,7 +7,12 @@
|
|||
| **IsSingleInstance** | Key | String | Specifies the resource is a single instance, the value must be 'Yes' |Yes|
|
||||
| **Ensure** | Write | String | 'Present' is the only value accepted. |Present|
|
||||
| **UnifiedAuditLogIngestionEnabled** | Required | String | Determins if Unified Audit Log Ingestion is enabled |Enabled, Disabled|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# O365AdminAuditLogConfig
|
||||
|
||||
|
|
|
@ -10,7 +10,12 @@
|
|||
| **Description** | Write | String | The group's description. ||
|
||||
| **Members** | Write | StringArray[] | Members of the group. ||
|
||||
| **Ensure** | Write | String | Present ensures the group exists, absent ensures it is removed. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
@ -6,7 +6,12 @@
|
|||
| --- | --- | --- | --- | --- |
|
||||
| **IsSingleInstance** | Key | String | Specifies the resource is a single instance, the value must be 'Yes' |Yes|
|
||||
| **Ensure** | Write | String | Since there is only one setting availble, this must be set to 'Present' |Present|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Exchange Global Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
# O365OrgCustomizationSetting
|
||||
|
||||
|
|
|
@ -27,7 +27,12 @@
|
|||
| **Title** | Write | String | Specifies the title of the user ||
|
||||
| **UserType** | Write | String | Specifies the title of the user |Guest, Member, Other, Viral|
|
||||
| **Ensure** | Write | String | Present ensures the user exists, absent ensures it is removed |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Exchange Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
@ -18,7 +18,12 @@
|
|||
| **ExcludedFileExtensions** | Write | StringArray[] | Exclude files from being synced to OneDrive ||
|
||||
| **GrooveBlockOption** | Write | String | Groove block options |OptOut, HardOptIn, SoftOptIn|
|
||||
| **Ensure** | Write | String | Present ensures the user exists, absent ensures it is removed |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# ODSettings
|
||||
|
||||
|
@ -27,6 +32,19 @@
|
|||
This resource allows admins to manage blocked file types,
|
||||
blocked domains and MAC Sync.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -8,7 +8,10 @@
|
|||
| **Location** | Required | String | Location of the PowerApps environment. |canada, unitedstates, europe, asia, australia, india, japan, unitedkingdom, unitedstatesfirstrelease, southamerica, france, usgov|
|
||||
| **EnvironmentSKU** | Required | String | Environment type. |Production, Standard, Trial, Sandbox|
|
||||
| **Ensure** | Write | String | Only accepted value is 'Present'. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Azure Active Directory Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Azure Active Directory Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# PPPowerAppsEnvironment
|
||||
|
|
|
@ -0,0 +1,47 @@
|
|||
# PlannerBucket
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Attribute | DataType | Description | Allowed Values |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| **Name** | Key | String | The Name of the Planner Bucket. ||
|
||||
| **PlanId** | Key | String | Id of the Plan to which the bucket is associated with. ||
|
||||
| **BucketId** | Write | String | Id of the Bucket, if known. ||
|
||||
| **Ensure** | Write | String | Present ensures the Plan exists, absent ensures it is removed |Present, Absent|
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
|
||||
This resource is used to configure the Planner Buckets.
|
||||
|
||||
* This resource deals with content. Using the Monitoring feature
|
||||
of Microsoft365DSC on content resources is not recommended.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
||||
This example creates a new Planner Bucket in a Plan.
|
||||
|
||||
```powershell
|
||||
Configuration Example
|
||||
{
|
||||
Import-DscResource -ModuleName Microsoft365DSC
|
||||
|
||||
node localhost
|
||||
{
|
||||
PlannerBucket ContosoBucket
|
||||
{
|
||||
PlanId = "1234567890"
|
||||
Name = "Contoso Bucket"
|
||||
Ensure = "Present"
|
||||
ApplicationId = "12345-12345-12345-12345-12345"
|
||||
TenantId = "12345-12345-12345-12345-12345"
|
||||
CertificateThumbprint = "1234567890"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
# PlannerPlan
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Attribute | DataType | Description | Allowed Values |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| **Title** | Key | String | The Title of the Planner Plan. ||
|
||||
| **OwnerGroup** | Key | String | Name of Id of the Azure Active Directory Group who owns the plan ||
|
||||
| **Ensure** | Write | String | Present ensures the Plan exists, absent ensures it is removed |Present, Absent|
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
|
||||
This resource is used to configure the Planner Plans.
|
||||
|
||||
* This resource deals with content. Using the Monitoring feature
|
||||
of Microsoft365DSC on content resources is not recommended.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
||||
This example creates a new Plan in Planner.
|
||||
|
||||
```powershell
|
||||
Configuration Example
|
||||
{
|
||||
Import-DscResource -ModuleName Microsoft365DSC
|
||||
|
||||
node localhost
|
||||
{
|
||||
PlannerPlan ContosoPlan
|
||||
{
|
||||
Title = "Contoso Plan"
|
||||
OwnerGroup = "Contoso Group"
|
||||
Ensure = "Present"
|
||||
ApplicationId = "12345-12345-12345-12345-12345"
|
||||
TenantId = "12345-12345-12345-12345-12345"
|
||||
CertificateThumbprint = "1234567890"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
# PlannerTask
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Attribute | DataType | Description | Allowed Values |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| **Alias** | Write | String | Alias of for the attachment. ||
|
||||
| **Uri** | Write | String | Uri of the link to the attachment. ||
|
||||
| **Type** | Write | String | Type of attachment. |PowerPoint, Word, Excel, Other|
|
||||
| **Title** | Write | String | Title of the checklist item. ||
|
||||
| **Completed** | Write | String | True if the item is completed, false otherwise. ||
|
||||
| **PlanId** | Key | String | Id of the Planner Plan which contains the Task. ||
|
||||
| **Title** | Key | String | The Title of the Planner Task. ||
|
||||
| **Categories** | Write | StringArray[] | List of categories assigned to the task. |Pink, Red, Yellow, Green, Blue, Purple|
|
||||
| **AssignedUsers** | Write | StringArray[] | List of users assigned to the tasks (ex: @('john.smith@contoso.com', 'bob.houle@contoso.com')). ||
|
||||
| **Attachments** | Write | InstanceArray[] | List of links to attachments assigned to the task. ||
|
||||
| **Checklist** | Write | InstanceArray[] | List checklist items associated with the task. ||
|
||||
| **Notes** | Write | String | Description of the Task. ||
|
||||
| **Bucket** | Write | String | The Id of the bucket that contains the task. ||
|
||||
| **TaskId** | Write | String | Id of the Task, if known. ||
|
||||
| **StartDateTime** | Write | String | Date and Time for the start of the Task. ||
|
||||
| **DueDateTime** | Write | String | Date and Time for the task is due for completion. ||
|
||||
| **PercentComplete** | Write | UInt32 | Percentage completed of the Task. Value can only be between 0 and 100. ||
|
||||
| **Priority** | Write | UInt32 | Priority of the Task. Value can only be between 1 and 10. ||
|
||||
| **ConversationThreadId** | Write | String | Id of the group conversation thread associated with the comments section for this task. ||
|
||||
| **Ensure** | Write | String | Present ensures the Plan exists, absent ensures it is removed |Present, Absent|
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Global Admin ||
|
||||
|
||||
## Description
|
||||
|
||||
This resource is used to configure the Planner Tasks.
|
||||
|
||||
* This resource deals with content. Using the Monitoring feature
|
||||
of Microsoft365DSC on content resources is not recommended.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
||||
This example creates a new Planner Task in a Plan.
|
||||
|
||||
```powershell
|
||||
Configuration Example
|
||||
{
|
||||
Import-DscResource -ModuleName Microsoft365DSC
|
||||
|
||||
node localhost
|
||||
{
|
||||
PlannerTask ContosoTask
|
||||
{
|
||||
PlanId = "1234567890"
|
||||
Title = "Contoso Task"
|
||||
StartDateTime = "2020-06-09"
|
||||
Priority = 7
|
||||
PercentComplete = 75
|
||||
Ensure = "Present"
|
||||
ApplicationId = "12345-12345-12345-12345-12345"
|
||||
TenantId = "12345-12345-12345-12345-12345"
|
||||
CertificateThumbprint = "1234567890"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -17,7 +17,12 @@
|
|||
| **EmailAttestationRequired** | Write | Boolean | Sets email attestation to required ||
|
||||
| **EmailAttestationReAuthDays** | Write | UInt32 | Sets email attestation re-auth days ||
|
||||
| **Ensure** | Write | String | Only value accepted is 'Present' |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# SPO Access Control Settings
|
||||
|
@ -25,6 +30,19 @@
|
|||
This resource allows users to configure and monitor the access control settings for
|
||||
your SPO tenant sharing settings.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
20
SPOApp.md
20
SPOApp.md
|
@ -9,13 +9,31 @@
|
|||
| **Publish** | Write | Boolean | This will deploy/trust an app into the app catalog. ||
|
||||
| **Overwrite** | Write | Boolean | Overwrites the existing app package if it already exists. ||
|
||||
| **Ensure** | Write | String | Present ensures the site collection exists, absent ensures it is removed |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
|
||||
This resource allows users to deploy App instances in the
|
||||
App Catalog.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -7,7 +7,12 @@
|
|||
| **IsSingleInstance** | Key | String | Specifies the resource is a single instance, the value must be 'Yes' |Yes|
|
||||
| **Url** | Write | String | The URL of the home site collection ||
|
||||
| **Ensure** | Write | String | Present ensures the site collection is registered as home site, absent ensures it is unregistered |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
@ -21,6 +26,19 @@ SharePoint Home.
|
|||
> test run can lead to incorrect status results.
|
||||
> For more details about setting the home site, go to> aka.ms/homesites
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -12,9 +12,14 @@
|
|||
| **AllowedToJoin** | Write | StringArray[] | The users or mail-enabled security groups which are allowed to associate their site with a hub site ||
|
||||
| **SiteDesignId** | Write | String | The guid of the site design to link to the hub site ||
|
||||
| **Ensure** | Write | String | Present ensures the site collection is registered as hub site, absent ensures it is unregistered |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
# SPO Hub Site
|
||||
|
||||
This resource allows users to configure a Site Collection as Hub Site
|
||||
Collection and configure its properties.
|
||||
|
@ -26,6 +31,19 @@ Security groups). However, when using DisplayName it is required that
|
|||
there is only one group with that name. The resource will throw an
|
||||
exception if there are multiple groups with that name found!
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -9,6 +9,11 @@
|
|||
| **ThumbnailUrl** | Write | String | Indicates the absolute URL of the library to be designated as a central location for organization Indicates the URL of the background image used when the library is publicly displayed. If no thumbnail URL is indicated, the card will have a gray background. ||
|
||||
| **Ensure** | Write | String | Specify if the SPO Org Assets library should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# SPOOrgAssetsLibrary
|
||||
|
||||
|
@ -16,6 +21,18 @@
|
|||
|
||||
This resource configures an SharePoint Online Org site assets library.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
@ -8,7 +8,12 @@
|
|||
| **Key** | Key | String | Key that should be configured. ||
|
||||
| **Value** | Key | String | Value of the assigned key. ||
|
||||
| **Ensure** | Write | String | Specify if this policy should exist or not. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# SPOPropertyBag
|
||||
|
||||
|
@ -16,6 +21,19 @@
|
|||
|
||||
Configures a value in a site's property bag.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -24,7 +24,12 @@
|
|||
| **MappedCrawledProperties** | Write | StringArray[] | Names of the crawled properties that are mapped to this managed property ||
|
||||
| **CompanyNameExtraction** | Write | Boolean | Enables the system to extract company name entities from the managed property when crawling new or updated items. Afterwards, the extracted entities can be used to set up refiners in the web part. ||
|
||||
| **Ensure** | Write | String | Present ensures the Search Managed Property exists. |Present|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
@ -13,7 +13,12 @@
|
|||
| **ShowPartialSearch** | Write | Boolean | Show partial search or not ||
|
||||
| **UseAutoDiscover** | Write | Boolean | Specifies if AutoDiscover should be used for the Exchange Source URL ||
|
||||
| **Ensure** | Write | String | Present ensures the Search Result Source exists. |Present|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
@ -26,7 +26,12 @@
|
|||
| **DefaultLinkPermission** | Write | String | Specifies the link permission on the tenant level. |None, View, Edit|
|
||||
| **RequireAcceptingAccountMatchInvitedAccount** | Write | Boolean | Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address.Administrators who desire increased control over external collaborators should consider enabling this feature. False (default) - When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail.True - User must accept this invitation with bob@contoso.com. ||
|
||||
| **Ensure** | Write | String | Only accepted value is 'Present'. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# SPO Sharing Settings
|
||||
|
|
20
SPOSite.md
20
SPOSite.md
|
@ -31,12 +31,30 @@
|
|||
| **SocialBarOnSitePagesDisabled** | Write | Boolean | Disables or enables the Social Bar for Site Collection. ||
|
||||
| **OverrideTenantAnonymousLinkExpirationPolicy** | Write | Boolean | False - Respect the organization-level policy for anonymous or anyone link expiration. True - Override the organization-level policy for anonymous or anyone link expiration (can be more or less restrictive) ||
|
||||
| **Ensure** | Write | String | Present ensures the site collection exists, absent ensures it is removed |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
## Description
|
||||
|
||||
This resource allows users to create and monitor SharePoint Online Site Collections.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -6,13 +6,32 @@
|
|||
| --- | --- | --- | --- | --- |
|
||||
| **Url** | Key | String | URL of the site collection to configure. ||
|
||||
| **AuditFlags** | Required | String | Audit flag for the site collection. Can be 'All' or 'None'. |All, None|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# SPOSiteAuditSettings
|
||||
|
||||
Set Audit settings for a site.
|
||||
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -13,7 +13,12 @@
|
|||
| **PreviewImageUrl** | Write | String | Site design preview image url. ||
|
||||
| **Version** | Write | UInt32 | Site design version number. ||
|
||||
| **Ensure** | Write | String | Used to add or remove site design. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# SPOSiteDesign
|
||||
|
||||
|
@ -21,6 +26,20 @@
|
|||
|
||||
This resource configures Site Designs.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -8,7 +8,12 @@
|
|||
| **Rights** | Key | String | Rights to grant user principals on site design rights. |View, None|
|
||||
| **UserPrincipals** | Write | StringArray[] | List of user principals with seperated by commas to site design rights. ||
|
||||
| **Ensure** | Write | String | Used to add or remove list of users from site design rights. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# SPOSiteDesignRights
|
||||
|
||||
|
@ -16,6 +21,19 @@
|
|||
|
||||
This resource configures rights on Site Designs.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -9,13 +9,31 @@
|
|||
| **Owner** | Write | String | The owner (email address) of the site group ||
|
||||
| **PermissionLevels** | Write | StringArray[] | The permission level of the site group ||
|
||||
| **Ensure** | Write | String | Used to add or remove site design. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# SPOSiteGroup
|
||||
|
||||
Configure groups for a SharePoint Online site.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -11,7 +11,12 @@
|
|||
| **Comment** | Write | String | Comment for the storage entity. ||
|
||||
| **Ensure** | Write | String | Used to add or remove storage entity. |Present, Absent|
|
||||
| **SiteUrl** | Required | String | The url of site collection or tenant. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# SPOStorageEntity
|
||||
|
||||
|
@ -19,6 +24,19 @@
|
|||
|
||||
This resource configures Storage Entity for SharePoint Online.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -7,7 +7,12 @@
|
|||
| **CDNType** | Key | String | Type of Content Delivery Network. Can be 'Private' or 'Public'. |Private, Public|
|
||||
| **ExcludeRestrictedSiteClassifications** | Write | StringArray[] | List of site classifications to exclude. ||
|
||||
| **IncludeFileExtensions** | Write | StringArray[] | List of file extensions to include in the Policy. ||
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the Office365 Tenant Admin. ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# SPOTenantCdnPolicy
|
||||
|
||||
|
@ -16,6 +21,19 @@
|
|||
This resource configures Content Delivery Network policies
|
||||
for SharePoint Online.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -8,6 +8,11 @@
|
|||
| **Enable** | Write | Boolean | Specify to enable or disable tenant CDN. ||
|
||||
| **Ensure** | Write | String | Get-PNPTenantCdnEnabled always returns a value, only support value is Present |Present|
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
# SPOTenantCdnEnabled
|
||||
|
||||
|
@ -15,6 +20,19 @@
|
|||
|
||||
This resource enables / disables SharePoint online CDN
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
@ -23,7 +23,12 @@
|
|||
| **FilePickerExternalImageSearchEnabled** | Write | Boolean | ||
|
||||
| **HideDefaultThemes** | Write | Boolean | Defines if the default themes are visible or hidden ||
|
||||
| **Ensure** | Write | String | Only accepted value is 'Present'. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# SPO Tenant Settings
|
||||
|
@ -31,6 +36,20 @@
|
|||
This resource allows users to configure and monitor the tenant settings for
|
||||
their SPO tenant settings.
|
||||
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
22
SPOTheme.md
22
SPOTheme.md
|
@ -10,7 +10,12 @@
|
|||
| **IsInverted** | Write | Boolean | This value should be false for light themes and true for dark themes; it controls whether SharePoint uses dark or light theme colors to render text on colored backgrounds. ||
|
||||
| **Palette** | Write | InstanceArray[] | Specifies the color scheme which composes your theme. ||
|
||||
| **Ensure** | Write | String | Only accepted value is 'Present'. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **GlobalAdminAccount** | Write | PSCredential | Credentials of the SharePoint Global Admin ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificatePassword** | Write | PSCredential | Username can be made up to anything but password will be used for certificatePassword ||
|
||||
| **CertificatePath** | Write | String | Path to certificate used in service principal usually a PFX file. ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# SPO Theme
|
||||
|
@ -33,6 +38,21 @@ the JSON Output and put it directly into your configuration.
|
|||
More details on the theme schema can be found
|
||||
[here](https://aka.ms/AboutSPOThemes)
|
||||
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -10,6 +10,9 @@
|
|||
| **Properties** | Write | InstanceArray[] | Array of MSFT_SPOUserProfilePropertyInstance representing the profile properties to set. ||
|
||||
| **Ensure** | Write | String | Only accepted value is 'Present'. |Present|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Global Admin. ||
|
||||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. ||
|
||||
| **TenantId** | Write | String | Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com ||
|
||||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. ||
|
||||
|
||||
|
||||
# SPOUserProfileProperty
|
||||
|
@ -17,6 +20,19 @@
|
|||
This resource allows users to configure and monitor the profile
|
||||
properties of a user.
|
||||
|
||||
## Azure AD Permissions
|
||||
|
||||
To authenticate via Azure Active Directory, this resource required the following Application permissions:
|
||||
|
||||
* **Automate**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
* **Export**
|
||||
* SharePoint
|
||||
* Sites.FullControl.All
|
||||
|
||||
NOTE: All permisions listed above require admin consent.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
|
|
@ -0,0 +1,43 @@
|
|||
# TeamsPstnUsage
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Attribute | DataType | Description | Allowed Values |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| **Usage** | Key | String | An online PSTN usage (such as Local or Long Distance) that can be used in conjunction with voice routes and voice routing policies. ||
|
||||
| **Ensure** | Write | String | Present ensures the policyexists, absent ensures it is removed. |Present, Absent|
|
||||
| **GlobalAdminAccount** | Required | PSCredential | Credentials of the Teams Global Admin ||
|
||||
|
||||
|
||||
# TeamsPstnUsage
|
||||
|
||||
This resource configures a Teams PSTN Usage.
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
|
||||
This example adds a new Teams PSTN Usage.
|
||||
|
||||
```powershell
|
||||
Configuration Example
|
||||
{
|
||||
param(
|
||||
[Parameter(Mandatory = $true)]
|
||||
[PSCredential]
|
||||
$credsGlobalAdmin
|
||||
)
|
||||
Import-DscResource -ModuleName Microsoft365DSC
|
||||
|
||||
node localhost
|
||||
{
|
||||
TeamsPstnUsage PstnUsage
|
||||
{
|
||||
Usage = 'Long Distance'
|
||||
Ensure = 'Present'
|
||||
GlobalAdminAccount = $credsGlobalAdmin
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
Загрузка…
Ссылка в новой задаче