O365OrgCustomizationSetting¶
Parameters¶
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
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 |
Credential | Write | PSCredential | Credentials of the 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. | |
AccessTokens | Write | StringArray[] | Access token used for authentication. |
Description¶
This resource configures the tenant settings so that the tenant runs in a fully
configurable mode. Usually tenants are created in a mode, that limits options to
customize the tenant. This setting is reflected by the Organization Config proptery
IsDehydrated: True
.
Running this resource will set the property to false.
Currently there is no setting available to undo Enable-OrganizationCustomization.
Permissions¶
Exchange¶
To authenticate with Microsoft Exchange, this resource required the following permissions:
Roles¶
- Organization Configuration
Role Groups¶
- None
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.
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$Credscredential
)
Import-DscResource -ModuleName Microsoft365DSC
node localhost
{
O365OrgCustomizationSetting 'O365OrgCustomizationSetting'
{
IsSingleInstance = "Yes"
Ensure = "Present"
Credential = $Credscredential
}
}
}