TeamsTenantNetworkSite¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Identity | Key | String | Unique identifier for the network site to be created. | |
| Description | Write | String | Provide a description of the network site to identify purpose of creating it. | |
| EmergencyCallingPolicy | Write | String | This parameter is used to assign a custom emergency calling policy to a network site | |
| EmergencyCallRoutingPolicy | Write | String | This parameter is used to assign a custom emergency call routing policy to a network site | |
| EnableLocationBasedRouting | Write | Boolean | This parameter determines whether the current site is enabled for location based routing. | |
| LocationPolicy | Write | String | LocationPolicy is the identifier for the location policy which the current network site is associating to. | |
| NetworkRegionID | Write | String | NetworkRegionID is the identifier for the network region which the current network site is associating to. | |
| NetworkRoamingPolicy | Write | String | NetworkRoamingPolicy is the identifier for the network roaming policy to which the network site will associate to. | |
| 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. | |
| 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¶
This resource configures a Teams Tenant Network Site. Network sites are defined as a collection of IP subnets. Each network site must be associated with a network region. Tenant network site is used for Location Based Routing.
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
{
TeamsTenantNetworkSite 'TeamsTenantNetworkSite-Example'
{
Description = "Amsterdam office network site";
EmergencyCallingPolicy = "Headquarters Emergency Calling Policy";
EmergencyCallRoutingPolicy = "Amsterdam Office";
EnableLocationBasedRouting = $false;
Ensure = "Present";
Identity = "Amsterdam";
NetworkRegionID = "Europe";
NetworkRoamingPolicy = "Amsterdam Roaming";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}
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()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
TeamsTenantNetworkSite 'TeamsTenantNetworkSite-Example'
{
Description = "Amsterdam head office network site"; # Updated Property
EmergencyCallingPolicy = "Headquarters Emergency Calling Policy";
EmergencyCallRoutingPolicy = "Amsterdam Office";
EnableLocationBasedRouting = $false;
Ensure = "Present";
Identity = "Amsterdam";
NetworkRegionID = "Europe";
NetworkRoamingPolicy = "Amsterdam Roaming";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}
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()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
TeamsTenantNetworkSite 'TeamsTenantNetworkSite-Example'
{
Ensure = "Absent";
Identity = "Amsterdam";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}