@azure/arm-resourceconnector 1.0.0-beta.1

package/review/arm-resourceconnector.api.md

@@ -0,0 +1,400 @@
+## API Report File for "@azure/arm-resourceconnector"
+
+> 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 type AccessProfileType = string;
+
+// @public
+export interface Appliance extends TrackedResource {
+    distro?: Distro;
+    identity?: Identity;
+    infrastructureConfig?: AppliancePropertiesInfrastructureConfig;
+    readonly provisioningState?: string;
+    publicKey?: string;
+    readonly status?: Status;
+    readonly systemData?: SystemData;
+    version?: string;
+}
+
+// @public
+export interface ApplianceCredentialKubeconfig {
+    readonly name?: AccessProfileType;
+    readonly value?: string;
+}
+
+// @public
+export interface ApplianceListClusterCustomerUserCredentialResults {
+    readonly kubeconfigs?: ApplianceCredentialKubeconfig[];
+    readonly sshKeys?: {
+        [propertyName: string]: SSHKey;
+    };
+}
+
+// @public
+export interface ApplianceListCredentialResults {
+    readonly hybridConnectionConfig?: HybridConnectionConfig;
+    readonly kubeconfigs?: ApplianceCredentialKubeconfig[];
+}
+
+// @public
+export interface ApplianceListResult {
+    readonly nextLink?: string;
+    readonly value?: Appliance[];
+}
+
+// @public
+export interface ApplianceOperation {
+    readonly description?: string;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly operation?: string;
+    readonly origin?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface ApplianceOperationsList {
+    nextLink?: string;
+    value: ApplianceOperation[];
+}
+
+// @public
+export interface AppliancePropertiesInfrastructureConfig {
+    provider?: Provider;
+}
+
+// @public
+export interface Appliances {
+    beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: Appliance, options?: AppliancesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AppliancesCreateOrUpdateResponse>, AppliancesCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: Appliance, options?: AppliancesCreateOrUpdateOptionalParams): Promise<AppliancesCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, resourceName: string, options?: AppliancesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: AppliancesDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, resourceName: string, options?: AppliancesGetOptionalParams): Promise<AppliancesGetResponse>;
+    getUpgradeGraph(resourceGroupName: string, resourceName: string, upgradeGraph: string, options?: AppliancesGetUpgradeGraphOptionalParams): Promise<AppliancesGetUpgradeGraphResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: AppliancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Appliance>;
+    listBySubscription(options?: AppliancesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Appliance>;
+    listClusterCustomerUserCredential(resourceGroupName: string, resourceName: string, options?: AppliancesListClusterCustomerUserCredentialOptionalParams): Promise<AppliancesListClusterCustomerUserCredentialResponse>;
+    listClusterUserCredential(resourceGroupName: string, resourceName: string, options?: AppliancesListClusterUserCredentialOptionalParams): Promise<AppliancesListClusterUserCredentialResponse>;
+    listOperations(options?: AppliancesListOperationsOptionalParams): PagedAsyncIterableIterator<ApplianceOperation>;
+    update(resourceGroupName: string, resourceName: string, options?: AppliancesUpdateOptionalParams): Promise<AppliancesUpdateResponse>;
+}
+
+// @public
+export interface AppliancesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type AppliancesCreateOrUpdateResponse = Appliance;
+
+// @public
+export interface AppliancesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface AppliancesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesGetResponse = Appliance;
+
+// @public
+export interface AppliancesGetUpgradeGraphOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesGetUpgradeGraphResponse = UpgradeGraph;
+
+// @public
+export interface AppliancesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListByResourceGroupNextResponse = ApplianceListResult;
+
+// @public
+export interface AppliancesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListByResourceGroupResponse = ApplianceListResult;
+
+// @public
+export interface AppliancesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListBySubscriptionNextResponse = ApplianceListResult;
+
+// @public
+export interface AppliancesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListBySubscriptionResponse = ApplianceListResult;
+
+// @public
+export interface AppliancesListClusterCustomerUserCredentialOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListClusterCustomerUserCredentialResponse = ApplianceListClusterCustomerUserCredentialResults;
+
+// @public
+export interface AppliancesListClusterUserCredentialOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListClusterUserCredentialResponse = ApplianceListCredentialResults;
+
+// @public
+export interface AppliancesListOperationsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListOperationsNextResponse = ApplianceOperationsList;
+
+// @public
+export interface AppliancesListOperationsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type AppliancesListOperationsResponse = ApplianceOperationsList;
+
+// @public
+export interface AppliancesUpdateOptionalParams extends coreClient.OperationOptions {
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type AppliancesUpdateResponse = Appliance;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export type Distro = string;
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface HybridConnectionConfig {
+    readonly expirationTime?: number;
+    readonly hybridConnectionName?: string;
+    readonly relay?: string;
+    readonly token?: string;
+}
+
+// @public
+export interface Identity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: ResourceIdentityType;
+}
+
+// @public
+export enum KnownAccessProfileType {
+    ClusterCustomerUser = "clusterCustomerUser",
+    ClusterUser = "clusterUser"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownDistro {
+    AKSEdge = "AKSEdge"
+}
+
+// @public
+export enum KnownProvider {
+    HCI = "HCI",
+    KubeVirt = "KubeVirt",
+    OpenStack = "OpenStack",
+    Scvmm = "SCVMM",
+    VMWare = "VMWare"
+}
+
+// @public
+export enum KnownResourceIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned"
+}
+
+// @public
+export enum KnownSSHKeyType {
+    SSHCustomerUser = "SSHCustomerUser"
+}
+
+// @public
+export enum KnownStatus {
+    Connected = "Connected",
+    Connecting = "Connecting",
+    None = "None",
+    Offline = "Offline",
+    PostUpgrade = "PostUpgrade",
+    PreparingForUpgrade = "PreparingForUpgrade",
+    PreUpgrade = "PreUpgrade",
+    Running = "Running",
+    UpdatingCapi = "UpdatingCAPI",
+    UpdatingCloudOperator = "UpdatingCloudOperator",
+    UpdatingCluster = "UpdatingCluster",
+    UpgradeClusterExtensionFailedToDelete = "UpgradeClusterExtensionFailedToDelete",
+    UpgradeComplete = "UpgradeComplete",
+    UpgradeFailed = "UpgradeFailed",
+    UpgradePrerequisitesCompleted = "UpgradePrerequisitesCompleted",
+    Validating = "Validating",
+    WaitingForCloudOperator = "WaitingForCloudOperator",
+    WaitingForHeartbeat = "WaitingForHeartbeat"
+}
+
+// @public
+export interface PatchableAppliance {
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type Provider = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public (undocumented)
+export class ResourceConnectorManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ResourceConnectorManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    appliances: Appliances;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface ResourceConnectorManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type ResourceIdentityType = string;
+
+// @public
+export interface SSHKey {
+    privateKey?: string;
+    publicKey?: string;
+}
+
+// @public
+export type SSHKeyType = string;
+
+// @public
+export type Status = string;
+
+// @public
+export interface SupportedVersion {
+    readonly metadata?: SupportedVersionMetadata;
+    readonly version?: string;
+}
+
+// @public
+export interface SupportedVersionCatalogVersion {
+    readonly data?: SupportedVersionCatalogVersionData;
+    readonly name?: string;
+    readonly namespace?: string;
+}
+
+// @public
+export interface SupportedVersionCatalogVersionData {
+    readonly audience?: string;
+    readonly catalog?: string;
+    readonly offer?: string;
+    readonly version?: string;
+}
+
+// @public
+export interface SupportedVersionMetadata {
+    readonly catalogVersion?: SupportedVersionCatalogVersion;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface UpgradeGraph {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: UpgradeGraphProperties;
+}
+
+// @public
+export interface UpgradeGraphProperties {
+    readonly applianceVersion?: string;
+    readonly supportedVersions?: SupportedVersion[];
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -0,0 +1,122 @@
+/*
+ * 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";
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollup warning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEval(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependency(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
+
+/**
+ * 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(),
+      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()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { ResourceConnectorManagementClient } from "./resourceConnectorManagementClient";
+export * from "./operationsInterfaces";

package/src/lroImpl.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { LongRunningOperation, LroResponse } from "@azure/core-lro";
+
+export class LroImpl<T> implements LongRunningOperation<T> {
+  constructor(
+    private sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>,
+    private args: Record<string, unknown>,
+    private spec: {
+      readonly requestBody?: unknown;
+      readonly path?: string;
+      readonly httpMethod: string;
+    } & Record<string, any>,
+    public requestPath: string = spec.path!,
+    public requestMethod: string = spec.httpMethod
+  ) {}
+  public async sendInitialRequest(): Promise<LroResponse<T>> {
+    return this.sendOperationFn(this.args, this.spec);
+  }
+  public async sendPollRequest(path: string): Promise<LroResponse<T>> {
+    const { requestBody, ...restSpec } = this.spec;
+    return this.sendOperationFn(this.args, {
+      ...restSpec,
+      path,
+      httpMethod: "GET"
+    });
+  }
+}