Skip to content

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

Merged
merged 23 commits into from
Jun 24, 2025

Conversation

emmeliaAra
Copy link
Member

Description

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

@Copilot Copilot AI review requested due to automatic review settings June 12, 2025 14:38
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

@emmeliaAra emmeliaAra changed the title Initial commit Az.CloudHsm 2025-03-31 Create Az.CloudHsm Module for 2025-03-31 Jun 12, 2025
Copilot

This comment was marked as outdated.

@jkapil jkapil requested a review from Copilot June 12, 2025 23:19
Copy link
Contributor

@Copilot Copilot AI left a 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 

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

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.

Copy link
Contributor

@vidai-msft vidai-msft left a 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.

Copy link

This PR was labeled "needs-revision" because it has unresolved review comments or CI failures.
Please resolve all open review comments and make sure all CI checks are green. Refer to our guide to troubleshoot common CI failures.

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@emmeliaAra
Copy link
Member Author

/azp run

Copy link
Contributor

Commenter does not have sufficient privileges for PR 27947 in repo Azure/azure-powershell

@emmeliaAra emmeliaAra requested a review from vidai-msft June 16, 2025 13:08
@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Copy link

This PR was labeled "needs-revision" because it has unresolved review comments or CI failures.
Please resolve all open review comments and make sure all CI checks are green. Refer to our guide to troubleshoot common CI failures.

@emmeliaAra
Copy link
Member Author

@vidai-msft I made the requested changes. Please help review again.

Copy link
Contributor

@vidai-msft vidai-msft left a 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.

@vidai-msft
Copy link
Contributor

/azp run

@vidai-msft vidai-msft added this to the Az 14.2.0 (07/01/2025) milestone Jun 24, 2025
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft vidai-msft changed the base branch from main to release-2025-07-01 June 24, 2025 14:22
@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

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"
Copy link
Contributor

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"}
Copy link
Contributor

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```
Copy link
Contributor

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.

@vidai-msft
Copy link
Contributor

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Copy link
Contributor

@vidai-msft vidai-msft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vidai-msft vidai-msft enabled auto-merge (squash) June 24, 2025 15:33
@vidai-msft vidai-msft merged commit 4b2ad68 into Azure:release-2025-07-01 Jun 24, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants