@azure/arm-changes 1.0.0

package/src/operations/changes.ts

@@ -0,0 +1,297 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { Changes } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { ChangesClient } from "../changesClient";
+import {
+  ChangeResourceResult,
+  ChangesListNextOptionalParams,
+  ChangesListOptionalParams,
+  ChangesListResponse,
+  ChangesGetOptionalParams,
+  ChangesGetResponse,
+  ChangesListNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing Changes operations. */
+export class ChangesImpl implements Changes {
+  private readonly client: ChangesClient;
+
+  /**
+   * Initialize a new instance of the class Changes class.
+   * @param client Reference to the service client
+   */
+  constructor(client: ChangesClient) {
+    this.client = client;
+  }
+
+  /**
+   * Obtains a list of change resources from the past 14 days for the target resource
+   * @param resourceGroupName The name of the resource group.
+   * @param resourceProviderNamespace The name of the resource provider namespace.
+   * @param resourceType The name of the resource type.
+   * @param resourceName The name of the resource.
+   * @param options The options parameters.
+   */
+  public list(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    options?: ChangesListOptionalParams
+  ): PagedAsyncIterableIterator<ChangeResourceResult> {
+    const iter = this.listPagingAll(
+      resourceGroupName,
+      resourceProviderNamespace,
+      resourceType,
+      resourceName,
+      options
+    );
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: () => {
+        return this.listPagingPage(
+          resourceGroupName,
+          resourceProviderNamespace,
+          resourceType,
+          resourceName,
+          options
+        );
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    options?: ChangesListOptionalParams
+  ): AsyncIterableIterator<ChangeResourceResult[]> {
+    let result = await this._list(
+      resourceGroupName,
+      resourceProviderNamespace,
+      resourceType,
+      resourceName,
+      options
+    );
+    yield result.value || [];
+    let continuationToken = result.nextLink;
+    while (continuationToken) {
+      result = await this._listNext(
+        resourceGroupName,
+        resourceProviderNamespace,
+        resourceType,
+        resourceName,
+        continuationToken,
+        options
+      );
+      continuationToken = result.nextLink;
+      yield result.value || [];
+    }
+  }
+
+  private async *listPagingAll(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    options?: ChangesListOptionalParams
+  ): AsyncIterableIterator<ChangeResourceResult> {
+    for await (const page of this.listPagingPage(
+      resourceGroupName,
+      resourceProviderNamespace,
+      resourceType,
+      resourceName,
+      options
+    )) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Obtains a list of change resources from the past 14 days for the target resource
+   * @param resourceGroupName The name of the resource group.
+   * @param resourceProviderNamespace The name of the resource provider namespace.
+   * @param resourceType The name of the resource type.
+   * @param resourceName The name of the resource.
+   * @param options The options parameters.
+   */
+  private _list(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    options?: ChangesListOptionalParams
+  ): Promise<ChangesListResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        resourceProviderNamespace,
+        resourceType,
+        resourceName,
+        options
+      },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * Obtains the specified change resource for the target resource
+   * @param resourceGroupName The name of the resource group.
+   * @param resourceProviderNamespace The name of the resource provider namespace.
+   * @param resourceType The name of the resource type.
+   * @param resourceName The name of the resource.
+   * @param changeResourceId The ID of the change resource
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    changeResourceId: string,
+    options?: ChangesGetOptionalParams
+  ): Promise<ChangesGetResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        resourceProviderNamespace,
+        resourceType,
+        resourceName,
+        changeResourceId,
+        options
+      },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * ListNext
+   * @param resourceGroupName The name of the resource group.
+   * @param resourceProviderNamespace The name of the resource provider namespace.
+   * @param resourceType The name of the resource type.
+   * @param resourceName The name of the resource.
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
+   */
+  private _listNext(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    nextLink: string,
+    options?: ChangesListNextOptionalParams
+  ): Promise<ChangesListNextResponse> {
+    return this.client.sendOperationRequest(
+      {
+        resourceGroupName,
+        resourceProviderNamespace,
+        resourceType,
+        resourceName,
+        nextLink,
+        options
+      },
+      listNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Resources/changes",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ChangeResourceListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.top,
+    Parameters.skipToken
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceProviderNamespace,
+    Parameters.resourceType,
+    Parameters.resourceName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Resources/changes/{changeResourceId}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ChangeResourceResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceProviderNamespace,
+    Parameters.resourceType,
+    Parameters.resourceName,
+    Parameters.changeResourceId
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const listNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.ChangeResourceListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.top,
+    Parameters.skipToken
+  ],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.resourceProviderNamespace,
+    Parameters.resourceType,
+    Parameters.resourceName,
+    Parameters.nextLink
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+export * from "./changes";

package/src/operationsInterfaces/changes.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import {
+  ChangeResourceResult,
+  ChangesListOptionalParams,
+  ChangesGetOptionalParams,
+  ChangesGetResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Changes. */
+export interface Changes {
+  /**
+   * Obtains a list of change resources from the past 14 days for the target resource
+   * @param resourceGroupName The name of the resource group.
+   * @param resourceProviderNamespace The name of the resource provider namespace.
+   * @param resourceType The name of the resource type.
+   * @param resourceName The name of the resource.
+   * @param options The options parameters.
+   */
+  list(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    options?: ChangesListOptionalParams
+  ): PagedAsyncIterableIterator<ChangeResourceResult>;
+  /**
+   * Obtains the specified change resource for the target resource
+   * @param resourceGroupName The name of the resource group.
+   * @param resourceProviderNamespace The name of the resource provider namespace.
+   * @param resourceType The name of the resource type.
+   * @param resourceName The name of the resource.
+   * @param changeResourceId The ID of the change resource
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    resourceProviderNamespace: string,
+    resourceType: string,
+    resourceName: string,
+    changeResourceId: string,
+    options?: ChangesGetOptionalParams
+  ): Promise<ChangesGetResponse>;
+}

package/src/operationsInterfaces/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+export * from "./changes";

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "module": "es6",
+    "moduleResolution": "node",
+    "strict": true,
+    "target": "es6",
+    "sourceMap": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": [
+      "es6",
+      "dom"
+    ],
+    "declaration": true,
+    "outDir": "./dist-esm",
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-changes": [
+        "./src/index"
+      ]
+    }
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/types/arm-changes.d.ts

@@ -0,0 +1,251 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+/** Details about the change resource */
+export declare interface ChangeAttributes {
+    /**
+     * The ARM correlation ID of the change resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly correlationId?: string;
+    /**
+     * The time the change(s) on the target resource ocurred
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly timestamp?: string;
+    /**
+     * The number of changes this resource captures
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly changesCount?: number;
+    /**
+     * The GUID of the previous snapshot
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly previousResourceSnapshotId?: string;
+    /**
+     * The GUID of the new snapshot
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly newResourceSnapshotId?: string;
+}
+
+/** An individual change on the target resource */
+export declare interface ChangeBase {
+    /**
+     * The type of change that occurred
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly propertyChangeType?: PropertyChangeType;
+    /**
+     * The entity that made the change
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly changeCategory?: ChangeCategory;
+    /**
+     * The target resource property value before the change
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly previousValue?: string;
+    /**
+     * The target resource property value after the change
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly newValue?: string;
+}
+
+/** Defines values for ChangeCategory. */
+export declare type ChangeCategory = "User" | "System";
+
+/** The properties of a change */
+export declare interface ChangeProperties {
+    /**
+     * The fully qualified ID of the target resource that was changed
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly targetResourceId?: string;
+    /**
+     * The namespace and type of the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly targetResourceType?: string;
+    /**
+     * The type of change that was captured in the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly changeType?: ChangeType;
+    /** Details about the change resource */
+    changeAttributes?: ChangeAttributes;
+    /** A dictionary with changed property name as a key and the change details as the value */
+    changes?: {
+        [propertyName: string]: ChangeBase;
+    };
+}
+
+/** The list of resources */
+export declare interface ChangeResourceListResult {
+    /** The link used to get the next page of Change Resources */
+    nextLink?: string;
+    /** The list of resources */
+    value?: ChangeResourceResult[];
+}
+
+/** Change Resource */
+export declare type ChangeResourceResult = Resource & {
+    /** The properties of a change */
+    properties?: ChangeProperties;
+};
+
+/** Interface representing a Changes. */
+export declare interface Changes {
+    /**
+     * Obtains a list of change resources from the past 14 days for the target resource
+     * @param resourceGroupName The name of the resource group.
+     * @param resourceProviderNamespace The name of the resource provider namespace.
+     * @param resourceType The name of the resource type.
+     * @param resourceName The name of the resource.
+     * @param options The options parameters.
+     */
+    list(resourceGroupName: string, resourceProviderNamespace: string, resourceType: string, resourceName: string, options?: ChangesListOptionalParams): PagedAsyncIterableIterator<ChangeResourceResult>;
+    /**
+     * Obtains the specified change resource for the target resource
+     * @param resourceGroupName The name of the resource group.
+     * @param resourceProviderNamespace The name of the resource provider namespace.
+     * @param resourceType The name of the resource type.
+     * @param resourceName The name of the resource.
+     * @param changeResourceId The ID of the change resource
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, resourceProviderNamespace: string, resourceType: string, resourceName: string, changeResourceId: string, options?: ChangesGetOptionalParams): Promise<ChangesGetResponse>;
+}
+
+export declare class ChangesClient extends coreClient.ServiceClient {
+    $host: string;
+    subscriptionId: string;
+    apiVersion: string;
+    /**
+     * Initializes a new instance of the ChangesClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
+     *                       00000000-0000-0000-0000-000000000000)
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ChangesClientOptionalParams);
+    changes: Changes;
+}
+
+/** Optional parameters. */
+export declare interface ChangesClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** Optional parameters. */
+export declare interface ChangesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type ChangesGetResponse = ChangeResourceResult;
+
+/** Optional parameters. */
+export declare interface ChangesListNextOptionalParams extends coreClient.OperationOptions {
+    /** (Optional) Set the maximum number of results per response. */
+    top?: number;
+    /** (Optional) The page-continuation token */
+    skipToken?: string;
+}
+
+/** Contains response data for the listNext operation. */
+export declare type ChangesListNextResponse = ChangeResourceListResult;
+
+/** Optional parameters. */
+export declare interface ChangesListOptionalParams extends coreClient.OperationOptions {
+    /** (Optional) Set the maximum number of results per response. */
+    top?: number;
+    /** (Optional) The page-continuation token */
+    skipToken?: string;
+}
+
+/** Contains response data for the list operation. */
+export declare type ChangesListResponse = ChangeResourceListResult;
+
+/** Defines values for ChangeType. */
+export declare type ChangeType = "Update" | "Delete" | "Create";
+
+/** The resource management error additional info. */
+export declare interface ErrorAdditionalInfo {
+    /**
+     * The additional info type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * The additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly info?: Record<string, unknown>;
+}
+
+/** The error detail. */
+export declare interface ErrorDetail {
+    /**
+     * The error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * The error message.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * The error target.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * The error details.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: ErrorDetail[];
+    /**
+     * The error additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+export declare interface ErrorResponse {
+    /** The error object. */
+    error?: ErrorDetail;
+}
+
+/** Defines values for PropertyChangeType. */
+export declare type PropertyChangeType = "Update" | "Insert" | "Remove";
+
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export declare interface Resource {
+    /**
+     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The name of the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+}
+
+export { }

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.18.11"
+    }
+  ]
+}