Skip to content

Fix @azureBaseType doc example to reference a real resource model #4755

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.

Sign up for GitHub

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

Open
Copilot wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix @azureBaseType doc example to reference a real resource model #4755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d1e2ae4
Initial plan
Copilot Jun 30, 2026
eed4a7a
Fix @azureBaseType doc example to reference a real resource model
Copilot Jun 30, 2026
e9b1622
Merge remote-tracking branch 'origin/main' into copilot/fix-azure-bas…
Copilot Jun 30, 2026
e04aad7
Update @azureBaseType doc example with Contoso Appliance agent from s…
Copilot Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .chronus/changes/arm-azurebasetype-doc-example-2026-06-30.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: internal
packages:
- "@azure-tools/typespec-azure-resource-manager"
---

Fix `@azureBaseType` doc example to reference a real resource model instead of non-existent spreads
14 changes: 10 additions & 4 deletions packages/typespec-azure-resource-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,12 +602,18 @@ multiple base types. Duplicate entries are ignored.
##### Examples

```typespec
@azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
model MyAgentProperties {
...AgentProperties;
...AgentToolProperty;
// Agent definition and properties using the Appliance deployment model
model ContosoApplianceDefinition is AgentDefinitionAppliance<true, true>;
model ContosoApplianceProperties is AgentPropertiesAppliance<ContosoApplianceDefinition> {
...DefaultProvisioningStateProperty;
}

// The @azureBaseType decorator marks the resource as conforming to the Agent base type.
// (The Agent template applies this automatically, but it can also be applied directly.)
@azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
model ContosoApplianceAgent is TrackedResource<ContosoApplianceProperties> {
...ResourceNameParameter<ContosoApplianceAgent>;
}
```

### Azure.ResourceManager.Legacy
Expand Down
14 changes: 10 additions & 4 deletions packages/typespec-azure-resource-manager/generated-defs/Azure.ResourceManager.BaseTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,18 @@ export interface BaseTypeInfo {
* @param baseType The base type specification this resource implements.
* @example
* ```typespec
* @azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
* model MyAgentProperties {
* ...AgentProperties;
* ...AgentToolProperty;
* // Agent definition and properties using the Appliance deployment model
* model ContosoApplianceDefinition is AgentDefinitionAppliance<true, true>;
* model ContosoApplianceProperties is AgentPropertiesAppliance<ContosoApplianceDefinition> {
* ...DefaultProvisioningStateProperty;
* }
*
* // The @azureBaseType decorator marks the resource as conforming to the Agent base type.
* // (The Agent template applies this automatically, but it can also be applied directly.)
* @azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
* model ContosoApplianceAgent is TrackedResource<ContosoApplianceProperties> {
* ...ResourceNameParameter<ContosoApplianceAgent>;
* }
* ```
*/
export type AzureBaseTypeDecorator = (
Expand Down
14 changes: 10 additions & 4 deletions packages/typespec-azure-resource-manager/lib/base-types/base-types.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,18 @@ model BaseTypeInfo {
* @example
*
* ```typespec
* @azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
* model MyAgentProperties {
* ...AgentProperties;
* ...AgentToolProperty;
* // Agent definition and properties using the Appliance deployment model
* model ContosoApplianceDefinition is AgentDefinitionAppliance<true, true>;
* model ContosoApplianceProperties is AgentPropertiesAppliance<ContosoApplianceDefinition> {
* ...DefaultProvisioningStateProperty;
* }
*
* // The @azureBaseType decorator marks the resource as conforming to the Agent base type.
* // (The Agent template applies this automatically, but it can also be applied directly.)
* @azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
* model ContosoApplianceAgent is TrackedResource<ContosoApplianceProperties> {
* ...ResourceNameParameter<ContosoApplianceAgent>;
* }
* ```
*/
extern dec azureBaseType(target: Model, baseType: valueof BaseTypeInfo);
14 changes: 10 additions & 4 deletions .../src/content/docs/docs/libraries/azure-resource-manager/reference/decorators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,12 +512,18 @@ multiple base types. Duplicate entries are ignored.
#### Examples

```typespec
@azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
model MyAgentProperties {
...AgentProperties;
...AgentToolProperty;
// Agent definition and properties using the Appliance deployment model
model ContosoApplianceDefinition is AgentDefinitionAppliance<true, true>;
model ContosoApplianceProperties is AgentPropertiesAppliance<ContosoApplianceDefinition> {
...DefaultProvisioningStateProperty;
}

// The @azureBaseType decorator marks the resource as conforming to the Agent base type.
// (The Agent template applies this automatically, but it can also be applied directly.)
@azureBaseType(#{ baseType: "Agent", version: "2024-06-01" })
model ContosoApplianceAgent is TrackedResource<ContosoApplianceProperties> {
...ResourceNameParameter<ContosoApplianceAgent>;
}
```

## Azure.ResourceManager.Legacy
Expand Down
Loading