[mgmt] iotoperations ga (Azure#32203)

Azure/sdk-release-request#5781

sdk/iotoperations/arm-iotoperations/CHANGELOG.md

@@ -1,17 +1,7 @@
 # Release History
-
-## 1.0.0-beta.2 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
-## 1.0.0-beta.1 (2024-10-23)
+
+## 1.0.0 (2024-12-13)
 
 ### Features Added
 
-Initial release of the Azure IotOperations package
+This is the first stable version with the package of @azure/arm-iotoperations

sdk/iotoperations/arm-iotoperations/README.md

@@ -4,8 +4,12 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
 
 Microsoft.IoTOperations Resource Provider management API.
 
-[Package (NPM)](https://www.npmjs.com/package/@azure/arm-iotoperations) |
-[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-iotoperations?view=azure-node-preview) |
+Key links:
+
+- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/iotoperations/arm-iotoperations)
+- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-iotoperations)
+- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-iotoperations?view=azure-node-preview)
+- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/iotoperations/arm-iotoperations/samples)
 
 ## Getting started
 
@@ -42,7 +46,6 @@ npm install @azure/identity
 ```
 
 You will also need to **register a new AAD application and grant access to Azure IoTOperations** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
-Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
 
 For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
 
@@ -62,8 +65,8 @@ const client = new IoTOperationsClient(new DefaultAzureCredential(), subscriptio
 // const client = new IoTOperationsClient(credential, subscriptionId);
 ```
 
-### JavaScript Bundle
 
+### 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
@@ -85,6 +88,10 @@ setLogLevel("info");
 
 For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
+## Next steps
+
+Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/iotoperations/arm-iotoperations/samples) directory for detailed examples on how to use this library.
+
 ## Contributing
 
 If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.

sdk/iotoperations/arm-iotoperations/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "js",
   "TagPrefix": "js/iotoperations/arm-iotoperations",
-  "Tag": "js/iotoperations/arm-iotoperations_f94fba0d51"
+  "Tag": "js/iotoperations/arm-iotoperations_eb2e7b6b53"
 }

sdk/iotoperations/arm-iotoperations/eslint.config.mjs

@@ -0,0 +1,17 @@
+import azsdkEslint from "@azure/eslint-plugin-azure-sdk";
+
+export default [
+  ...azsdkEslint.configs.recommended,
+  {
+    rules: {
+      "@azure/azure-sdk/ts-modules-only-named": "warn",
+      "@azure/azure-sdk/ts-apiextractor-json-types": "warn",
+      "@azure/azure-sdk/ts-package-json-types": "warn",
+      "@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
+      "@azure/azure-sdk/ts-package-json-module": "off",
+      "@azure/azure-sdk/ts-package-json-files-required": "off",
+      "@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
+      "tsdoc/syntax": "warn",
+    },
+  },
+];

sdk/iotoperations/arm-iotoperations/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/arm-iotoperations",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0",
   "description": "A generated SDK for IoTOperationsClient.",
   "engines": {
     "node": ">=18.0.0"
@@ -47,6 +47,7 @@
   "bugs": {
     "url": "https://github.com/Azure/azure-sdk-for-js/issues"
   },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/iotoperations/arm-iotoperations/README.md",
   "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
   "//metadata": {
     "constantPaths": [
@@ -68,6 +69,7 @@
   },
   "devDependencies": {
     "dotenv": "^16.0.0",
+    "@microsoft/api-extractor": "^7.40.3",
     "@types/node": "^18.0.0",
     "eslint": "^9.9.0",
     "typescript": "~5.7.2",
@@ -103,7 +105,8 @@
     "build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
     "build": "npm run clean && dev-tool run build-package && dev-tool run vendored mkdirp ./review && dev-tool run extract-api",
     "test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
-    "test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test"
+    "test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test",
+    "update-snippets": "echo skipped"
   },
   "//sampleConfiguration": {
     "productName": "@azure/arm-iotoperations",

sdk/iotoperations/arm-iotoperations/review/arm-iotoperations-models.api.md

@@ -4,9 +4,6 @@
 
 ```ts
 
-// @public
-export type AccessTokenMethod = string;
-
 // @public
 export type ActionType = string;
 
@@ -17,9 +14,6 @@ export interface AdvancedSettings {
     internalCerts?: CertManagerCertOptions;
 }
 
-// @public
-export type AnonymousMethod = string;
-
 // @public
 export interface AuthorizationConfig {
     cache?: OperationalMode;
@@ -222,7 +216,7 @@ export type CloudEventAttributeType = string;
 export type CreatedByType = string;
 
 // @public
-export type DataExplorerAuthMethod = ManagedIdentityMethod;
+export type DataExplorerAuthMethod = string;
 
 // @public
 export interface DataflowBuiltInTransformationDataset {
@@ -491,7 +485,7 @@ export interface DataflowSourceOperationSettings {
 }
 
 // @public
-export type DataLakeStorageAuthMethod = ManagedIdentityMethod | AccessTokenMethod;
+export type DataLakeStorageAuthMethod = string;
 
 // @public
 export interface DiagnosticsLogs {
@@ -518,7 +512,7 @@ export interface ExtendedLocation {
 export type ExtendedLocationType = string;
 
 // @public
-export type FabricOneLakeAuthMethod = ManagedIdentityMethod;
+export type FabricOneLakeAuthMethod = string;
 
 // @public
 export type FilterType = string;
@@ -556,23 +550,13 @@ export interface InstanceResource extends TrackedResource {
 }
 
 // @public
-export type KafkaAuthMethod = ManagedIdentityMethod | SaslMethod | X509CertificateMethod | AnonymousMethod;
-
-// @public
-export enum KnownAccessTokenMethod {
-    AccessToken = "AccessToken"
-}
+export type KafkaAuthMethod = string;
 
 // @public
 export enum KnownActionType {
     Internal = "Internal"
 }
 
-// @public
-export enum KnownAnonymousMethod {
-    Anonymous = "Anonymous"
-}
-
 // @public
 export enum KnownBrokerAuthenticationMethod {
     Custom = "Custom",
@@ -621,6 +605,12 @@ export enum KnownCreatedByType {
     User = "User"
 }
 
+// @public
+export enum KnownDataExplorerAuthMethod {
+    SystemAssignedManagedIdentity = "SystemAssignedManagedIdentity",
+    UserAssignedManagedIdentity = "UserAssignedManagedIdentity"
+}
+
 // @public
 export enum KnownDataflowEndpointAuthenticationSaslType {
     Plain = "Plain",
@@ -666,6 +656,13 @@ export enum KnownDataflowMappingType {
     Rename = "Rename"
 }
 
+// @public
+export enum KnownDataLakeStorageAuthMethod {
+    AccessToken = "AccessToken",
+    SystemAssignedManagedIdentity = "SystemAssignedManagedIdentity",
+    UserAssignedManagedIdentity = "UserAssignedManagedIdentity"
+}
+
 // @public
 export enum KnownEndpointType {
     DataExplorer = "DataExplorer",
@@ -681,15 +678,24 @@ export enum KnownExtendedLocationType {
     CustomLocation = "CustomLocation"
 }
 
+// @public
+export enum KnownFabricOneLakeAuthMethod {
+    SystemAssignedManagedIdentity = "SystemAssignedManagedIdentity",
+    UserAssignedManagedIdentity = "UserAssignedManagedIdentity"
+}
+
 // @public
 export enum KnownFilterType {
     Filter = "Filter"
 }
 
 // @public
-export enum KnownManagedIdentityMethod {
+export enum KnownKafkaAuthMethod {
+    Anonymous = "Anonymous",
+    Sasl = "Sasl",
     SystemAssignedManagedIdentity = "SystemAssignedManagedIdentity",
-    UserAssignedManagedIdentity = "UserAssignedManagedIdentity"
+    UserAssignedManagedIdentity = "UserAssignedManagedIdentity",
+    X509Certificate = "X509Certificate"
 }
 
 // @public
@@ -700,6 +706,15 @@ export enum KnownManagedServiceIdentityType {
     UserAssigned = "UserAssigned"
 }
 
+// @public
+export enum KnownMqttAuthMethod {
+    Anonymous = "Anonymous",
+    ServiceAccountToken = "ServiceAccountToken",
+    SystemAssignedManagedIdentity = "SystemAssignedManagedIdentity",
+    UserAssignedManagedIdentity = "UserAssignedManagedIdentity",
+    X509Certificate = "X509Certificate"
+}
+
 // @public
 export enum KnownMqttRetainType {
     Keep = "Keep",
@@ -762,16 +777,6 @@ export enum KnownProvisioningState {
     Updating = "Updating"
 }
 
-// @public
-export enum KnownSaslMethod {
-    Sasl = "Sasl"
-}
-
-// @public
-export enum KnownServiceAccountTokenMethod {
-    ServiceAccountToken = "ServiceAccountToken"
-}
-
 // @public
 export enum KnownServiceType {
     ClusterIp = "ClusterIp",
@@ -818,8 +823,8 @@ export enum KnownTransformationSerializationFormat {
 }
 
 // @public
-export enum KnownX509CertificateMethod {
-    X509Certificate = "X509Certificate"
+export enum KnownVersions {
+    "V2024-11-01" = "2024-11-01"
 }
 
 // @public
@@ -847,9 +852,6 @@ export interface LocalKubernetesReference {
     name: string;
 }
 
-// @public
-export type ManagedIdentityMethod = string;
-
 // @public
 export interface ManagedServiceIdentity {
     readonly principalId?: string;
@@ -867,7 +869,7 @@ export interface Metrics {
 }
 
 // @public
-export type MqttAuthMethod = ManagedIdentityMethod | ServiceAccountTokenMethod | X509CertificateMethod | AnonymousMethod;
+export type MqttAuthMethod = string;
 
 // @public
 export type MqttRetainType = string;
@@ -941,9 +943,6 @@ export interface SanForCert {
     ip: string[];
 }
 
-// @public
-export type SaslMethod = string;
-
 // @public
 export interface SchemaRegistryRef {
     resourceId: string;
@@ -962,9 +961,6 @@ export interface SelfTracing {
     mode?: OperationalMode;
 }
 
-// @public
-export type ServiceAccountTokenMethod = string;
-
 // @public
 export type ServiceType = string;
 
@@ -1073,9 +1069,6 @@ export interface VolumeClaimSpecSelectorMatchExpressions {
     values?: string[];
 }
 
-// @public
-export type X509CertificateMethod = string;
-
 // @public
 export interface X509ManualCertificate {
     secretRef: string;