Add new support for Relationships module by meghanagupta95 · Pull Request #29412 · Azure/azure-powershell

meghanagupta95 · 2026-04-16T03:40:37Z

Description

This PR adds a new module for the resource type 'Relationships' using the code generation method. This is required as part of our move to public preview.

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.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

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

# Conflicts: # src/ServiceGroups/ServiceGroups/help/Az.ServiceGroups.md # tools/CreateMappings_rules.json

azure-client-tools-bot-prd · 2026-04-16T03:40:41Z

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

azure-pipelines · 2026-04-16T03:40:49Z

Azure Pipelines: 4 pipeline(s) require an authorized user to comment /azp run to run.

VeryEarly · 2026-04-16T03:42:54Z

/azp run

azure-pipelines · 2026-04-16T03:43:12Z

Azure Pipelines: Successfully started running 3 pipeline(s).

Copilot

Pull request overview

Adds a new Az.Relationships PowerShell module (code-generated/AutoRest-style) intended for public preview, including initial cmdlet help content, module packaging assets, and Pester tests.

Changes:

Added Az.Relationships wrapper module assets (manifest, csproj, changelog, help stubs).
Added Relationships.Autorest configuration, docs/examples stubs, and Pester tests scaffolding.
Registered the new module name in tools/CreateMappings_rules.json.

Reviewed changes

Copilot reviewed 59 out of 59 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
tools/CreateMappings_rules.json	Registers the new `Relationships` module mapping.
src/Relationships/Relationships/help/Get-AzRelationshipsDependencyOfRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/help/Get-AzRelationshipsServiceGroupMemberRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/help/New-AzRelationshipsDependencyOfRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/help/New-AzRelationshipsServiceGroupMemberRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/help/Remove-AzRelationshipsDependencyOfRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/help/Remove-AzRelationshipsServiceGroupMemberRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/help/Update-AzRelationshipsDependencyOfRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/help/Update-AzRelationshipsServiceGroupMemberRelationship.md	Adds cmdlet help markdown (currently template placeholders).
src/Relationships/Relationships/Relationships.csproj	Introduces the wrapper project to package manifest/help.
src/Relationships/Relationships/Properties/AssemblyInfo.cs	Adds wrapper assembly metadata/versioning.
src/Relationships/Relationships/ChangeLog.md	Adds module changelog scaffold (Upcoming Release currently empty).
src/Relationships/Relationships/Az.Relationships.psd1	Adds module manifest pointing to AutoRest-generated nested module assets.
src/Relationships/Relationships.sln	Adds solution file referencing the AutoRest project (path currently suspect).
src/Relationships/Relationships.Autorest/utils/Unprotect-SecureString.ps1	Adds standard utility script used by many AutoRest modules.
src/Relationships/Relationships.Autorest/utils/Get-SubscriptionIdTestSafe.ps1	Adds test-safe subscription ID helper.
src/Relationships/Relationships.Autorest/tspconfig.yaml	Adds TypeSpec PowerShell emitter configuration and directives.
src/Relationships/Relationships.Autorest/tsp-location.yaml	Adds a TypeSpec location tracker file (currently machine-specific).
src/Relationships/Relationships.Autorest/test/utils.ps1	Adds Pester test environment setup/cleanup helpers.
src/Relationships/Relationships.Autorest/test/localEnv.json	Adds a live test environment capture (should not be committed).
src/Relationships/Relationships.Autorest/test/loadEnv.ps1	Adds test environment loader script.
src/Relationships/Relationships.Autorest/test/env.json	Adds checked-in test env template.
src/Relationships/Relationships.Autorest/test/Update-AzRelationshipsServiceGroupMemberRelationship.Tests.ps1	Adds Pester coverage for Update cmdlet (SG member relationship).
src/Relationships/Relationships.Autorest/test/Update-AzRelationshipsDependencyOfRelationship.Tests.ps1	Adds Pester coverage for Update cmdlet (dependencyOf).
src/Relationships/Relationships.Autorest/test/Remove-AzRelationshipsServiceGroupMemberRelationship.Tests.ps1	Adds Pester coverage for Remove cmdlet (SG member relationship).
src/Relationships/Relationships.Autorest/test/Remove-AzRelationshipsDependencyOfRelationship.Tests.ps1	Adds Pester coverage for Remove cmdlet (dependencyOf).
src/Relationships/Relationships.Autorest/test/README.md	Adds test folder documentation.
src/Relationships/Relationships.Autorest/test/New-AzRelationshipsServiceGroupMemberRelationship.Tests.ps1	Adds Pester coverage for New cmdlet (SG member relationship).
src/Relationships/Relationships.Autorest/test/New-AzRelationshipsDependencyOfRelationship.Tests.ps1	Adds Pester coverage for New cmdlet (dependencyOf).
src/Relationships/Relationships.Autorest/test/Get-AzRelationshipsServiceGroupMemberRelationship.Tests.ps1	Adds Pester coverage for Get cmdlet (SG member relationship).
src/Relationships/Relationships.Autorest/test/Get-AzRelationshipsDependencyOfRelationship.Tests.ps1	Adds Pester coverage for Get cmdlet (dependencyOf).
src/Relationships/Relationships.Autorest/resources/README.md	Adds resources folder documentation.
src/Relationships/Relationships.Autorest/how-to.md	Adds module development how-to documentation.
src/Relationships/Relationships.Autorest/examples/Get-AzRelationshipsServiceGroupMemberRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/examples/Get-AzRelationshipsDependencyOfRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/examples/New-AzRelationshipsServiceGroupMemberRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/examples/New-AzRelationshipsDependencyOfRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/examples/Remove-AzRelationshipsServiceGroupMemberRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/examples/Remove-AzRelationshipsDependencyOfRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/examples/Update-AzRelationshipsServiceGroupMemberRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/examples/Update-AzRelationshipsDependencyOfRelationship.md	Adds example stub content (currently placeholders).
src/Relationships/Relationships.Autorest/docs/Get-AzRelationshipsServiceGroupMemberRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/Get-AzRelationshipsDependencyOfRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/New-AzRelationshipsServiceGroupMemberRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/New-AzRelationshipsDependencyOfRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/Remove-AzRelationshipsServiceGroupMemberRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/Remove-AzRelationshipsDependencyOfRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/Update-AzRelationshipsServiceGroupMemberRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/Update-AzRelationshipsDependencyOfRelationship.md	Adds generated docs output (currently placeholders).
src/Relationships/Relationships.Autorest/docs/README.md	Adds docs folder README.
src/Relationships/Relationships.Autorest/docs/Az.Relationships.md	Adds module index doc for cmdlets.
src/Relationships/Relationships.Autorest/custom/README.md	Adds guidance for custom cmdlets.
src/Relationships/Relationships.Autorest/custom/Az.Relationships.custom.psm1	Adds custom module loader/export scaffold.
src/Relationships/Relationships.Autorest/UX/Microsoft.Relationships/serviceGroupMember.json	Adds UX command metadata for SG member relationship.
src/Relationships/Relationships.Autorest/UX/Microsoft.Relationships/dependencyOf.json	Adds UX command metadata for dependencyOf relationship.
src/Relationships/Relationships.Autorest/README.md	Adds AutoRest module README scaffold.
src/Relationships/Relationships.Autorest/Properties/AssemblyInfo.cs	Adds AutoRest assembly metadata/versioning.
src/Relationships/Relationships.Autorest/.gitignore	Adds standard AutoRest output ignores.
src/Relationships/Relationships.Autorest/.gitattributes	Adds text normalization attributes.

Copilot · 2026-04-16T03:48:49Z

+RequiredAssemblies = 'Relationships.Autorest/bin/Az.Relationships.private.dll'
+
+# Script files (.ps1) that are run in the caller's environment prior to importing this module.
+ScriptsToProcess = @()
+
+# Type files (.ps1xml) to be loaded when importing this module
+TypesToProcess = @()
+
+# Format files (.ps1xml) to be loaded when importing this module
+FormatsToProcess = 'Relationships.Autorest/Az.Relationships.format.ps1xml'
+
+# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+NestedModules = @('Relationships.Autorest/Az.Relationships.psm1')


The module manifest references nested module assets under Relationships.Autorest/ (private DLL, format file, and Az.Relationships.psm1), but there is no corresponding generated output folder in the repo (e.g., generated/Relationships/Relationships.Autorest/ like other AutoRest modules). As-is, importing/building Az.Relationships will fail because these referenced files don't exist. Please add/commit the generated AutoRest project output (or update the manifest paths to where the generated artifacts actually live).

Copilot · 2026-04-16T03:48:50Z

+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Relationships.Autorest", "Relationships.Autorest", "{70B5B518-732F-B4FA-61D8-EC0023A4A294}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Relationships", "Relationships.Autorest\Az.Relationships.csproj", "{6F458F0C-D22D-48F9-A5AA-4AD0751760F9}"
+EndProject


This solution references Relationships.Autorest\Az.Relationships.csproj, but that project file isn't present in the repository. Other modules typically reference the committed generated project under generated/<Module>/<Module>.Autorest/. Please update the .sln to point at the correct (committed) generated project location, or ensure the referenced .csproj is included as part of the PR.

Copilot · 2026-04-16T03:48:50Z

+## Upcoming Release
+
+## Version 0.1.0
+* First preview release for module Az.Relationships


The ## Upcoming Release section is empty. Since this PR introduces a new public preview module, please add a user-facing entry under ## Upcoming Release (past tense) describing the new Az.Relationships cmdlets/module surface.

azure-pipelines · 2026-04-16T05:19:21Z

Azure Pipelines: 4 pipeline(s) require an authorized user to comment /azp run to run.

meghanagupta95 · 2026-04-16T05:19:38Z

/azp run

azure-pipelines · 2026-04-16T05:19:45Z

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

meghanagupta95 · 2026-04-16T05:48:12Z

cmdlet review PR https://github.com/Azure/azure-powershell-cmdlet-review-pr/issues/1546

azure-pipelines · 2026-04-16T06:02:37Z

Azure Pipelines: 4 pipeline(s) require an authorized user to comment /azp run to run.

azure-pipelines · 2026-04-16T06:08:00Z

Azure Pipelines: 4 pipeline(s) require an authorized user to comment /azp run to run.

azure-pipelines · 2026-04-16T06:12:15Z

Azure Pipelines: 4 pipeline(s) require an authorized user to comment /azp run to run.

VeryEarly · 2026-04-16T06:12:17Z

/azp run

Copilot

Pull request overview

Copilot reviewed 59 out of 59 changed files in this pull request and generated 17 comments.

azure-pipelines · 2026-04-16T06:12:35Z

Azure Pipelines: Successfully started running 3 pipeline(s).

azure-pipelines · 2026-04-16T06:40:22Z

Azure Pipelines: 4 pipeline(s) require an authorized user to comment /azp run to run.

meghanagupta95 · 2026-04-16T06:42:24Z

/azp run

azure-pipelines · 2026-04-16T06:42:32Z

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

meghanagupta95 · 2026-04-16T14:54:13Z

/azp run

azure-pipelines · 2026-04-16T14:54:21Z

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

VeryEarly · 2026-04-17T03:46:22Z

/azp run

azure-pipelines · 2026-04-17T03:46:39Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 60 out of 60 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (5)

src/Relationships/Relationships/ChangeLog.md:1

The changelog template indicates entries should be added under ## Upcoming Release, and prior releases should follow a dated header format (e.g., ## YYYY.MM.DD - Version X.Y.Z). Right now Upcoming Release is empty and Version 0.1.0 lacks the date portion—please either record this PR’s change under Upcoming Release (past tense) or convert ## Version 0.1.0 to the template’s dated release header.
src/Relationships/Relationships.Autorest/test/utils.ps1:1
Removing resource groups without -Force (and/or explicitly setting -Confirm:$false) can prompt for confirmation, which can hang CI/test runs. Update these cleanup calls to be non-interactive (and ideally resilient), e.g., add -Force and -Confirm:$false so automated test environments won’t block.
src/Relationships/Relationships.Autorest/test/Remove-AzRelationshipsDependencyOfRelationship.Tests.ps1:1
The help text states deletes are asynchronous; asserting that a subsequent Get-* immediately throws can be flaky in live/record runs due to eventual consistency. Consider adding a bounded retry/poll loop (with sleeps skipped in playback), or waiting until the resource is actually gone before asserting.
src/Relationships/Relationships.Autorest/test/Update-AzRelationshipsDependencyOfRelationship.Tests.ps1:1
This update test doesn’t validate that the update actually changes anything—TargetId is set to $env.DepTargetId, which is also used when creating the relationship in setupEnv. To cover update behavior, update to a different valid target and assert on the returned (or subsequently fetched) target property instead of only asserting .Name.
src/Relationships/Relationships.Autorest/utils/Unprotect-SecureString.ps1:1
Shipping a utility that converts SecureString to plaintext increases the risk of accidental secret disclosure (e.g., logging/telemetry/pipeline output). If this is only intended for local/dev/test use, consider ensuring it is not packaged with the module and not dot-sourced/exported; otherwise add clear warnings/guardrails (and ensure it’s not invoked by default anywhere).

Copilot · 2026-04-17T14:06:06Z

+    - `-Pack`: After building, packages the module into a `.nupkg`.
+    - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module.
+    - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration).
+    - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process.


Correct spelling of 'Supresses' to 'Suppresses'.

Suggested change

- `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process.

- `-NoDocs`: Suppresses writing the documentation markdown files as part of the cmdlet exporting process.

meghanagupta95 and others added 12 commits March 18, 2026 09:52

New powershell module - initial changes

0c5ee0d

Merge branch 'main' into meghanag/servicegroups

367d4f6

Update mapping rule json

64d9fb1

Check in generate-info file

f56dab8

Update tests for servicegroups

b7493b6

Update failing tests

f86dcbf

Merge branch 'main' into meghanag/servicegroups

68c1f5b

Remove UpdateViaIdentity AND UpdateViaIdentityExpanded variants

b124b0e

Update some tests

9ae7a26

Remove servicegroups from generated folder

c2d293b

Initial commit for new module for Relationships

8fcb12a

Merge branch 'main' into meghanag/relationships-pp

2ce3f76

# Conflicts: # src/ServiceGroups/ServiceGroups/help/Az.ServiceGroups.md # tools/CreateMappings_rules.json

Copilot AI review requested due to automatic review settings April 16, 2026 03:40

Copilot started reviewing on behalf of meghanagupta95 April 16, 2026 03:43 View session

Copilot AI reviewed Apr 16, 2026

View reviewed changes

Fix missing generate-info file

9d6c71f

Copilot AI review requested due to automatic review settings April 16, 2026 06:02

Copilot started reviewing on behalf of meghanagupta95 April 16, 2026 06:04 View session

meghanagupta95 force-pushed the meghanag/relationships-pp branch from 80bc147 to f3f5433 Compare April 16, 2026 06:07

meghanagupta95 force-pushed the meghanag/relationships-pp branch from f3f5433 to aa1cd6a Compare April 16, 2026 06:12

Copilot AI reviewed Apr 16, 2026

View reviewed changes

Fix help files

973a7b5

meghanagupta95 force-pushed the meghanag/relationships-pp branch from aa1cd6a to 973a7b5 Compare April 16, 2026 06:40

meghanagupta95 closed this Apr 16, 2026

meghanagupta95 reopened this Apr 16, 2026

meghanagupta95 marked this pull request as ready for review April 17, 2026 13:58

Copilot AI review requested due to automatic review settings April 17, 2026 13:58

Copilot started reviewing on behalf of meghanagupta95 April 17, 2026 14:00 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

	- `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process.
	- `-NoDocs`: Suppresses writing the documentation markdown files as part of the cmdlet exporting process.

Conversation

meghanagupta95 commented Apr 16, 2026

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

VeryEarly commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

meghanagupta95 commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

meghanagupta95 commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

VeryEarly commented Apr 16, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

meghanagupta95 commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

meghanagupta95 commented Apr 16, 2026

Uh oh!

azure-pipelines bot commented Apr 16, 2026

Uh oh!

VeryEarly commented Apr 17, 2026

Uh oh!

azure-pipelines bot commented Apr 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!