AzureFileSyncDsc

AzureFileSyncDsc is a PowerShell DSC resource module for managing different aspects within the Azure File Sync service, such as installing and registering agents, as well as adding server endpoints.

This project has adopted this code of conduct.

Branches

master

This is the branch containing the latest release - no contributions should be made directly to this branch.

dev

This is the development branch to which contributions should be proposed by contributors as pull requests. This development branch will periodically be merged to the master branch, and be released to PowerShell Gallery.

How to Contribute

If you would like to contribute to this repository, please read the contributing guidelines.

Resources

• AzureFileSyncAgent: This resource can be used to install and configure the Azure File Sync agent.
• AzureFileSyncServerEndpoint: This resource can be used to create an Azure File Sync Server Endpoint in Azure.

AzureFileSyncAgent

This resource can be used to install and configure the Azure File Sync agent on a server running Windows Server 2012 R2, Windows Server 2016 or Windows Server 2019.

• [String] AzureSubscriptionId (Required): The ID of the Azure subscription where the agent will be enrolled
• [String] AzureFileSyncResourceGroup (Required): The name of the Azure resource group where the Azure File Sync service is provisioned
• [Key] AzureFileSyncInstanceName : The name of the Azure File Sync service the agent will be registered in
• [PSCredential] AzureCredential (Required): Credential object which has permissions to the Azure File Sync service the agent will be registered in

AzureFileSyncAgent Examples

• Install Azure File Sync Agent
• Install Azure File Sync Agent (Azure Automation DSC)

AzureFileSyncServerEndpoint

This resource can be used to create an Azure File Sync Server Endpoint in Azure.

• [String] AzureSubscriptionId (Required): The ID of the Azure subscription where the agent will be enrolled
• [String] AzureFileSyncResourceGroup (Required): The name of the Azure resource group where the Azure File Sync service is provisioned
• [Key] AzureFileSyncInstanceName : The name of the Azure File Sync service the agent will be registered in
• [PSCredential] AzureCredential (Required): Credential object which has permissions to the Azure File Sync service the agent will be registered in
• [String] TierFilesOlderThanDays (Write) : The name of the Azure File Sync service the agent will be registered in
• [Bool] CloudTiering (Write) : The name of the Azure File Sync service the agent will be registered in
• [String] VolumeFreeSpacePercent (Write) : The name of the Azure File Sync service the agent will be registered in
• [String] ServerLocalPath (Required) : The name of the Azure File Sync service the agent will be registered in
• [String] AzureFileSyncGroup (Key) : The name of the Azure File Sync service the agent will be registered in

AzureFileSyncServerEndpoint Examples

• Register Azure FileSync Server Endpoint
• Register Azure FileSync Server Endpoint (Azure Automation DSC)