EXOGlobalAddressList¶
Parameters¶
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name | Key | String | The Name parameter specifies the unique name of the GAL. The maximum length is 64 characters. | |
ConditionalCompany | Write | StringArray[] | The ConditionalCompany parameter specifies a precanned filter that's based on the value of the recipient's Company property. | |
ConditionalCustomAttribute1 | Write | StringArray[] | The ConditionalCustomAttribute1 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute1 property. | |
ConditionalCustomAttribute10 | Write | StringArray[] | The ConditionalCustomAttribute10 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute10 property. | |
ConditionalCustomAttribute11 | Write | StringArray[] | The ConditionalCustomAttribute11 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute11 property. | |
ConditionalCustomAttribute12 | Write | StringArray[] | The ConditionalCustomAttribute12 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute12 property. | |
ConditionalCustomAttribute13 | Write | StringArray[] | The ConditionalCustomAttribute13 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute13 property. | |
ConditionalCustomAttribute14 | Write | StringArray[] | The ConditionalCustomAttribute14 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute14 property. | |
ConditionalCustomAttribute15 | Write | StringArray[] | The ConditionalCustomAttribute15 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute15 property. | |
ConditionalCustomAttribute2 | Write | StringArray[] | The ConditionalCustomAttribute2 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute2 property. | |
ConditionalCustomAttribute3 | Write | StringArray[] | The ConditionalCustomAttribute3 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute3 property. | |
ConditionalCustomAttribute4 | Write | StringArray[] | The ConditionalCustomAttribute4 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute4 property. | |
ConditionalCustomAttribute5 | Write | StringArray[] | The ConditionalCustomAttribute5 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute5 property. | |
ConditionalCustomAttribute6 | Write | StringArray[] | The ConditionalCustomAttribute6 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute6 property. | |
ConditionalCustomAttribute7 | Write | StringArray[] | The ConditionalCustomAttribute7 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute7 property. | |
ConditionalCustomAttribute8 | Write | StringArray[] | The ConditionalCustomAttribute8 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute8 property. | |
ConditionalCustomAttribute9 | Write | StringArray[] | The ConditionalCustomAttribute9 parameter specifies a precanned filter that's based on the value of the recipient's CustomAttribute9 property. | |
ConditionalDepartment | Write | StringArray[] | The ConditionalDepartment parameter specifies a precanned filter that's based on the value of the recipient's Department property. | |
ConditionalStateOrProvince | Write | StringArray[] | The ConditionalStateOrProvince parameter specifies a precanned filter that's based on the value of the recipient's StateOrProvince property. | |
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 |
Credential | 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¶
Description¶
This resource configures Global Address Lists in Exchange Online.
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]
$credsGlobalAdmin
)
Import-DscResource -ModuleName Microsoft365DSC
node localhost
{
EXOGlobalAddressList 'ConfigureGlobalAddressList'
{
Name = "Contoso Human Resources in Washington"
ConditionalCompany = "Contoso"
ConditionalDepartment = "Human Resources"
ConditionalStateOrProvince = "Washington"
Ensure = "Present"
Credential = $credsGlobalAdmin
}
}
}