Skip to content

Use the Microsoft.Storage resource provider for Azure file share management operations #11583

@wmgries

Description

@wmgries

Resource Provider
Microsoft.Storage

Description of Feature or Work Requested
Today, the Azure Files CLI commands for file share management (az storage share) go through the Azure storage data plane. This causes a number of issues for customers, most notably it means customers are unable to manage their file shares if their Azure storage account is in a vnet and the client where they are running the Azure CLI (such as their laptop) isn't - this is a very common management scenario for Azure Files. Therefore, we would like to add a new command path, az storage share-rm, that sends the file share management requests through the Storage Resource Provider (SRP) instead of through the Azure storage data plane.

We need to add a new command path for several reasons. First and most importantly, not all operations are available on the file share proxy resource object offered by SRP, by design. For example, operations to create and manage SAS tokens are not planned and are unlikely to be ever added to the file share object. Secondly, SRP is being a middle-man for file share requests - the requests they get to manage a file share are passed through to the data plane APIs (SRP has a way through customer vnets). SRP is generally believed to have less performance than the underlying data plane API. Therefore, it is strongly recommended that customers needing to do many calls against the Azure file share at once should use the data plane. Although this is not the primary thing that customers use Azure Files for today, we have to maintain this path for compatibility reasons. Finally, adopting SRP will require some significant changes to the command interface, and we would like to avoid a breaking change. Note, this change has already been done in the Azure PowerShell package - we maintain (verb-Aznoun, which goes through the data plane, and verb-AzRmnoun, which goes through SRP).

Minimum API Version Required
Microsoft.Storage 2019-06-01

Swagger Link
https://github.com/Azure/azure-rest-api-specs/blob/master/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/file.json

Target Date
1/13

Here's the link to the OneNote describing the change.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions