TeamsAIPolicy¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Identity | Key | String | Unique identity of the AI Policy. | |
| Description | Write | String | Provides explanatory text about the Teams AI policy. | |
| EnrollFace | Write | String | EnrollFace controls user access to user face enrollment in the Teams app settings. | Enabled, Disabled |
| EnrollVoice | Write | String | EnrollVoice controls user access to user voice enrollment in the Teams app settings. | Enabled, Disabled |
| SpeakerAttributionForBYOD | Write | String | Setting to Enabled turns on speaker attribution in BYOD scenarios while Disabled will turn off the function. | Enabled, Disabled |
| Ensure | Write | String | Present ensures the instance exists, absent ensures it is removed. | Present, Absent |
| Credential | Write | PSCredential | Credentials of the workload's 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. | |
| ManagedIdentity | Write | Boolean | Managed ID being used for authentication. | |
| AccessTokens | Write | StringArray[] | Access token used for authentication. |
Description¶
This resource implements Teams AI Policies.
Permissions¶
Microsoft Graph¶
To authenticate with the Microsoft Graph API, this resource required the following permissions:
Delegated permissions¶
-
Read
- None
-
Update
- None
Application permissions¶
-
Read
- Organization.Read.All
-
Update
- Organization.Read.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(Mandatory = $true)]
[PSCredential]
$Credscredential
)
Import-DscResource -ModuleName Microsoft365DSC
node localhost
{
TeamsAIPolicy "TeamsAIPolicy-AIEnabled"
{
ApplicationId = $ConfigurationData.NonNodeData.ApplicationId;
CertificateThumbprint = $ConfigurationData.NonNodeData.CertificateThumbprint;
Description = "Teams AI Policy with all AI Features enabled.";
EnrollFace = "Enabled";
EnrollVoice = "Enabled";
Ensure = "Present";
Identity = "AIEnabled";
SpeakerAttributionForBYOD = "Enabled";
TenantId = $OrganizationName;
}
}
}
Example 2¶
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
{
TeamsAIPolicy "TeamsAIPolicy-AIEnabled"
{
ApplicationId = $ConfigurationData.NonNodeData.ApplicationId;
CertificateThumbprint = $ConfigurationData.NonNodeData.CertificateThumbprint;
Description = "Teams AI Policy with some AI Features enabled."; # Updated Property
EnrollFace = "Disabled"; # Updated Property
EnrollVoice = "Enabled";
Ensure = "Present";
Identity = "AIEnabled";
SpeakerAttributionForBYOD = "Enabled";
TenantId = $OrganizationName;
}
}
}
Example 3¶
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
{
TeamsAIPolicy "TeamsAIPolicy-AIEnabled"
{
ApplicationId = $ConfigurationData.NonNodeData.ApplicationId;
CertificateThumbprint = $ConfigurationData.NonNodeData.CertificateThumbprint;
Ensure = "Absent";
Identity = "AIEnabled";
TenantId = $OrganizationName;
}
}
}