AADTenantDetails¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| IsSingleInstance | Key | String | Only valid value is 'Yes'. | Yes |
| BusinessPhones | Write | String[] | Telephone number for the organization. Although this property is a string collection, only one number can be set. | |
| City | Write | String | City name of the address for the organization. | |
| MarketingNotificationEmails | Write | String[] | Email-addresses from the people who should receive Marketing Notifications | |
| PostalCode | Write | String | Postal code of the address for the organization. | |
| PreferredLanguage | Write | String | The preferred language for the organization. Should follow ISO 639-1 code, for example, en. | |
| PrivacyProfile | Write | MSFT_privacyProfile | The privacy profile of an organization. | |
| SecurityComplianceNotificationMails | Write | String[] | Email-addresses from the people who should receive Security Compliance Notifications | |
| SecurityComplianceNotificationPhones | Write | String[] | Phone Numbers from the people who should receive Security Notifications | |
| State | Write | String | State name of the address for the organization. | |
| Street | Write | String | Street name of the address for organization. | |
| TechnicalNotificationMails | Write | String[] | Email-addresses from the people who should receive Technical Notifications | |
| Credential | Write | PSCredential | Credentials of the Azure Active Directory 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. | |
| ApplicationSecret | Write | PSCredential | Secret of the Azure Active Directory application to authenticate with. | |
| 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. | |
| ManagedIdentity | Write | Boolean | Managed ID being used for authentication. | |
| AccessTokens | Write | String[] | Access token used for authentication. |
Embedded Instances¶
MSFT_privacyProfile¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| ContactEmail | Write | String | A valid smtp email address for the privacy statement contact. Not required. | |
| StatementUrl | Write | String | A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required. |
Description¶
This resource configures the Azure AD Tenant Details
Permissions¶
Graph¶
To authenticate with the Graph API, this resource requires the following permissions:
Delegated permissions¶
- Read
-
Organization.Read.All
-
Update
- Organization.ReadWrite.All
Application permissions¶
- Read
-
Organization.Read.All
-
Update
- Organization.ReadWrite.All
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()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node Localhost
{
AADTenantDetails 'AADTenantDetails-Example'
{
IsSingleInstance = 'Yes'
TechnicalNotificationMails = "it-operations@contoso.com"
MarketingNotificationEmails = "marketing@contoso.com"
SecurityComplianceNotificationMails = @("security@contoso.com", "compliance@contoso.com")
SecurityComplianceNotificationPhones = @("+1 425 555 0101")
BusinessPhones = @("+1 425 555 0100")
Street = "1 Contoso Plaza"
City = "Redmond"
State = "WA"
PostalCode = "98052"
PreferredLanguage = "en"
PrivacyProfile = MSFT_privacyProfile{
ContactEmail = "privacy@contoso.com"
StatementUrl = "https://www.contoso.com/privacy"
};
ApplicationId = $ApplicationId
TenantId = $TenantId
CertificateThumbprint = $CertificateThumbprint
}
}
}