Add Relationship Base Type

[alexchro93]

This PR introduces a base type for namespace Microsoft.Relationships. Relationships are extension resources used to establish a connection between a source ARM resource and target ARM resource.

Notably, two relationship types exist in a public preview state in ARM today: serviceGroupMember and dependencyOf.

The implementation of the Microsoft.Relationships base type is heavily inspired by the only other existing base type current: agent.

The relationship type is meant to be a lightweight ARM resources (meaning the resource payload has minimal properties and only really carries references to other ARM resources), however implementations of the relationship base type can new metadata about a relationship through extending the RelationshipMetadata model

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

Copilot-Session: 8a6e07d6-3bd4-4373-b9a2-88ad69127fcf

[azure-sdk-automation]

All changed packages have been documented.

• ✅ @azure-tools/typespec-azure-resource-manager
• ✅ @azure-tools/typespec-azure-rulesets

Show changes

@azure-tools/typespec-azure-resource-manager - feature ✏️

Add the experimental Relationship base type for Azure Resource Manager extension resources. RelationshipProperties provides the baseTypes descriptor, source and target resource and tenant identifiers, and provisioning state. Resource providers can extend this property bag with relationship-specific information and expose the relationship against any ARM resource scope.,> ,> Example of creating a dependency relationship with RP-specific metadata and operations:,> ,> typespec,> using Azure.ResourceManager;,> using Azure.ResourceManager.BaseTypes.Relationships;,> ,> model DependencyOfMetadata {,> sourceType: string;,> targetType: string;,> description?: string;,> },> ,> model DependencyOfProperties is RelationshipProperties {,> metadata: DependencyOfMetadata;,> },> ,> #suppress "@azure-tools/typespec-azure-resource-manager/basetypes-experimental" "Experimental BaseTypes",> model DependencyOf is Relationship<DependencyOfProperties> {,> ...ResourceNameParameter<,> Resource = DependencyOf,,> KeyName = "relationshipName",,> SegmentName = "dependencyOf",,> NamePattern = "^[a-zA-Z0-9_.-]{1,64}$",> >;,> },> ,> interface DependencyOfOps<Scope extends Azure.ResourceManager.Foundations.SimpleResource> {,> get is Extension.Read<Scope, DependencyOf>;,> create is Extension.CreateOrReplaceAsync<Scope, DependencyOf>;,> update is Extension.CustomPatchAsync<,> Scope,,> DependencyOf,,> Azure.ResourceManager.Foundations.ResourceUpdateModel<DependencyOf, DependencyOfProperties>,> >;,> delete is Extension.DeleteWithoutOkAsync<Scope, DependencyOf>;,> list is Extension.ListByTarget<Scope, DependencyOf>;,> },>

@azure-tools/typespec-azure-rulesets - feature ✏️

Add the experimental Relationship base type for Azure Resource Manager extension resources. RelationshipProperties provides the baseTypes descriptor, source and target resource and tenant identifiers, and provisioning state. Resource providers can extend this property bag with relationship-specific information and expose the relationship against any ARM resource scope.,> ,> Example of creating a dependency relationship with RP-specific metadata and operations:,> ,> typespec,> using Azure.ResourceManager;,> using Azure.ResourceManager.BaseTypes.Relationships;,> ,> model DependencyOfMetadata {,> sourceType: string;,> targetType: string;,> description?: string;,> },> ,> model DependencyOfProperties is RelationshipProperties {,> metadata: DependencyOfMetadata;,> },> ,> #suppress "@azure-tools/typespec-azure-resource-manager/basetypes-experimental" "Experimental BaseTypes",> model DependencyOf is Relationship<DependencyOfProperties> {,> ...ResourceNameParameter<,> Resource = DependencyOf,,> KeyName = "relationshipName",,> SegmentName = "dependencyOf",,> NamePattern = "^[a-zA-Z0-9_.-]{1,64}$",> >;,> },> ,> interface DependencyOfOps<Scope extends Azure.ResourceManager.Foundations.SimpleResource> {,> get is Extension.Read<Scope, DependencyOf>;,> create is Extension.CreateOrReplaceAsync<Scope, DependencyOf>;,> update is Extension.CustomPatchAsync<,> Scope,,> DependencyOf,,> Azure.ResourceManager.Foundations.ResourceUpdateModel<DependencyOf, DependencyOfProperties>,> >;,> delete is Extension.DeleteWithoutOkAsync<Scope, DependencyOf>;,> list is Extension.ListByTarget<Scope, DependencyOf>;,> },>

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@azure-tools/typespec-azure-resource-manager@4892

npm i https://pkg.pr.new/@azure-tools/typespec-azure-rulesets@4892

commit: a0c3467

[azure-sdk-automation]

You can try these changes here

🛝 Playground	🌐 Website

[markcowl]

I also wonder if we want a resource type for this, especially if it is required to be an extension.

[markcowl]

I think we should either create templates for these types, or we should have a type that defines the required properties and a decorator that indicates what is required (property exists, optionality, etc.) and use this to drive the linting rule

[markcowl]

Essentially, if we have a `@baseTypeProperty decorator, which took a base type kind and version, we could have an internal-only type (or a set of them) that defined the required properties.

[alexchro93]

I also wonder if we want a resource type for this, especially if it is required to be an extension.

@markcowl, can you please explain what you mean by this?

[markcowl]

In the Agent types, we split these into Appliance and UserDefined templates, with the appliance type having readOnly properties. If we are considering making some of these readOnly, it is easiest to make this part of the Appliance template

[alexchro93]

Some relationship types should mark targetId and targetTenant as readonly while other relationship types mark sourceId and sourceTenant as readonly. For this reason, I didn't specify either set of properties as readonly in this single base class.

Do you think it's better to have a split like agent into a base relationship with readonly source id/tenant and another with readonly target id/tenant?