AADFilteringPolicy¶
Parameters¶
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name | Key | String | Name of the policy. | |
Id | Write | String | Unique identifier of the policy. | |
Description | Write | String | Description for the policy. | |
Action | Write | String | Action associated with the policy. | |
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. | |
ManagedIdentity | Write | Boolean | Managed ID being used for authentication. | |
AccessTokens | Write | StringArray[] | Access token used for authentication. |
Description¶
Configures filtering policies in Entra Id.
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
- NetworkAccess.Read.All
-
Update
- NetworkAccess.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
{
AADFilteringPolicy "AADFilteringPolicy-MyPolicy"
{
Action = "block";
ApplicationId = $ApplicationId;
CertificateThumbprint = $CertificateThumbprint;
Description = "This is a demo policy";
Ensure = "Present";
Name = "MyPolicy";
TenantId = $TenantId;
}
}
}
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
{
AADFilteringPolicy "AADFilteringPolicy-MyPolicy"
{
Action = "allow"; #drift
ApplicationId = $ApplicationId;
CertificateThumbprint = $CertificateThumbprint;
Description = "This is a demo policy";
Ensure = "Present";
Name = "MyPolicy";
TenantId = $TenantId;
}
}
}
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
{
AADFilteringPolicy "AADFilteringPolicy-MyPolicy"
{
Action = "block";
ApplicationId = $ApplicationId;
CertificateThumbprint = $CertificateThumbprint;
Description = "This is a demo policy";
Ensure = "Absent";
Name = "MyPolicy";
TenantId = $TenantId;
}
}
}