Skip to content

Update RestSetAcls README #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MaximeKjaer merged 1 commit into from
Dec 3, 2025
Merged

Update RestSetAcls README #294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions RestSetAcls/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
# RestSetAcls.psm1
# RestSetAcls

## Description

RestSetAcls.psm1 is a PowerShell module that provides functions to set Access Control Lists (ACLs) for Azure file shares, using the Azure Files REST API.
RestSetAcls is a PowerShell module that provides functions to set Access Control Lists (ACLs) for Azure file shares, using the Azure Files REST API.

> [!NOTE]
> RestSetAcls.psm1 currently only supports setting the same owner, group and permissions on all files within a share or subdirectory.
> It does not yet support:
>
> - Updates to one field without updating others (e.g., updating the owner without updating the group and permissions)
> - Adding or removing a permission, without otherwise changing the permissions
It's built as a wrapper of [Az.Storage](https://learn.microsoft.com/en-us/powershell/module/az.storage/?view=azps-15.0.0) and [Microsoft.Graph](https://learn.microsoft.com/en-us/powershell/microsoftgraph/get-started?view=graph-powershell-1.0) PowerShell modules, adding functionality for Azure Files ACLs on top of these.

## Prerequisites

- PowerShell 5.1 or later. For the best performance, PowerShell 7+ is recommended ([installation instructions](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell))
- `Az.Storage` module v4.1.1 or later ([installation instructions](https://learn.microsoft.com/en-us/powershell/azure/install-azure-powershell))
- PowerShell 5.1 or later. For the best performance and experience, PowerShell 7+ is recommended ([installation instructions](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell))
- Azure Storage account with a file share
- Azure Storage account key ([instructions on how to find the key](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys))
- Access to the [storage account's key](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal), or ability to [acquire an OAuth token](https://learn.microsoft.com/en-us/azure/storage/files/authorize-oauth-rest?tabs=portal) to the account

## Installation

```powershell
Install-Module RestSetAcls
```

This step will also install all dependencies, such as [Az.Storage](https://learn.microsoft.com/en-us/powershell/module/az.storage/?view=azps-15.0.0) and the required [Microsoft.Graph](https://learn.microsoft.com/en-us/powershell/microsoftgraph/get-started?view=graph-powershell-1.0) PowerShell modules, if not already installed.

## Authenticate

Before you begin, make sure you meet the prerequisites above. Then, open a PowerShell session. PowerShell 7 is preferred, but PowerShell 5 (aka Windows PowerShell) is also acceptable.
Expand Down Expand Up @@ -80,7 +76,7 @@ $context = New-AzStorageContext -StorageAccountName $AccountName -StorageAccount
$sasToken = New-AzStorageFileSASToken -Context $context -ShareName $FileShareName -Path "/" -Permission "rwl" -Protocol HttpsOnly -ExpiryTime (Get-Date).AddDays(1)
```

#### Option 4: OAuth authentication
### Option 4: OAuth authentication

Account SAS and service SAS tokens are derived from the account key. If you want to avoid using the account key altogether, you can use [OAuth authentication](https://learn.microsoft.com/en-us/azure/storage/files/authorize-oauth-rest).

Expand Down