[RULE] Disable public network access on file shares

[BernieWhite]

Existing rule

No response

Suggested rule

Azure file shares Microsoft.FileShares/fileShares is a new (preview) resource separate from Microsoft.Storage.

A new separate rule should be created to ensure that public access is disabled by setting properties.publicNetworkAccess to Disabled.

Similar to: https://azure.github.io/PSRule.Rules.Azure/en/rules/Azure.ADX.PublicAccess/

Pillar

Security

Additional context

• https://learn.microsoft.com/azure/templates/microsoft.fileshares/fileshares
• https://learn.microsoft.com/azure/storage/files/create-file-share#networking

[mathieusouflis]

Hi, this is my first issue and experience with the repository. Can i take this issue ?

Have a great day !

[BernieWhite]

@mathieusouflis Sure. Let me know if you have any questions.

[BernieWhite]

See @mathieusouflis docs over here: https://azure.github.io/PSRule.Rules.Azure/contribute/rules/prerequisites/

Also you might need to create Azure.Share.Rule.ps1 and Azure.Share.Tests.ps1 etc.. since this is for a new resource provider. Have a look at another similar file for an example on how to layout the files.

[mathieusouflis]

Thanks @BernieWhite !

[mathieusouflis]

Hi @BernieWhite ,

I reviewed the documentation and looked into how the ADX rule is implemented. I’ve created the YAML file and the rule. However, in the ADX PowerShell script, I don’t see any script related to disabling the rule in question.

Did I follow the correct steps, or am I missing something?

How can I verify that everything is working properly?

PS: Also i think i have to add / update some documentation about this rule right ?

[BernieWhite]

@mathieusouflis Not 100% on what you mean by the first question.

But attempting to answer it anyway.

If you've completed step 4 - https://azure.github.io/PSRule.Rules.Azure/contribute/rules/create-rule/, then you need to create tests in step 5, put the tests in a new file Azure.Share.Tests.ps1.

To create rule help, create a file in docs/en/rules/ with the name of you rule .md. Which should be something like Azure.Share.PublicAccess.md.

If you have got to this point you should be able to run a test by using the test task in VSCode, or running ./build.ps1.

Once you create a draft PR I can help you more if this didn't make sense.

[mathieusouflis]

@BernieWhite Got it, I think I just forgot to add Azure.Share.PublicAccess.md in the docs, that's why I had errors when building..

I’ve put my PR in draft for now to get your feedback.