@azure-tools/typespec-azure-resource-manager 0.71.0-dev.13 → 0.71.0-dev.15

package/README.md

@@ -700,7 +700,7 @@ multiple base types. Duplicate entries are ignored.
 
 ```typespec
 // Agent definition and properties using the Appliance deployment model
-model ContosoApplianceDefinition is AgentDefinitionAppliance<true, true>;
+model ContosoApplianceDefinition is AgentDefinitionAppliance<true>;
 model ContosoApplianceProperties is AgentPropertiesAppliance<ContosoApplianceDefinition> {
   ...DefaultProvisioningStateProperty;
 }

package/dist/generated-defs/Azure.ResourceManager.BaseTypes.d.ts

@@ -15,7 +15,7 @@ export interface BaseTypeInfo {
  * @example
  * ```typespec
  * // Agent definition and properties using the Appliance deployment model
- * model ContosoApplianceDefinition is AgentDefinitionAppliance<true, true>;
+ * model ContosoApplianceDefinition is AgentDefinitionAppliance<true>;
  * model ContosoApplianceProperties is AgentPropertiesAppliance<ContosoApplianceDefinition> {
  *   ...DefaultProvisioningStateProperty;
  * }

package/lib/base-types/agent.tsp

@@ -56,15 +56,11 @@ internal model AgentDefinition {
 /**
  * Appliance deployment model of AgentDefinition.
  * Properties controlled by `@baseTypeOptional` are invisible when the corresponding
- * template parameter is false. When present, `instructions` is read-only while
- * `modelDeploymentRef` stays writable so the client can point the agent at a model deployment.
- * @template HasModelDeploymentRef Whether the modelDeploymentRef property is present.
+ * template parameter is false, or read-only when present. The appliance owns the whole
+ * agent definition, so there is no `modelDeploymentRef` property in this deployment model.
  * @template HasInstructions Whether the instructions property is present.
  */
-model AgentDefinitionAppliance<
-  HasModelDeploymentRef extends valueof boolean = false,
-  HasInstructions extends valueof boolean = false
-> {
+model AgentDefinitionAppliance<HasInstructions extends valueof boolean = false> {
   /** Model identifier (RP-defined). */
   @visibility(Lifecycle.Read)
   `model`: string;
@@ -72,10 +68,6 @@ model AgentDefinitionAppliance<
   /** System prompt / behavioral instructions for the agent. */
   @baseTypeOptional(HasInstructions, true)
   instructions: string;
-
-  /** Optional RP-specific reference to an underlying model deployment. Writable in both deployment models. */
-  @baseTypeOptional(HasModelDeploymentRef, false)
-  modelDeploymentRef?: string;
 }
 
 /**
@@ -126,10 +118,7 @@ internal model AgentProperties {
 
 /**
  * Appliance deployment model of AgentProperties.
- * All properties are read-only (the appliance owns and reports state), except the `definition`
- * container itself: it stays writable so the client can send the fields the agent definition
- * marks as writable, such as `modelDeploymentRef`. Every service-owned field inside the
- * definition remains read-only.
+ * All properties are read-only (the appliance owns and reports state).
  * @template AgentDefinitionType The user-defined agent definition model (must extend AgentDefinition).
  */
 model AgentPropertiesAppliance<AgentDefinitionType extends AgentDefinition> {
@@ -145,7 +134,8 @@ model AgentPropertiesAppliance<AgentDefinitionType extends AgentDefinition> {
   @visibility(Lifecycle.Read)
   description: string;
 
-  /** Inline agent definition. The container is writable so the client can set the definition fields that are not service-owned. */
+  /** Inline agent definition. */
+  @visibility(Lifecycle.Read)
   definition: AgentDefinitionType;
 
   /** Tool bindings. Read-only in the Appliance deployment model. */

package/lib/base-types/base-types.tsp

@@ -44,7 +44,7 @@ model BaseTypeInfo {
  *
  * ```typespec
  * // Agent definition and properties using the Appliance deployment model
- * model ContosoApplianceDefinition is AgentDefinitionAppliance<true, true>;
+ * model ContosoApplianceDefinition is AgentDefinitionAppliance<true>;
  * model ContosoApplianceProperties is AgentPropertiesAppliance<ContosoApplianceDefinition> {
  *   ...DefaultProvisioningStateProperty;
  * }

package/lib/common-types/managed-identity-with-delegation.tsp

@@ -6,6 +6,7 @@ namespace Azure.ResourceManager.CommonTypes;
 /** Managed service identity (system assigned and/or user assigned identities and/or delegated identities) - internal use only. */
 @added(Versions.v4)
 model ManagedServiceIdentityWithDelegation extends ManagedServiceIdentity {
+  /** The delegated resources of the identity - internal use only. */
   delegatedResources?: DelegatedResources;
 }
 

package/lib/common-types/network-security-perimeter.tsp

@@ -24,12 +24,26 @@ union AccessRuleDirection {
 @added(Versions.v5)
 union NetworkSecurityPerimeterConfigurationProvisioningState {
   string,
+
+  /** The configuration was provisioned successfully. */
   Succeeded: "Succeeded",
+
+  /** The configuration is being created. */
   Creating: "Creating",
+
+  /** The configuration is being updated. */
   Updating: "Updating",
+
+  /** The configuration is being deleted. */
   Deleting: "Deleting",
+
+  /** The configuration request was accepted and provisioning has not started yet. */
   Accepted: "Accepted",
+
+  /** The configuration failed to provision. */
   Failed: "Failed",
+
+  /** The configuration provisioning was canceled. */
   Canceled: "Canceled",
 }
 
@@ -55,7 +69,11 @@ union IssueType {
 @added(Versions.v5)
 union Severity {
   string,
+
+  /** The issue is a warning and does not prevent the configuration from being applied. */
   Warning: "Warning",
+
+  /** The issue is an error and prevents the configuration from being applied. */
   Error: "Error",
 }
 
@@ -95,12 +113,14 @@ model AccessRule {
   /** Name of the access rule */
   name?: string;
 
+  /** Properties of the access rule */
   properties?: AccessRuleProperties;
 }
 
 /** Properties of Access Rule */
 @added(Versions.v5)
 model AccessRuleProperties {
+  /** Direction of the access rule */
   direction?: AccessRuleDirection;
 
   /** Address prefixes in the CIDR format for inbound rules */
@@ -146,12 +166,14 @@ model NetworkSecurityPerimeter {
 /** Network security perimeter (NSP) configuration resource */
 @added(Versions.v5)
 model NetworkSecurityPerimeterConfiguration extends ProxyResource {
+  /** Network security configuration properties. */
   properties?: NetworkSecurityPerimeterConfigurationProperties;
 }
 
 /** Network security configuration properties. */
 @added(Versions.v5)
 model NetworkSecurityPerimeterConfigurationProperties {
+  /** Provisioning state of the network security perimeter configuration */
   @visibility(Lifecycle.Read)
   provisioningState?: NetworkSecurityPerimeterConfigurationProvisioningState;
 
@@ -160,8 +182,13 @@ model NetworkSecurityPerimeterConfigurationProperties {
   @Azure.ResourceManager.identifiers(#[])
   provisioningIssues?: ProvisioningIssue[];
 
+  /** Information about the network security perimeter (NSP) */
   networkSecurityPerimeter?: NetworkSecurityPerimeter;
+
+  /** Information about the resource association */
   resourceAssociation?: ResourceAssociation;
+
+  /** Network security perimeter configuration profile */
   profile?: NetworkSecurityProfile;
 }
 
@@ -172,6 +199,7 @@ model ProvisioningIssue {
   @visibility(Lifecycle.Read)
   name?: string;
 
+  /** Details of the provisioning issue */
   @visibility(Lifecycle.Read)
   properties?: ProvisioningIssueProperties;
 }
@@ -207,6 +235,7 @@ model ResourceAssociation {
   /** Name of the resource association */
   name?: string;
 
+  /** Access mode of the resource association */
   accessMode?: ResourceAssociationAccessMode;
 }
 

package/lib/common-types/types.tsp

@@ -80,10 +80,14 @@ model ResourceModelWithAllowedPropertySet extends TrackedResource {
   @visibility(Lifecycle.Read)
   etag?: string;
 
+  /** The identity of the resource. */
   @typeChangedFrom(Versions.v6, Identity)
   identity?: ManagedServiceIdentity;
 
+  /** The SKU of the resource. */
   sku?: Sku;
+
+  /** The plan of the resource. */
   plan?: Plan;
 }
 
@@ -346,6 +350,7 @@ union createdByType {
 
 /** Resource Identity Type */
 union ResourceIdentityType {
+  /** The identity is assigned by the system. */
   SystemAssigned: "SystemAssigned",
 }
 

package/lib/extension/parameters.tsp

@@ -173,6 +173,7 @@ model ExternalResource<
   Description extends valueof string = "The name of the resource",
   ParentType extends valueof "Tenant" | "Subscription" | "ResourceGroup" = "ResourceGroup"
 > {
+  /** The name of the resource. */
   @doc(Description)
   @visibility(Lifecycle.Read)
   @path
@@ -223,6 +224,7 @@ model ExternalChildResource<
   NameType extends string = string,
   Description extends valueof string = "The name of the resource"
 > {
+  /** The name of the resource. */
   @doc(Description)
   @visibility(Lifecycle.Read)
   @path

package/lib/foundations/arm.foundations.tsp

@@ -190,6 +190,7 @@ model ProxyResourceUpdateModel<
   Resource extends Foundations.SimpleResource,
   Properties extends TypeSpec.Reflection.Model
 > {
+  /** The resource-specific properties for this resource. */
   properties?: ResourceUpdateModelProperties<Resource, Properties>;
 }
 

package/lib/interfaces.tsp

@@ -33,11 +33,12 @@ interface Operations {
 }
 
 /**
- * @deprecated Use Azure.ResourceManager.TrackedResourceOperations instead
  * A composite interface for resources that include `ResourceInstanceOperations<Resource, Properties>`
  * and `ResourceCollectionOperations<Resource>`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent,
  * ListBySubscription operations. The actual route depends on the resource model.
  * This is the most common API pattern for Tracked Resources to use.
+ *
+ * Deprecated: use `Azure.ResourceManager.TrackedResourceOperations` instead.
  * @template Resource the ArmResource that provides these operations
  * @template Properties RP-specific property bag for the resource
  * @template BaseParameters The http parameters that are part of the request
@@ -147,7 +148,6 @@ interface ResourceCollectionOperations<
 interface ResourceListBySubscription<Resource extends Foundations.SimpleResource> {
   /**
    * List resources by subscription.
-   * @template Resource The ArmResource to list.
    */
   @doc("List {name} resources by subscription ID", Resource)
   listBySubscription is ArmListBySubscription<Resource>;
@@ -168,10 +168,6 @@ interface ResourceListByParent<
 > {
   /**
    * List resources by parent.
-   * @template Resource The ArmResource to list.
-   * @template BaseParameters The http parameters that are part of the request
-   * @template ParentName The name of the parent resource
-   * @template ParentFriendlyName The friendly name of the parent resource
    */
   @Private.armRenameListByOperation(Resource, ParentName, ParentFriendlyName, true) // This must come before @armResourceList!
   listByParent is ArmResourceListByParent<Resource, BaseParameters, ParentName, ParentFriendlyName>;
@@ -188,8 +184,6 @@ interface ResourceRead<
 > {
   /**
    * Retrieve a resource.
-   * @template Resource The ArmResource to retrieve.
-   * @template BaseParameters The http parameters that are part of the request
    */
   @doc("Get a {name}", Resource)
   get is ArmResourceRead<Resource, BaseParameters>;
@@ -206,8 +200,6 @@ interface ResourceCreateSync<
 > {
   /**
    * Create or update a resource using the synchronous call pattern.
-   * @template Resource The ArmResource to create or update.
-   * @template BaseParameters The http parameters that are part of the request
    */
   @doc("Create a {name}", Resource)
   createOrUpdate is ArmResourceCreateOrReplaceSync<Resource, BaseParameters>;
@@ -224,8 +216,6 @@ interface ResourceCreateAsync<
 > {
   /**
    * Create or update a resource using the asynchronous call pattern.
-   * @template Resource The ArmResource to create or update.
-   * @template BaseParameters The http parameters that are part of the request
    */
   @doc("Create a {name}", Resource)
   createOrUpdate is ArmResourceCreateOrUpdateAsync<Resource, BaseParameters>;
@@ -245,8 +235,6 @@ interface ResourceDeleteAsync<
 > {
   /**
    * Delete a resource using the asynchronous call pattern.
-   * @template Resource The ArmResource to delete.
-   * @template BaseParameters The http parameters that are part of the request
    */
   @doc("Delete a {name}", Resource)
   delete is ArmResourceDeleteAsync<Resource, BaseParameters>;
@@ -265,8 +253,6 @@ interface ResourceDeleteWithoutOkAsync<
 > {
   /**
    * Delete a resource using the asynchronous call pattern.
-   * @template Resource The ArmResource to delete.
-   * @template BaseParameters The http parameters that are part of the request
    */
   @doc("Delete a {name}", Resource)
   delete is ArmResourceDeleteWithoutOkAsync<Resource, BaseParameters>;
@@ -284,8 +270,6 @@ interface ResourceDeleteSync<
 > {
   /**
    * Delete a resource using the synchronous call pattern.
-   * @template Resource The ArmResource to delete.
-   * @template BaseParameters The http parameters that are part of the request
    */
   @doc("Delete a {name}", Resource)
   delete is ArmResourceDeleteSync<Resource, BaseParameters>;
@@ -305,9 +289,6 @@ interface ResourceUpdateAsync<
 > {
   /**
    * Update a resource using the asynchronous call pattern.
-   * @template Resource The ArmResource to update.
-   * @template Properties RP-specific property bag for the resource
-   * @template BaseParameters The http parameters that are part of the request
    */
   @doc("Update a {name}", Resource)
   update is ArmCustomPatchAsync<
@@ -331,9 +312,6 @@ interface ResourceUpdateSync<
 > {
   /**
    * Update a resource using the synchronous call pattern.
-   * @template Resource The ArmResource to update.
-   * @template Properties RP-specific property bag for the resource
-   * @template BaseParameters The http parameters that are part of the request
    */
   #suppress "@typespec/http/deprecated-implicit-optionality" "Legacy"
   @patch(#{ implicitOptionality: true })

package/lib/legacy-types/resource.tsp

@@ -70,6 +70,7 @@ alias EntityTagProperty = {
  * ```
  */
 model ExtendedLocationOptionalProperty {
+  /** The extended location of the resource. */
   @visibility(Lifecycle.Read, Lifecycle.Create)
   extendedLocation?: ExtendedLocationOptional;
 }

package/lib/models.tsp

@@ -11,7 +11,7 @@ namespace Azure.ResourceManager;
  * is specified, the resource name will be properly camel cased and pluralized for `@key` and `@segment`
  * automatically. You can also apply explicit override with `KeyName` and `SegmentName` template parameters.
  *
- * For additional decorators such as @minLength, you can use either augment decorator on `[Resource].name` or passing in a scalar string type with decorators.
+ * For additional decorators such as `@minLength`, you can use either augment decorator on `[Resource].name` or passing in a scalar string type with decorators.
  *
  * @template Resource The ARM resource this name parameter is applying to.
  * @template KeyName Override default key name of the resource.
@@ -229,6 +229,7 @@ model DefaultProvisioningStateProperty {
  * ```
  */
 model ExtendedLocationProperty {
+  /** The extended location of the resource. */
   @visibility(Lifecycle.Read, Lifecycle.Create)
   extendedLocation?: Foundations.ExtendedLocation;
 }

package/lib/private-endpoints.tsp

@@ -60,8 +60,6 @@ interface PrivateEndpoints<
    * @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.

package/lib/private-links.tsp

@@ -10,7 +10,6 @@ namespace Azure.ResourceManager;
  * Resource providers must declare a private link resource type in their provider namespace if
  * they support private link resources
  * @template Description Optional. The documentary description of the private link resource name parameter.
- * @template KeyName Optional. The name of the private link resource name parameter.
  * @example
  * ```ts
  * namespace Microsoft.Contoso;
@@ -61,8 +60,6 @@ interface PrivateLinks<
    * @template ParentResource the parent resource of the PrivateLink
    * @template Resource Optional. The PrivateLink 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.
@@ -95,8 +92,6 @@ interface PrivateLinks<
    * @template ParentResource the parent resource of the PrivateLink
    * @template Resource Optional. The PrivateLink 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.71.0-dev.13",
+  "version": "0.71.0-dev.15",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -47,15 +47,15 @@
     "pluralize": "^8.0.0"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.70.0 || >= 0.71.0-dev.4",
+    "@azure-tools/typespec-azure-core": "^0.70.0 || >= 0.71.0-dev.7",
     "@typespec/compiler": "^1.14.0",
-    "@typespec/openapi": "^1.14.0",
-    "@typespec/versioning": "^0.84.0",
     "@typespec/http": "^1.14.0",
-    "@typespec/rest": "^0.84.0"
+    "@typespec/rest": "^0.84.0",
+    "@typespec/openapi": "^1.14.0",
+    "@typespec/versioning": "^0.84.0"
   },
   "devDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.70.0 || >= 0.71.0-dev.4",
+    "@azure-tools/typespec-azure-core": "^0.70.0 || >= 0.71.0-dev.7",
     "@types/node": "^26.0.0",
     "@types/pluralize": "^0.0.33",
     "@vitest/coverage-v8": "^4.1.3",
@@ -63,12 +63,12 @@
     "rimraf": "^6.1.3",
     "typescript": "~6.0.2",
     "vitest": "^4.1.3",
-    "@typespec/compiler": "^1.14.0",
     "@typespec/http": "^1.14.0",
     "@typespec/rest": "^0.84.0",
+    "@typespec/library-linter": "^0.84.0",
     "@typespec/tspd": "^0.76.0",
     "@typespec/versioning": "^0.84.0",
-    "@typespec/library-linter": "^0.84.0",
+    "@typespec/compiler": "^1.14.0",
     "@typespec/openapi": "^1.14.0"
   },
   "scripts": {