Skip to content

Fix ARM library doc-comment typos and regenerate reference docs #5070

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 2 commits into
base: main
Choose a base branch
from
Open

Fix ARM library doc-comment typos and regenerate reference docs #5070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
643de5b
Initial plan
Copilot Jul 27, 2026
754d74a
Fix ARM library doc-comment typos and regenerate reference docs
Copilot Jul 27, 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/fix-arm-doc-comments-2026-07-27-18-23-00.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 doc-comment typos in ARM library `.tsp` files and regenerate reference docs.
2 changes: 1 addition & 1 deletion packages/typespec-azure-resource-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ of the operations will be grouped based on the interface name in generated
clients.

The optional `resourceOperationOptions` parameter provides additional options.
`allowStaticRoutes` turns off autoRout for the interface, so individual operations can
`allowStaticRoutes` turns off autoRoute for the interface, so individual operations can
choose static (`@route`) or automatic (`@autoRoute`) routing.

`resourceType: Model` specifies the resource type for the operations in the interface
Expand Down
2 changes: 1 addition & 1 deletion packages/typespec-azure-resource-manager/generated-defs/Azure.ResourceManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ export type ArmResourceCheckExistenceDecorator = (
* clients.
*
* The optional `resourceOperationOptions` parameter provides additional options.
* `allowStaticRoutes` turns off autoRout for the interface, so individual operations can
* `allowStaticRoutes` turns off autoRoute for the interface, so individual operations can
* choose static (`@route`) or automatic (`@autoRoute`) routing.
*
* `resourceType: Model` specifies the resource type for the operations in the interface
Expand Down
2 changes: 1 addition & 1 deletion packages/typespec-azure-resource-manager/lib/common-types/managed-identity-ref.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ namespace Azure.ResourceManager.CommonTypes;
);

/**
* The properties of the service-assigned identity associated with this resource.
* The properties of the system-assigned identity associated with this resource.
*/
@@armCommonDefinition(
SystemAssignedServiceIdentity,
Expand Down
6 changes: 1 addition & 5 deletions packages/typespec-azure-resource-manager/lib/common-types/nsp-operations.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,6 @@ interface NspConfigurationOperations<
* @template ParentResource the parent resource of the NspConfiguration
* @template Resource Optional. The NspConfiguration resource being listed
* @template BaseParameters Optional. Allows overriding the operation parameters
* @template ParentName Optional. The name of the parent resource
* @template ParentFriendlyName Optional. The friendly name of the parent resource
* @template Parameters Optional. Additional parameters after the path parameters
* @template Response Optional. The success response for the list operation
* @template Error Optional. The error response, if non-standard.
Expand Down Expand Up @@ -127,12 +125,10 @@ interface NspConfigurationOperations<
>;

/**
* List the network security parameter configuration for a resource without pagination - this should only be used for legacy operations
* List the network security perimeter configuration for a resource without pagination - this should only be used for legacy operations
* @template ParentResource the parent resource of the NspConfiguration
* @template Resource Optional. The NspConfiguration resource being listed
* @template BaseParameters Optional. Allows overriding the operation parameters
* @template ParentName Optional. The name of the parent resource
* @template ParentFriendlyName Optional. The friendly name of the parent resource
* @template Parameters Optional. Additional parameters after the path parameters
* @template Response Optional. The success response for the list operation
* @template Error Optional. The error response, if non-standard.
Expand Down
2 changes: 1 addition & 1 deletion packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ namespace Azure.ResourceManager.CommonTypes;
"privatelinks.json"
);

/** The private endpoint resource */
/** The private link resource */
@@armCommonDefinition(
PrivateLinkResource,
"PrivateLinkResource",
Expand Down
2 changes: 1 addition & 1 deletion packages/typespec-azure-resource-manager/lib/decorators.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ extern dec armResourceCheckExistence(
* clients.
*
* The optional `resourceOperationOptions` parameter provides additional options.
* `allowStaticRoutes` turns off autoRout for the interface, so individual operations can
* `allowStaticRoutes` turns off autoRoute for the interface, so individual operations can
* choose static (`@route`) or automatic (`@autoRoute`) routing.
*
* `resourceType: Model` specifies the resource type for the operations in the interface
Expand Down
4 changes: 2 additions & 2 deletions packages/typespec-azure-resource-manager/lib/legacy-types/extension.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ interface ExtensionOperations<

/**
* A long-running resource Update (PATCH)
* @template Resource the resource being created or updated
* @template Resource the resource being updated
* @template PatchModel the PATCH request model
* @template LroHeaders Optional. Allows overriding the lro headers returned on resource create
* @template Parameters Optional. Additional parameters after the path parameters
Expand Down Expand Up @@ -134,7 +134,7 @@ interface ExtensionOperations<

/**
* A synchronous resource Update (PATCH)
* @template Resource the resource being created or updated
* @template Resource the resource being updated
* @template PatchModel the PATCH request model
* @template Parameters Optional. Additional parameters after the path parameters
* @template Response Optional. The success response(s) for the PATCH operation
Expand Down
8 changes: 4 additions & 4 deletions packages/typespec-azure-resource-manager/lib/legacy-types/operations.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ using Rest;
* is accessible at multiple, fixed resource paths.
* @template ParentParameters The path parameters for the resource parent
* @template ResourceTypeParameter The path parameter for the resource name
* @template ErrorType Optional. The type of error models used in operations created form this template
* @template ErrorType Optional. The type of error models used in operations created from this template
* @template ResourceName Optional. The name of the resource type described in this template
*/
interface LegacyOperations<
Expand All @@ -34,7 +34,7 @@ interface LegacyOperations<
* is accessible at multiple, fixed resource paths. Can be used with static routes.
* @template ParentParameters The path parameters for the resource parent
* @template ResourceTypeParameter The path parameter for the resource name
* @template ErrorType Optional. The type of error models used in operations created form this template
* @template ErrorType Optional. The type of error models used in operations created from this template
* @template ResourceRoute Optional. The resource route to use for operations in the interface.
* @template RoutedResourceName Optional. The name of the resource type described in this template
*/
Expand Down Expand Up @@ -660,7 +660,7 @@ op CreateOrReplaceSync<

/**
* A resource list operation, at the subscription scope, that lists only a single page
* @template Resource the resource being patched
* @template Resource the resource being listed
* @template Parameters Optional. Additional parameters after the path parameters
* @template Response Optional. The success response for the list operation
* @template Error Optional. The error response, if non-standard.
Expand All @@ -681,7 +681,7 @@ op ArmListSinglePageBySubscription<

/**
* A resource list operation, at the scope of the resource's parent that lists only a single page.
* @template Resource the resource being patched
* @template Resource the resource being listed
* @template BaseParameters Optional. Allows overriding the operation parameters
* @template ParentName Optional. The name of the parent resource
* @template ParentFriendlyName Optional. The friendly name of the parent resource
Expand Down
2 changes: 0 additions & 2 deletions packages/typespec-azure-resource-manager/lib/legacy-types/private-endpoints.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ using Rest;
* @template ParentResource the parent resource of the PrivateEndpointConnection
* @template Resource Optional. The PrivateEndpointConnection resource being listed
* @template BaseParameters Optional. Allows overriding the operation parameters
* @template ParentName Optional. The name of the parent resource
* @template ParentFriendlyName Optional. The friendly name of the parent resource
* @template Parameters Optional. Additional parameters after the path parameters
* @template Response Optional. The success response for the list operation
* @template Error Optional. The error response, if non-standard.
Expand Down
4 changes: 2 additions & 2 deletions packages/typespec-azure-resource-manager/lib/operations.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@ op ArmResourceActionNoContentSync<
/**
* Adds check global name availability operation, normally used if
* a resource name must be globally unique (for example, if the resource
* exposes and endpoint that uses the resource name in the url)
* exposes an endpoint that uses the resource name in the url)
* @template Request the availability request, defaults to the standard request, containing name and resource type
* @template Response the availability response, default to the standard response
* @template AdditionalParams A model specifying additional non-path parameters to the availability request
Expand All @@ -905,7 +905,7 @@ op checkGlobalNameAvailability<
/**
* Adds check location-specific name availability operation, normally used if
* a resource name must be globally unique (for example, if the resource
* exposes and endpoint that uses the resource name in the url)
* exposes an endpoint that uses the resource name in the url)
* @template Request the availability request, defaults to the standard request, containing name and resource type
* @template Response the availability response, default to the standard response
* @template AdditionalParams A model specifying additional non-path parameters to the availability request
Expand Down
6 changes: 3 additions & 3 deletions packages/typespec-azure-resource-manager/lib/responses.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ model ArmLroLocationHeader<
* @template StatusMonitor The type of the polling StatusMonitor when following the Azure-AsyncOperation url
* @template FinalResult The type of the logical result when following the location header
* @template PollingUrlValue The value type of the link to the status monitor
* @template FinalUrlValue The value type fo the link to the final result
* @template FinalUrlValue The value type of the link to the final result
*
* @example
* ```typespec
Expand Down Expand Up @@ -320,7 +320,7 @@ model ArmResourceUpdatedResponse<Resource extends Azure.ResourceManager.Foundati

/**
* Resource create operation succeeded
* @template Resource The resource being updated
* @template Resource The resource being created
* @template LroHeaders Optional. The lro headers returned with a Created response
*
* @example
Expand Down Expand Up @@ -350,7 +350,7 @@ model ArmResourceCreatedResponse<

/**
* Resource synchronous create operation succeeded
* @template Resource The resource being updated
* @template Resource The resource being created
*
* @example
* ```typespec
Expand Down
6 changes: 3 additions & 3 deletions .../src/content/docs/docs/libraries/azure-resource-manager/reference/data-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ model Azure.ResourceManager.ArmCombinedLroHeaders<StatusMonitor, FinalResult, Po
| StatusMonitor | The type of the polling StatusMonitor when following the Azure-AsyncOperation url |
| FinalResult | The type of the logical result when following the location header |
| PollingUrlValue | The value type of the link to the status monitor |
| FinalUrlValue | The value type fo the link to the final result |
| FinalUrlValue | The value type of the link to the final result |

#### Examples

Expand Down Expand Up @@ -426,7 +426,7 @@ model Azure.ResourceManager.ArmResourceCreatedResponse<Resource, LroHeaders>

| Name | Description |
| ---------- | ---------------------------------------------------------- |
| Resource | The resource being updated |
| Resource | The resource being created |
| LroHeaders | Optional. The lro headers returned with a Created response |

#### Examples
Expand Down Expand Up @@ -463,7 +463,7 @@ model Azure.ResourceManager.ArmResourceCreatedSyncResponse<Resource>

| Name | Description |
| -------- | -------------------------- |
| Resource | The resource being updated |
| Resource | The resource being created |

#### Examples

Expand Down
2 changes: 1 addition & 1 deletion .../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 @@ -235,7 +235,7 @@ of the operations will be grouped based on the interface name in generated
clients.

The optional `resourceOperationOptions` parameter provides additional options.
`allowStaticRoutes` turns off autoRout for the interface, so individual operations can
`allowStaticRoutes` turns off autoRoute for the interface, so individual operations can
choose static (`@route`) or automatic (`@autoRoute`) routing.

`resourceType: Model` specifies the resource type for the operations in the interface
Expand Down
18 changes: 9 additions & 9 deletions .../src/content/docs/docs/libraries/azure-resource-manager/reference/interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1621,7 +1621,7 @@ op Azure.ResourceManager.ArmTagsPatchSync(properties: Azure.ResourceManager.Foun

Adds check global name availability operation, normally used if
a resource name must be globally unique (for example, if the resource
exposes and endpoint that uses the resource name in the url)
exposes an endpoint that uses the resource name in the url)

```typespec
op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced", body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse
Expand All @@ -1639,7 +1639,7 @@ op Azure.ResourceManager.checkGlobalNameAvailability(apiVersion: string, subscri

Adds check location-specific name availability operation, normally used if
a resource name must be globally unique (for example, if the resource
exposes and endpoint that uses the resource name in the url)
exposes an endpoint that uses the resource name in the url)

```typespec
op Azure.ResourceManager.checkLocalNameAvailability(apiVersion: string, subscriptionId: Azure.Core.uuid, provider: "Microsoft.ThisWillBeReplaced", location: Azure.Core.azureLocation, body: Request): Response | Azure.ResourceManager.CommonTypes.ErrorResponse
Expand Down Expand Up @@ -1717,7 +1717,7 @@ op Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfiguration

#### `NspConfigurationOperations.ListSinglePageByParent` {#Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>.ListSinglePageByParent}

List the network security parameter configuration for a resource without pagination - this should only be used for legacy operations
List the network security perimeter configuration for a resource without pagination - this should only be used for legacy operations

```typespec
op Azure.ResourceManager.CommonTypes.NspConfigurationOperations<NspConfigurationResourceModel, NspConfigurationKeyName, ResourceName, ResourceParameter>.ListSinglePageByParent(provider: "Microsoft.ThisWillBeReplaced"): Response | Error
Expand Down Expand Up @@ -2307,7 +2307,7 @@ op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionP

| Name | Description |
| -------------------- | ----------------------------------------------------------------------- |
| Resource | the resource being created or updated |
| Resource | the resource being updated |
| PatchModel | the PATCH request model |
| LroHeaders | Optional. Allows overriding the lro headers returned on resource create |
| Parameters | Optional. Additional parameters after the path parameters |
Expand All @@ -2329,7 +2329,7 @@ op Azure.ResourceManager.Legacy.ExtensionOperations<TargetParameters, ExtensionP

| Name | Description |
| -------------------- | ----------------------------------------------------------------- |
| Resource | the resource being created or updated |
| Resource | the resource being updated |
| PatchModel | the PATCH request model |
| Parameters | Optional. Additional parameters after the path parameters |
| Response | Optional. The success response(s) for the PATCH operation |
Expand Down Expand Up @@ -2512,7 +2512,7 @@ interface Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, Resour
| --------------------- | -------------------------------------------------------------------------------- |
| ParentParameters | The path parameters for the resource parent |
| ResourceTypeParameter | The path parameter for the resource name |
| ErrorType | Optional. The type of error models used in operations created form this template |
| ErrorType | Optional. The type of error models used in operations created from this template |
| ResourceName | Optional. The name of the resource type described in this template |

#### `LegacyOperations.CreateOrUpdateAsync` {#Azure.ResourceManager.Legacy.LegacyOperations<ParentParameters, ResourceTypeParameter, ErrorType, ResourceName>.CreateOrUpdateAsync}
Expand Down Expand Up @@ -2652,7 +2652,7 @@ interface Azure.ResourceManager.Legacy.RoutedOperations<ParentParameters, Resour
| --------------------- | -------------------------------------------------------------------------------- |
| ParentParameters | The path parameters for the resource parent |
| ResourceTypeParameter | The path parameter for the resource name |
| ErrorType | Optional. The type of error models used in operations created form this template |
| ErrorType | Optional. The type of error models used in operations created from this template |
| ResourceRoute | Optional. The resource route to use for operations in the interface. |
| RoutedResourceName | Optional. The name of the resource type described in this template |

Expand Down Expand Up @@ -2913,7 +2913,7 @@ op Azure.ResourceManager.Legacy.ArmListSinglePageByParent(provider: "Microsoft.T

| Name | Description |
| ------------------ | --------------------------------------------------------- |
| Resource | the resource being patched |
| Resource | the resource being listed |
| BaseParameters | Optional. Allows overriding the operation parameters |
| ParentName | Optional. The name of the parent resource |
| ParentFriendlyName | Optional. The friendly name of the parent resource |
Expand All @@ -2933,7 +2933,7 @@ op Azure.ResourceManager.Legacy.ArmListSinglePageBySubscription(apiVersion: stri

| Name | Description |
| ---------- | --------------------------------------------------------- |
| Resource | the resource being patched |
| Resource | the resource being listed |
| Parameters | Optional. Additional parameters after the path parameters |
| Response | Optional. The success response for the list operation |
| Error | Optional. The error response, if non-standard. |
Expand Down
Loading