Update TypeSpec for DeviceRegistry (#29319)

* Update TypeSpec for DeviceRegistry * add client.tsp * fix model validation * fix example * fix example * remove unused csharp option * update client.tsp * fix tsp validation * fix more tsp validation * update csharp option
Azure · Jun 11, 2024 · d1bbbb3 · d1bbbb3
1 parent e9f47ec
commit d1bbbb3
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 235 deletions.
diff --git a/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp b/specification/deviceregistry/DeviceRegistry.Management/assetEndpointProfiles.tsp
@@ -122,10 +122,8 @@ interface AssetEndpointProfiles {
 
   createOrReplace is ArmResourceCreateOrReplaceAsync<AssetEndpointProfile>;
 
-  update is ArmResourcePatchAsync<
-    AssetEndpointProfile,
-    AssetEndpointProfileProperties
-  >;
+  @parameterVisibility
+  update is ArmCustomPatchAsync<AssetEndpointProfile, AssetEndpointProfile>;
 
   delete is ArmResourceDeleteWithoutOkAsync<AssetEndpointProfile>;
 

diff --git a/specification/deviceregistry/DeviceRegistry.Management/assets.tsp b/specification/deviceregistry/DeviceRegistry.Management/assets.tsp
@@ -56,7 +56,7 @@ model AssetProperties {
 
   @doc("A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must have the format <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>.")
   @visibility("read", "create")
-  assetEndpointProfileUri: string;
+  assetEndpointProfileUri: url;
 
   @doc("An integer that is incremented each time the resource is modified.")
   @visibility("read")
@@ -66,7 +66,7 @@ model AssetProperties {
   manufacturer?: string;
 
   @doc("Asset manufacturer URI.")
-  manufacturerUri?: string;
+  manufacturerUri?: url;
 
   @doc("Asset model name.")
   // `model` is a reserved keyname. Wrap in double quotes
@@ -82,7 +82,7 @@ model AssetProperties {
   softwareRevision?: string;
 
   @doc("Reference to the documentation.")
-  documentationUri?: string;
+  documentationUri?: url;
 
   @doc("Asset serial number.")
   serialNumber?: string;
@@ -207,7 +207,8 @@ interface Assets {
 
   createOrReplace is ArmResourceCreateOrReplaceAsync<Asset>;
 
-  update is ArmResourcePatchAsync<Asset, AssetProperties>;
+  @parameterVisibility
+  update is ArmCustomPatchAsync<Asset, Asset>;
 
   delete is ArmResourceDeleteWithoutOkAsync<Asset>;
 

diff --git a/specification/deviceregistry/DeviceRegistry.Management/client.tsp b/specification/deviceregistry/DeviceRegistry.Management/client.tsp
@@ -0,0 +1,18 @@
+import "./main.tsp";
+import "@azure-tools/typespec-client-generator-core";
+
+using Azure.ClientGenerator.Core;
+
+namespace Microsoft.DeviceRegistry;
+
+@@clientName(Asset, "DeviceRegistryAsset", "csharp");
+@@clientName(AssetEndpointProfile,
+  "DeviceRegistryAssetEndpointProfile",
+  "csharp"
+);
+@@clientName(ExtendedLocation, "DeviceRegistryExtendedLocation", "csharp");
+@@clientName(Event, "AssetEvent", "csharp");
+@@clientName(ProvisioningState, "DeviceRegistryProvisioningState", "csharp");
+@@clientName(ExtendedLocation.type, "ExtendedLocationType", "csharp");
+@@access(OperationStatus.get, Access.internal, "csharp");
+@@access(Operations.list, Access.internal, "csharp");
diff --git a/...on/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json b/...on/deviceregistry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_Asset.json
@@ -8,9 +8,15 @@
     "resourceGroupName": "myResourceGroup",
     "assetName": "my-asset",
     "properties": {
+      "location": "West Europe",
       "properties": {
         "enabled": false,
-        "displayName": "NewAssetDisplayName"
+        "displayName": "NewAssetDisplayName",
+        "assetEndpointProfileUri": "https://www.example.com/myAssetEndpointProfile"
+      },
+      "extendedLocation": {
+        "type": "CustomLocation",
+        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
       }
     }
   },

diff --git a/...ry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json b/...ry/DeviceRegistry.Management/examples/2023-11-01-preview/Update_AssetEndpointProfile.json
@@ -8,8 +8,13 @@
     "resourceGroupName": "myResourceGroup",
     "assetEndpointProfileName": "my-assetendpointprofile",
     "properties": {
+      "location": "West Europe",
       "properties": {
         "targetAddress": "https://www.example.com/myTargetAddress"
+      },
+      "extendedLocation": {
+        "type": "CustomLocation",
+        "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/location1"
       }
     }
   },

diff --git a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml
@@ -17,6 +17,10 @@ options:
     namespace: "com.azure.resourcemanager.deviceregistry"
     service-name: "Device Registry"
     examples-directory: "examples"
+  "@azure-tools/typespec-csharp":
+    package-dir: "Azure.ResourceManager.DeviceRegistry"
+    namespace: "{package-dir}"
+    flavor: "azure"
 linter:
   extends:
     - "@azure-tools/typespec-azure-rulesets/resource-manager"