TeamsApplicationInstance¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| DisplayName | Required | String | The display name of the resource instance. | |
| UserPrincipalName | Key | String | The user principal name associated with the resource instance. | |
| ResourceAccountType | Write | String | The type of resource account. Values can be: AutoAttendant or CallQueue. | AutoAttendant, CallQueue |
| Ensure | Write | String | Present ensures the instance exists, absent ensures it is removed. | Absent, Present |
| 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. | |
| 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. |
Description¶
Manages Teams Resource Accounts.
Please note: Microsoft Teams doesn't offer any cmdlet to delete a resource account. Remove the underlying account through Entra ID.
Permissions¶
Microsoft Entra ID roles¶
This resource requires the following Microsoft Entra ID roles:
- Read
- Teams Reader
- Update
- Teams Administrator
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
{
TeamsApplicationInstance "TeamsApplicationInstance-Example"
{
DisplayName = "After Hours Line";
Ensure = "Present";
ResourceAccountType = "AutoAttendant";
UserPrincipalName = "afterhours@$TenantId";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}