-
Notifications
You must be signed in to change notification settings - Fork 4k
Create Az.CloudHsm Module for 2025-03-31 #27947
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.
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
Create Az.CloudHsm Module for 2025-03-31 #27947
Conversation
Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR scaffolds the new Az.CloudHsm PowerShell module targeting the 2025-03-31 API version.
- Added autogenerated comment-based help files for core cmdlets (New, Get, Backup, Remove).
- Introduced custom script implementations for each cmdlet under the
custom/
folder. - Updated module packaging/configuration (AutoRest directives,
AssemblyInfo.cs
,.gitignore
,.gitattributes
,NuGet.Config
).
Reviewed Changes
Copilot reviewed 82 out of 82 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
src/CloudHsm/CloudHsm.Autorest/docs/Remove-AzCloudHsm.md | Help content for the Remove-AzCloudHsm cmdlet |
src/CloudHsm/CloudHsm.Autorest/docs/New-AzCloudHsm.md | Help content for the New-AzCloudHsm cmdlet |
src/CloudHsm/CloudHsm.Autorest/docs/Get-AzCloudHsm.md | Help content for the Get-AzCloudHsm cmdlet |
src/CloudHsm/CloudHsm.Autorest/docs/Backup-AzCloudHsm.md | Help content for the Backup-AzCloudHsm cmdlet |
src/CloudHsm/CloudHsm.Autorest/docs/README.md | Overview of docs generation process |
src/CloudHsm/CloudHsm.Autorest/custom/*.ps1 | Script-based implementations of all core cmdlets |
src/CloudHsm/CloudHsm.Autorest/README.md | AutoRest configuration and module-level documentation |
src/CloudHsm/CloudHsm.Autorest/Properties/AssemblyInfo.cs | Assembly metadata for module versioning |
src/CloudHsm/CloudHsm.Autorest/.gitignore & .gitattributes | Build and source-control settings |
NuGet.Config | Added OneBranch-Consumption feed |
Comments suppressed due to low confidence (1)
src/CloudHsm/CloudHsm.Autorest/docs/Get-AzCloudHsm.md:92
- [nitpick] Renumber this heading to "Example 3" to avoid duplicating "Example 2" in the examples section.
### Example 2: Get a Cloud HSM in a resource group
/azp run |
Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove the test stubs whose cmdlets are removed or hidden.
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
src/CloudHsm/CloudHsm.Autorest/docs/Az.CloudHsmCmdlet.Design.md
Outdated
Show resolved
Hide resolved
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/azp run |
Commenter does not have sufficient privileges for PR 27947 in repo Azure/azure-powershell |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
@vidai-msft I made the requested changes. Please help review again. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After updating the examples, please run build-module.ps1 to update the corresponding files under both docs and help.
…ands. Added recording for restore
…/azure-powershell into cloudHsm-2025-03-31-v
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
This reverts commit 3bb1042.
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
### Example 2: Create Cloud HSM with User Assigned Identity | ||
```powershell | ||
New-AzCloudHsm -Name myCloudHsm -ResourceGroupName group -Location UkWest -Sku "Standard_B1" -UserAssignedIdentity "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity" | ||
New-AzCloudHsm -Name myCloudHsm -ResourceGroupName group -Location UkWest -Sku "Standard_B1" -UserAssignedIdentity "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate commands?
### Example 1: Update Cloud HSM to Add Tags | ||
```powershell | ||
Update-AzCloudHsm -Name myCloudHsm -ResourceGroupName group -Tag @{ CloudHsmRegion = "UkWest"; Department = "Engineering"; DepartmentNo = "1"} | ||
Update-AzCloudHsm -Name myCloudHsm -ResourceGroupName group -Tag @{ CloudHsmRegion = "UkWest"; Department = "Engineering"; DepartmentNo = "1"} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dup commands?
IdentityPrincipalId IdentityTenantId IdentityType Location Name SkuCapacity SkuFamily SkuName | ||
------------------- ---------------- ------------ -------- ---- ----------- --------- ------- | ||
UserAssigned ukwest chsm1 B Standard_B1 | ||
UserAssigned ukwest chsm2 B Standard_B1``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"```" should be in the next line. Need to run build-module.ps1 after that.
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.md
and reviewed the following information:ChangeLog.md
file(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
.## Upcoming Release
header in the past tense.ChangeLog.md
if no new release is required, such as fixing test case only.