[appcomplianceautomation] Update snippets (#32477)

### Packages impacted by this PR - @azure/arm-appcomplianceautomation ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all `appcomplianceautomation` projects to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
Azure · Jan 9, 2025 · ef1cfa3 · ef1cfa3
1 parent 1093f4a
commit ef1cfa3
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 44 deletions.
diff --git a/sdk/appcomplianceautomation/arm-appcomplianceautomation/README.md b/sdk/appcomplianceautomation/arm-appcomplianceautomation/README.md
@@ -48,23 +48,35 @@ Set the values of the client ID, tenant ID, and client secret of the AAD applica
 
 For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
 
-```javascript
-const { AppComplianceAutomationToolForMicrosoft365 } = require("@azure/arm-appcomplianceautomation");
-const { DefaultAzureCredential } = require("@azure/identity");
-// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
-
-const client = new AppComplianceAutomationToolForMicrosoft365(new DefaultAzureCredential());
-
-// For client-side applications running in the browser, use this code instead:
-// const credential = new InteractiveBrowserCredential({
-//   tenantId: "<YOUR_TENANT_ID>",
-//   clientId: "<YOUR_CLIENT_ID>"
-// });
-// const client = new AppComplianceAutomationToolForMicrosoft365(credential);
+Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.
+
+```ts snippet:ReadmeSampleCreateClient_Node
+import { AppComplianceAutomationToolForMicrosoft365 } from "@azure/arm-appcomplianceautomation";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const subscriptionId = "00000000-0000-0000-0000-000000000000";
+const client = new AppComplianceAutomationToolForMicrosoft365(
+  new DefaultAzureCredential(),
+  subscriptionId,
+);
 ```
 
+For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.
+
+```ts snippet:ReadmeSampleCreateClient_Browser
+import { InteractiveBrowserCredential } from "@azure/identity";
+import { AppComplianceAutomationToolForMicrosoft365 } from "@azure/arm-appcomplianceautomation";
+
+const subscriptionId = "00000000-0000-0000-0000-000000000000";
+const credential = new InteractiveBrowserCredential({
+  tenantId: "<YOUR_TENANT_ID>",
+  clientId: "<YOUR_CLIENT_ID>",
+});
+const client = new AppComplianceAutomationToolForMicrosoft365(credential, subscriptionId);
+```
 
 ### JavaScript Bundle
+
 To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
 
 ## Key concepts
@@ -79,8 +91,9 @@ To use this client library in the browser, first you need to use a bundler. For
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
+
 setLogLevel("info");
 ```
 

diff --git a/sdk/appcomplianceautomation/arm-appcomplianceautomation/package.json b/sdk/appcomplianceautomation/arm-appcomplianceautomation/package.json
@@ -8,20 +8,21 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@azure/abort-controller": "^1.0.0",
-    "@azure/core-auth": "^1.6.0",
-    "@azure/core-client": "^1.7.0",
-    "@azure/core-lro": "^2.5.4",
-    "@azure/core-paging": "^1.2.0",
-    "@azure/core-rest-pipeline": "^1.14.0",
-    "tslib": "^2.2.0"
+    "@azure/abort-controller": "^2.1.2",
+    "@azure/core-auth": "^1.9.0",
+    "@azure/core-client": "^1.9.2",
+    "@azure/core-lro": "^2.7.2",
+    "@azure/core-paging": "^1.6.2",
+    "@azure/core-rest-pipeline": "^1.18.1",
+    "tslib": "^2.8.1"
   },
   "keywords": [
     "node",
     "azure",
     "typescript",
     "browser",
-    "isomorphic"
+    "isomorphic",
+    "cloud"
   ],
   "license": "MIT",
   "main": "./dist/commonjs/index.js",
@@ -32,20 +33,16 @@
     "@azure-tools/test-recorder": "^4.1.0",
     "@azure-tools/test-utils-vitest": "^1.0.0",
     "@azure/dev-tool": "^1.0.0",
-    "@azure/identity": "^4.0.1",
+    "@azure/identity": "^4.5.0",
     "@types/node": "^18.0.0",
     "@vitest/browser": "^2.1.8",
     "@vitest/coverage-istanbul": "^2.1.8",
     "dotenv": "^16.0.0",
     "playwright": "^1.49.1",
-    "tsx": "^4.7.1",
     "typescript": "~5.7.2",
     "vitest": "^2.1.8"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Azure/azure-sdk-for-js.git"
-  },
+  "repository": "github:Azure/azure-sdk-for-js",
   "bugs": {
     "url": "https://github.com/Azure/azure-sdk-for-js/issues"
   },
@@ -80,7 +77,7 @@
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "echo skipped",
     "unit-test:node": "dev-tool run test:vitest",
-    "update-snippets": "echo skipped"
+    "update-snippets": "dev-tool run update-snippets"
   },
   "sideEffects": false,
   "//metadata": {

diff --git a/...tomation/arm-appcomplianceautomation/test/appcomplianceautomation_operations_test.spec.ts b/...tomation/arm-appcomplianceautomation/test/appcomplianceautomation_operations_test.spec.ts
@@ -6,17 +6,14 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import {
-  Recorder,
-  RecorderStartOptions,
-  isPlaybackMode,
-} from "@azure-tools/test-recorder";
+import type { RecorderStartOptions } from "@azure-tools/test-recorder";
+import { Recorder, isPlaybackMode } from "@azure-tools/test-recorder";
 import { createTestCredential } from "@azure-tools/test-credential";
-import { AppComplianceAutomationToolForMicrosoft365 } from "../src/appComplianceAutomationToolForMicrosoft365.js"
+import { AppComplianceAutomationToolForMicrosoft365 } from "../src/appComplianceAutomationToolForMicrosoft365.js";
 import { describe, it, assert, beforeEach, afterEach } from "vitest";
 
 const replaceableVariables: Record<string, string> = {
-  SUBSCRIPTION_ID: "88888888-8888-8888-8888-888888888888"
+  SUBSCRIPTION_ID: "88888888-8888-8888-8888-888888888888",
 };
 
 const recorderOptions: RecorderStartOptions = {
@@ -35,24 +32,26 @@ describe("appcomplianceautomation test", () => {
   let recorder: Recorder;
   let client: AppComplianceAutomationToolForMicrosoft365;
 
-  beforeEach(async function (ctx) {
+  beforeEach(async (ctx) => {
     recorder = new Recorder(ctx);
     await recorder.start(recorderOptions);
     // This is an example of how the environment variables are used
     const credential = createTestCredential();
-    client = new AppComplianceAutomationToolForMicrosoft365(credential, recorder.configureClientOptions({}));
+    client = new AppComplianceAutomationToolForMicrosoft365(
+      credential,
+      recorder.configureClientOptions({}),
+    );
   });
 
-  afterEach(async function () {
+  afterEach(async () => {
     await recorder.stop();
   });
 
-  it("operations list test", async function () {
+  it("operations list test", async () => {
     const resArray = new Array();
-    for await (let item of client.operations.list()) {
+    for await (const item of client.operations.list()) {
       resArray.push(item);
     }
     assert.notEqual(resArray.length, 0);
   });
-
-})
+});
diff --git a/sdk/appcomplianceautomation/arm-appcomplianceautomation/test/snippets.spec.ts b/sdk/appcomplianceautomation/arm-appcomplianceautomation/test/snippets.spec.ts
@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { describe, it } from "vitest";
+import { setLogLevel } from "@azure/logger";
+import { DefaultAzureCredential, InteractiveBrowserCredential } from "@azure/identity";
+import { AppComplianceAutomationToolForMicrosoft365 } from "@azure/arm-appcomplianceautomation";
+
+describe("snippets", () => {
+  it("ReadmeSampleCreateClient_Node", async () => {
+    const subscriptionId = "00000000-0000-0000-0000-000000000000";
+    const client = new AppComplianceAutomationToolForMicrosoft365(
+      new DefaultAzureCredential(),
+      subscriptionId,
+    );
+  });
+
+  it("ReadmeSampleCreateClient_Browser", async () => {
+    const subscriptionId = "00000000-0000-0000-0000-000000000000";
+    const credential = new InteractiveBrowserCredential({
+      tenantId: "<YOUR_TENANT_ID>",
+      clientId: "<YOUR_CLIENT_ID>",
+    });
+    const client = new AppComplianceAutomationToolForMicrosoft365(credential, subscriptionId);
+  });
+
+  it("SetLogLevel", async () => {
+    setLogLevel("info");
+  });
+});