@azure/arm-hybridconnectivity 1.0.0-beta.1

package/review/arm-hybridconnectivity.api.md

@@ -0,0 +1,388 @@
+## API Report File for "@azure/arm-hybridconnectivity"
+
+> 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';
+
+// @public
+export type ActionType = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface EndpointAccessResource {
+    readonly accessKey?: string;
+    expiresOn?: number;
+    hybridConnectionName?: string;
+    namespaceName?: string;
+    namespaceNameSuffix?: string;
+    serviceConfigurationToken?: string;
+}
+
+// @public
+export interface EndpointProperties {
+    readonly provisioningState?: string;
+    resourceId?: string;
+    type: Type;
+}
+
+// @public
+export interface EndpointResource extends ProxyResource {
+    properties?: EndpointProperties;
+}
+
+// @public
+export interface Endpoints {
+    createOrUpdate(resourceUri: string, endpointName: string, endpointResource: EndpointResource, options?: EndpointsCreateOrUpdateOptionalParams): Promise<EndpointsCreateOrUpdateResponse>;
+    delete(resourceUri: string, endpointName: string, options?: EndpointsDeleteOptionalParams): Promise<void>;
+    get(resourceUri: string, endpointName: string, options?: EndpointsGetOptionalParams): Promise<EndpointsGetResponse>;
+    list(resourceUri: string, options?: EndpointsListOptionalParams): PagedAsyncIterableIterator<EndpointResource>;
+    listCredentials(resourceUri: string, endpointName: string, options?: EndpointsListCredentialsOptionalParams): Promise<EndpointsListCredentialsResponse>;
+    listIngressGatewayCredentials(resourceUri: string, endpointName: string, options?: EndpointsListIngressGatewayCredentialsOptionalParams): Promise<EndpointsListIngressGatewayCredentialsResponse>;
+    listManagedProxyDetails(resourceUri: string, endpointName: string, managedProxyRequest: ManagedProxyRequest, options?: EndpointsListManagedProxyDetailsOptionalParams): Promise<EndpointsListManagedProxyDetailsResponse>;
+    update(resourceUri: string, endpointName: string, endpointResource: EndpointResource, options?: EndpointsUpdateOptionalParams): Promise<EndpointsUpdateResponse>;
+}
+
+// @public
+export interface EndpointsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsCreateOrUpdateResponse = EndpointResource;
+
+// @public
+export interface EndpointsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface EndpointsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsGetResponse = EndpointResource;
+
+// @public
+export interface EndpointsList {
+    nextLink?: string;
+    value?: EndpointResource[];
+}
+
+// @public
+export interface EndpointsListCredentialsOptionalParams extends coreClient.OperationOptions {
+    expiresin?: number;
+    listCredentialsRequest?: ListCredentialsRequest;
+}
+
+// @public
+export type EndpointsListCredentialsResponse = EndpointAccessResource;
+
+// @public
+export interface EndpointsListIngressGatewayCredentialsOptionalParams extends coreClient.OperationOptions {
+    expiresin?: number;
+    listIngressGatewayCredentialsRequest?: ListIngressGatewayCredentialsRequest;
+}
+
+// @public
+export type EndpointsListIngressGatewayCredentialsResponse = IngressGatewayResource;
+
+// @public
+export interface EndpointsListManagedProxyDetailsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsListManagedProxyDetailsResponse = ManagedProxyResource;
+
+// @public
+export interface EndpointsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsListNextResponse = EndpointsList;
+
+// @public
+export interface EndpointsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsListResponse = EndpointsList;
+
+// @public
+export interface EndpointsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsUpdateResponse = EndpointResource;
+
+// @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 function getContinuationToken(page: unknown): string | undefined;
+
+// @public (undocumented)
+export class HybridConnectivityManagementAPI extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, options?: HybridConnectivityManagementAPIOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    endpoints: Endpoints;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    serviceConfigurations: ServiceConfigurations;
+}
+
+// @public
+export interface HybridConnectivityManagementAPIOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface IngressGatewayResource {
+    readonly accessKey?: string;
+    expiresOn?: number;
+    hostname?: string;
+    hybridConnectionName?: string;
+    namespaceName?: string;
+    namespaceNameSuffix?: string;
+    serverId?: string;
+    serviceConfigurationToken?: string;
+    tenantId?: string;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Canceled = "Canceled",
+    Creating = "Creating",
+    Failed = "Failed",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownServiceName {
+    SSH = "SSH",
+    WAC = "WAC"
+}
+
+// @public
+export enum KnownType {
+    Custom = "custom",
+    Default = "default"
+}
+
+// @public
+export interface ListCredentialsRequest {
+    serviceName?: ServiceName;
+}
+
+// @public
+export interface ListIngressGatewayCredentialsRequest {
+    serviceName?: ServiceName;
+}
+
+// @public
+export interface ManagedProxyRequest {
+    hostname?: string;
+    service: string;
+    serviceName?: ServiceName;
+}
+
+// @public
+export interface ManagedProxyResource {
+    expiresOn: number;
+    proxy: string;
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly 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 type Origin = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface ServiceConfigurationList {
+    nextLink?: string;
+    value?: ServiceConfigurationResource[];
+}
+
+// @public
+export interface ServiceConfigurationResource extends ProxyResource {
+    port?: number;
+    readonly provisioningState?: ProvisioningState;
+    resourceId?: string;
+    serviceName?: ServiceName;
+}
+
+// @public
+export interface ServiceConfigurationResourcePatch {
+    port?: number;
+}
+
+// @public
+export interface ServiceConfigurations {
+    createOrupdate(resourceUri: string, endpointName: string, serviceConfigurationName: string, serviceConfigurationResource: ServiceConfigurationResource, options?: ServiceConfigurationsCreateOrupdateOptionalParams): Promise<ServiceConfigurationsCreateOrupdateResponse>;
+    delete(resourceUri: string, endpointName: string, serviceConfigurationName: string, options?: ServiceConfigurationsDeleteOptionalParams): Promise<void>;
+    get(resourceUri: string, endpointName: string, serviceConfigurationName: string, options?: ServiceConfigurationsGetOptionalParams): Promise<ServiceConfigurationsGetResponse>;
+    listByEndpointResource(resourceUri: string, endpointName: string, options?: ServiceConfigurationsListByEndpointResourceOptionalParams): PagedAsyncIterableIterator<ServiceConfigurationResource>;
+    update(resourceUri: string, endpointName: string, serviceConfigurationName: string, serviceConfigurationResource: ServiceConfigurationResourcePatch, options?: ServiceConfigurationsUpdateOptionalParams): Promise<ServiceConfigurationsUpdateResponse>;
+}
+
+// @public
+export interface ServiceConfigurationsCreateOrupdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceConfigurationsCreateOrupdateResponse = ServiceConfigurationResource;
+
+// @public
+export interface ServiceConfigurationsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ServiceConfigurationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceConfigurationsGetResponse = ServiceConfigurationResource;
+
+// @public
+export interface ServiceConfigurationsListByEndpointResourceNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceConfigurationsListByEndpointResourceNextResponse = ServiceConfigurationList;
+
+// @public
+export interface ServiceConfigurationsListByEndpointResourceOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceConfigurationsListByEndpointResourceResponse = ServiceConfigurationList;
+
+// @public
+export interface ServiceConfigurationsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ServiceConfigurationsUpdateResponse = ServiceConfigurationResource;
+
+// @public
+export type ServiceName = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type Type = string;
+
+// (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/hybridConnectivityManagementAPI.ts

@@ -0,0 +1,144 @@
+/*
+ * 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 * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
+import * as coreAuth from "@azure/core-auth";
+import {
+  OperationsImpl,
+  EndpointsImpl,
+  ServiceConfigurationsImpl
+} from "./operations";
+import {
+  Operations,
+  Endpoints,
+  ServiceConfigurations
+} from "./operationsInterfaces";
+import { HybridConnectivityManagementAPIOptionalParams } from "./models";
+
+export class HybridConnectivityManagementAPI extends coreClient.ServiceClient {
+  $host: string;
+  apiVersion: string;
+
+  /**
+   * Initializes a new instance of the HybridConnectivityManagementAPI class.
+   * @param credentials Subscription credentials which uniquely identify client subscription.
+   * @param options The parameter options
+   */
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    options?: HybridConnectivityManagementAPIOptionalParams
+  ) {
+    if (credentials === undefined) {
+      throw new Error("'credentials' cannot be null");
+    }
+
+    // Initializing default values for options
+    if (!options) {
+      options = {};
+    }
+    const defaults: HybridConnectivityManagementAPIOptionalParams = {
+      requestContentType: "application/json; charset=utf-8",
+      credential: credentials
+    };
+
+    const packageDetails = `azsdk-js-arm-hybridconnectivity/1.0.0-beta.1`;
+    const userAgentPrefix =
+      options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+        : `${packageDetails}`;
+
+    const optionsWithDefaults = {
+      ...defaults,
+      ...options,
+      userAgentOptions: {
+        userAgentPrefix
+      },
+      endpoint:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
+    };
+    super(optionsWithDefaults);
+
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName
+      );
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
+    }
+
+    // Assigning values to Constant parameters
+    this.$host = options.$host || "https://management.azure.com";
+    this.apiVersion = options.apiVersion || "2023-03-15";
+    this.operations = new OperationsImpl(this);
+    this.endpoints = new EndpointsImpl(this);
+    this.serviceConfigurations = new ServiceConfigurationsImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      }
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
+  }
+
+  operations: Operations;
+  endpoints: Endpoints;
+  serviceConfigurations: ServiceConfigurations;
+}

package/src/index.ts

@@ -0,0 +1,13 @@
+/*
+ * 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 { getContinuationToken } from "./pagingHelper";
+export * from "./models";
+export { HybridConnectivityManagementAPI } from "./hybridConnectivityManagementAPI";
+export * from "./operationsInterfaces";