@azure/arm-imagebuilder 1.0.0

package/review/arm-imagebuilder.api.md

@@ -0,0 +1,509 @@
+## API Report File for "@azure/arm-imagebuilder"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export interface CloudError {
+    error?: CloudErrorBody;
+}
+
+// @public
+export interface CloudErrorBody {
+    code?: string;
+    details?: CloudErrorBody[];
+    message?: string;
+    target?: string;
+}
+
+// @public (undocumented)
+export interface ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public (undocumented)
+export class ImageBuilderClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ImageBuilderClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    virtualMachineImageTemplates: VirtualMachineImageTemplates;
+}
+
+// @public
+export interface ImageBuilderClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type ImageTemplate = TrackedResource & {
+    identity: ImageTemplateIdentity;
+    readonly systemData?: SystemData;
+    source?: ImageTemplateSourceUnion;
+    customize?: ImageTemplateCustomizerUnion[];
+    distribute?: ImageTemplateDistributorUnion[];
+    readonly provisioningState?: ProvisioningState;
+    readonly provisioningError?: ProvisioningError;
+    readonly lastRunStatus?: ImageTemplateLastRunStatus;
+    buildTimeoutInMinutes?: number;
+    vmProfile?: ImageTemplateVmProfile;
+};
+
+// @public
+export interface ImageTemplateCustomizer {
+    name?: string;
+    type: "Shell" | "WindowsRestart" | "WindowsUpdate" | "PowerShell" | "File";
+}
+
+// @public (undocumented)
+export type ImageTemplateCustomizerUnion = ImageTemplateCustomizer | ImageTemplateShellCustomizer | ImageTemplateRestartCustomizer | ImageTemplateWindowsUpdateCustomizer | ImageTemplatePowerShellCustomizer | ImageTemplateFileCustomizer;
+
+// @public
+export interface ImageTemplateDistributor {
+    artifactTags?: {
+        [propertyName: string]: string;
+    };
+    runOutputName: string;
+    type: "ManagedImage" | "SharedImage" | "VHD";
+}
+
+// @public (undocumented)
+export type ImageTemplateDistributorUnion = ImageTemplateDistributor | ImageTemplateManagedImageDistributor | ImageTemplateSharedImageDistributor | ImageTemplateVhdDistributor;
+
+// @public
+export type ImageTemplateFileCustomizer = ImageTemplateCustomizer & {
+    type: "File";
+    sourceUri?: string;
+    sha256Checksum?: string;
+    destination?: string;
+};
+
+// @public
+export interface ImageTemplateIdentity {
+    type?: ResourceIdentityType;
+    userAssignedIdentities?: {
+        [propertyName: string]: ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties;
+    };
+}
+
+// @public
+export interface ImageTemplateLastRunStatus {
+    endTime?: Date;
+    message?: string;
+    runState?: RunState;
+    runSubState?: RunSubState;
+    startTime?: Date;
+}
+
+// @public
+export interface ImageTemplateListResult {
+    nextLink?: string;
+    value?: ImageTemplate[];
+}
+
+// @public
+export type ImageTemplateManagedImageDistributor = ImageTemplateDistributor & {
+    type: "ManagedImage";
+    imageId: string;
+    location: string;
+};
+
+// @public
+export type ImageTemplateManagedImageSource = ImageTemplateSource & {
+    type: "ManagedImage";
+    imageId: string;
+};
+
+// @public
+export type ImageTemplatePlatformImageSource = ImageTemplateSource & {
+    type: "PlatformImage";
+    publisher?: string;
+    offer?: string;
+    sku?: string;
+    version?: string;
+    readonly exactVersion?: string;
+    planInfo?: PlatformImagePurchasePlan;
+};
+
+// @public
+export type ImageTemplatePowerShellCustomizer = ImageTemplateCustomizer & {
+    type: "PowerShell";
+    scriptUri?: string;
+    sha256Checksum?: string;
+    inline?: string[];
+    runElevated?: boolean;
+    runAsSystem?: boolean;
+    validExitCodes?: number[];
+};
+
+// @public
+export type ImageTemplateRestartCustomizer = ImageTemplateCustomizer & {
+    type: "WindowsRestart";
+    restartCommand?: string;
+    restartCheckCommand?: string;
+    restartTimeout?: string;
+};
+
+// @public
+export type ImageTemplateSharedImageDistributor = ImageTemplateDistributor & {
+    type: "SharedImage";
+    galleryImageId: string;
+    replicationRegions: string[];
+    excludeFromLatest?: boolean;
+    storageAccountType?: SharedImageStorageAccountType;
+};
+
+// @public
+export type ImageTemplateSharedImageVersionSource = ImageTemplateSource & {
+    type: "SharedImageVersion";
+    imageVersionId: string;
+};
+
+// @public
+export type ImageTemplateShellCustomizer = ImageTemplateCustomizer & {
+    type: "Shell";
+    scriptUri?: string;
+    sha256Checksum?: string;
+    inline?: string[];
+};
+
+// @public
+export interface ImageTemplateSource {
+    type: "PlatformImage" | "ManagedImage" | "SharedImageVersion";
+}
+
+// @public (undocumented)
+export type ImageTemplateSourceUnion = ImageTemplateSource | ImageTemplatePlatformImageSource | ImageTemplateManagedImageSource | ImageTemplateSharedImageVersionSource;
+
+// @public
+export interface ImageTemplateUpdateParameters {
+    identity?: ImageTemplateIdentity;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type ImageTemplateVhdDistributor = ImageTemplateDistributor & {
+    type: "VHD";
+};
+
+// @public
+export interface ImageTemplateVmProfile {
+    osDiskSizeGB?: number;
+    userAssignedIdentities?: string[];
+    vmSize?: string;
+    vnetConfig?: VirtualNetworkConfig;
+}
+
+// @public
+export type ImageTemplateWindowsUpdateCustomizer = ImageTemplateCustomizer & {
+    type: "WindowsUpdate";
+    searchCriteria?: string;
+    filters?: string[];
+    updateLimit?: number;
+};
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownProvisioningErrorCode {
+    // (undocumented)
+    BadCustomizerType = "BadCustomizerType",
+    // (undocumented)
+    BadDistributeType = "BadDistributeType",
+    // (undocumented)
+    BadManagedImageSource = "BadManagedImageSource",
+    // (undocumented)
+    BadPIRSource = "BadPIRSource",
+    // (undocumented)
+    BadSharedImageDistribute = "BadSharedImageDistribute",
+    // (undocumented)
+    BadSharedImageVersionSource = "BadSharedImageVersionSource",
+    // (undocumented)
+    BadSourceType = "BadSourceType",
+    // (undocumented)
+    NoCustomizerScript = "NoCustomizerScript",
+    // (undocumented)
+    Other = "Other",
+    // (undocumented)
+    ServerError = "ServerError",
+    // (undocumented)
+    UnsupportedCustomizerType = "UnsupportedCustomizerType"
+}
+
+// @public
+export enum KnownSharedImageStorageAccountType {
+    // (undocumented)
+    StandardLRS = "Standard_LRS",
+    // (undocumented)
+    StandardZRS = "Standard_ZRS"
+}
+
+// @public
+export interface Operation {
+    display?: OperationDisplay;
+    isDataAction?: boolean;
+    name?: string;
+    origin?: string;
+    properties?: Record<string, unknown>;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    nextLink?: string;
+    value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export interface PlatformImagePurchasePlan {
+    planName: string;
+    planProduct: string;
+    planPublisher: string;
+}
+
+// @public
+export interface ProvisioningError {
+    message?: string;
+    provisioningErrorCode?: ProvisioningErrorCode;
+}
+
+// @public
+export type ProvisioningErrorCode = string;
+
+// @public
+export type ProvisioningState = "Creating" | "Updating" | "Succeeded" | "Failed" | "Deleting";
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export type ResourceIdentityType = "UserAssigned" | "None";
+
+// @public
+export type RunOutput = SubResource & {
+    artifactId?: string;
+    artifactUri?: string;
+    readonly provisioningState?: ProvisioningState;
+};
+
+// @public
+export interface RunOutputCollection {
+    nextLink?: string;
+    value?: RunOutput[];
+}
+
+// @public
+export type RunState = "Running" | "Canceling" | "Succeeded" | "PartiallySucceeded" | "Failed" | "Canceled";
+
+// @public
+export type RunSubState = "Queued" | "Building" | "Customizing" | "Distributing";
+
+// @public
+export type SharedImageStorageAccountType = string;
+
+// @public
+export interface SubResource {
+    readonly id?: string;
+    name: string;
+    readonly type?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type TrackedResource = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    location: string;
+};
+
+// @public
+export interface VirtualMachineImageTemplates {
+    beginCancel(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesCancelOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginCancelAndWait(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesCancelOptionalParams): Promise<void>;
+    beginCreateOrUpdate(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplate, options?: VirtualMachineImageTemplatesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineImageTemplatesCreateOrUpdateResponse>, VirtualMachineImageTemplatesCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplate, options?: VirtualMachineImageTemplatesCreateOrUpdateOptionalParams): Promise<VirtualMachineImageTemplatesCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesDeleteOptionalParams): Promise<void>;
+    beginRun(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesRunOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginRunAndWait(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesRunOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplateUpdateParameters, options?: VirtualMachineImageTemplatesUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualMachineImageTemplatesUpdateResponse>, VirtualMachineImageTemplatesUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, imageTemplateName: string, parameters: ImageTemplateUpdateParameters, options?: VirtualMachineImageTemplatesUpdateOptionalParams): Promise<VirtualMachineImageTemplatesUpdateResponse>;
+    get(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesGetOptionalParams): Promise<VirtualMachineImageTemplatesGetResponse>;
+    getRunOutput(resourceGroupName: string, imageTemplateName: string, runOutputName: string, options?: VirtualMachineImageTemplatesGetRunOutputOptionalParams): Promise<VirtualMachineImageTemplatesGetRunOutputResponse>;
+    list(options?: VirtualMachineImageTemplatesListOptionalParams): PagedAsyncIterableIterator<ImageTemplate>;
+    listByResourceGroup(resourceGroupName: string, options?: VirtualMachineImageTemplatesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ImageTemplate>;
+    listRunOutputs(resourceGroupName: string, imageTemplateName: string, options?: VirtualMachineImageTemplatesListRunOutputsOptionalParams): PagedAsyncIterableIterator<RunOutput>;
+}
+
+// @public
+export interface VirtualMachineImageTemplatesCancelOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface VirtualMachineImageTemplatesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type VirtualMachineImageTemplatesCreateOrUpdateResponse = ImageTemplate;
+
+// @public
+export interface VirtualMachineImageTemplatesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface VirtualMachineImageTemplatesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesGetResponse = ImageTemplate;
+
+// @public
+export interface VirtualMachineImageTemplatesGetRunOutputOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesGetRunOutputResponse = RunOutput;
+
+// @public
+export interface VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesListByResourceGroupNextResponse = ImageTemplateListResult;
+
+// @public
+export interface VirtualMachineImageTemplatesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesListByResourceGroupResponse = ImageTemplateListResult;
+
+// @public
+export interface VirtualMachineImageTemplatesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesListNextResponse = ImageTemplateListResult;
+
+// @public
+export interface VirtualMachineImageTemplatesListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesListResponse = ImageTemplateListResult;
+
+// @public
+export interface VirtualMachineImageTemplatesListRunOutputsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesListRunOutputsNextResponse = RunOutputCollection;
+
+// @public
+export interface VirtualMachineImageTemplatesListRunOutputsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type VirtualMachineImageTemplatesListRunOutputsResponse = RunOutputCollection;
+
+// @public
+export interface VirtualMachineImageTemplatesRunOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface VirtualMachineImageTemplatesUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type VirtualMachineImageTemplatesUpdateResponse = ImageTemplate;
+
+// @public
+export interface VirtualNetworkConfig {
+    proxyVmSize?: string;
+    subnetId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -0,0 +1,188 @@
+/*
+ * 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 nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+/**
+ * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
+ *
+ * NOTE: this manual configuration is only needed because OpenTelemetry uses an
+ * __exportStar downleveled helper function to declare its exports which confuses
+ * rollup's automatic discovery mechanism.
+ *
+ * @returns an object reference that can be `...`'d into your cjs() configuration.
+ */
+export function openTelemetryCommonJs() {
+  const namedExports = {};
+
+  for (const key of [
+    "@opentelemetry/api",
+    "@azure/core-tracing/node_modules/@opentelemetry/api"
+  ]) {
+    namedExports[key] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "SpanStatusCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
+
+  for (const version of releasedOpenTelemetryVersions) {
+    namedExports[
+      // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
+      `../../../common/temp/node_modules/.pnpm/@opentelemetry/api@${version}/node_modules/@opentelemetry/api/build/src/index.js`
+    ] = [
+      "SpanKind",
+      "TraceFlags",
+      "getSpan",
+      "setSpan",
+      "StatusCode",
+      "CanonicalCode",
+      "getSpanContext",
+      "setSpanContext"
+    ];
+  }
+
+  return namedExports;
+}
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollupwarning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEvalWarnings(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependencyWarnings(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [
+  ignoreChaiCircularDependencyWarnings,
+  ignoreNiseSinonEvalWarnings
+];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"]
+    },
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs({
+        namedExports: {
+          // Chai's strange internal architecture makes it impossible to statically
+          // analyze its exports.
+          chai: [
+            "version",
+            "use",
+            "util",
+            "config",
+            "expect",
+            "should",
+            "assert"
+          ],
+          ...openTelemetryCommonJs()
+        }
+      }),
+      json(),
+      sourcemaps()
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false
+};
+
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {})
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies)
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve(), cjs()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));