@azure/arm-trafficmanager 5.1.0 → 6.0.0-alpha.20220202.1

package/review/arm-trafficmanager.api.md

@@ -0,0 +1,486 @@
+## API Report File for "@azure/arm-trafficmanager"
+
+> 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 AllowedEndpointRecordType = string;
+
+// @public
+export interface CheckTrafficManagerRelativeDnsNameAvailabilityParameters {
+    name?: string;
+    type?: string;
+}
+
+// @public
+export interface CloudError {
+    error?: CloudErrorBody;
+}
+
+// @public
+export interface CloudErrorBody {
+    code?: string;
+    details?: CloudErrorBody[];
+    message?: string;
+    target?: string;
+}
+
+// @public
+export interface DeleteOperationResult {
+    readonly operationResult?: boolean;
+}
+
+// @public
+export interface DnsConfig {
+    readonly fqdn?: string;
+    relativeName?: string;
+    ttl?: number;
+}
+
+// @public
+export type Endpoint = ProxyResource & {
+    targetResourceId?: string;
+    target?: string;
+    endpointStatus?: EndpointStatus;
+    weight?: number;
+    priority?: number;
+    endpointLocation?: string;
+    endpointMonitorStatus?: EndpointMonitorStatus;
+    minChildEndpoints?: number;
+    minChildEndpointsIPv4?: number;
+    minChildEndpointsIPv6?: number;
+    geoMapping?: string[];
+    subnets?: EndpointPropertiesSubnetsItem[];
+    customHeaders?: EndpointPropertiesCustomHeadersItem[];
+};
+
+// @public
+export type EndpointMonitorStatus = string;
+
+// @public
+export interface EndpointPropertiesCustomHeadersItem {
+    name?: string;
+    value?: string;
+}
+
+// @public
+export interface EndpointPropertiesSubnetsItem {
+    first?: string;
+    last?: string;
+    scope?: number;
+}
+
+// @public
+export interface Endpoints {
+    createOrUpdate(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, parameters: Endpoint, options?: EndpointsCreateOrUpdateOptionalParams): Promise<EndpointsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, options?: EndpointsDeleteOptionalParams): Promise<EndpointsDeleteResponse>;
+    get(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, options?: EndpointsGetOptionalParams): Promise<EndpointsGetResponse>;
+    update(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, parameters: Endpoint, options?: EndpointsUpdateOptionalParams): Promise<EndpointsUpdateResponse>;
+}
+
+// @public
+export interface EndpointsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsCreateOrUpdateResponse = Endpoint;
+
+// @public
+export interface EndpointsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsDeleteResponse = DeleteOperationResult;
+
+// @public
+export interface EndpointsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsGetResponse = Endpoint;
+
+// @public
+export type EndpointStatus = string;
+
+// @public
+export interface EndpointsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EndpointsUpdateResponse = Endpoint;
+
+// @public
+export type EndpointType = "AzureEndpoints" | "ExternalEndpoints" | "NestedEndpoints";
+
+// @public
+export interface GeographicHierarchies {
+    getDefault(options?: GeographicHierarchiesGetDefaultOptionalParams): Promise<GeographicHierarchiesGetDefaultResponse>;
+}
+
+// @public
+export interface GeographicHierarchiesGetDefaultOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GeographicHierarchiesGetDefaultResponse = TrafficManagerGeographicHierarchy;
+
+// @public
+export interface HeatMap {
+    get(resourceGroupName: string, profileName: string, options?: HeatMapGetOptionalParams): Promise<HeatMapGetResponse>;
+}
+
+// @public
+export interface HeatMapEndpoint {
+    endpointId?: number;
+    resourceId?: string;
+}
+
+// @public
+export interface HeatMapGetOptionalParams extends coreClient.OperationOptions {
+    botRight?: number[];
+    topLeft?: number[];
+}
+
+// @public
+export type HeatMapGetResponse = HeatMapModel;
+
+// @public
+export type HeatMapModel = ProxyResource & {
+    startTime?: Date;
+    endTime?: Date;
+    endpoints?: HeatMapEndpoint[];
+    trafficFlows?: TrafficFlow[];
+};
+
+// @public
+export enum KnownAllowedEndpointRecordType {
+    // (undocumented)
+    Any = "Any",
+    // (undocumented)
+    DomainName = "DomainName",
+    // (undocumented)
+    IPv4Address = "IPv4Address",
+    // (undocumented)
+    IPv6Address = "IPv6Address"
+}
+
+// @public
+export enum KnownEndpointMonitorStatus {
+    // (undocumented)
+    CheckingEndpoint = "CheckingEndpoint",
+    // (undocumented)
+    Degraded = "Degraded",
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Inactive = "Inactive",
+    // (undocumented)
+    Online = "Online",
+    // (undocumented)
+    Stopped = "Stopped"
+}
+
+// @public
+export enum KnownEndpointStatus {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownMonitorProtocol {
+    // (undocumented)
+    Http = "HTTP",
+    // (undocumented)
+    Https = "HTTPS",
+    // (undocumented)
+    TCP = "TCP"
+}
+
+// @public
+export enum KnownProfileMonitorStatus {
+    // (undocumented)
+    CheckingEndpoints = "CheckingEndpoints",
+    // (undocumented)
+    Degraded = "Degraded",
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Inactive = "Inactive",
+    // (undocumented)
+    Online = "Online"
+}
+
+// @public
+export enum KnownProfileStatus {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownTrafficRoutingMethod {
+    // (undocumented)
+    Geographic = "Geographic",
+    // (undocumented)
+    MultiValue = "MultiValue",
+    // (undocumented)
+    Performance = "Performance",
+    // (undocumented)
+    Priority = "Priority",
+    // (undocumented)
+    Subnet = "Subnet",
+    // (undocumented)
+    Weighted = "Weighted"
+}
+
+// @public
+export enum KnownTrafficViewEnrollmentStatus {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export interface MonitorConfig {
+    customHeaders?: MonitorConfigCustomHeadersItem[];
+    expectedStatusCodeRanges?: MonitorConfigExpectedStatusCodeRangesItem[];
+    intervalInSeconds?: number;
+    path?: string;
+    port?: number;
+    profileMonitorStatus?: ProfileMonitorStatus;
+    protocol?: MonitorProtocol;
+    timeoutInSeconds?: number;
+    toleratedNumberOfFailures?: number;
+}
+
+// @public
+export interface MonitorConfigCustomHeadersItem {
+    name?: string;
+    value?: string;
+}
+
+// @public
+export interface MonitorConfigExpectedStatusCodeRangesItem {
+    max?: number;
+    min?: number;
+}
+
+// @public
+export type MonitorProtocol = string;
+
+// @public
+export type Profile = TrackedResource & {
+    profileStatus?: ProfileStatus;
+    trafficRoutingMethod?: TrafficRoutingMethod;
+    dnsConfig?: DnsConfig;
+    monitorConfig?: MonitorConfig;
+    endpoints?: Endpoint[];
+    trafficViewEnrollmentStatus?: TrafficViewEnrollmentStatus;
+    allowedEndpointRecordTypes?: AllowedEndpointRecordType[];
+    maxReturn?: number;
+};
+
+// @public
+export interface ProfileListResult {
+    value?: Profile[];
+}
+
+// @public
+export type ProfileMonitorStatus = string;
+
+// @public
+export interface Profiles {
+    checkTrafficManagerRelativeDnsNameAvailability(parameters: CheckTrafficManagerRelativeDnsNameAvailabilityParameters, options?: ProfilesCheckTrafficManagerRelativeDnsNameAvailabilityOptionalParams): Promise<ProfilesCheckTrafficManagerRelativeDnsNameAvailabilityResponse>;
+    createOrUpdate(resourceGroupName: string, profileName: string, parameters: Profile, options?: ProfilesCreateOrUpdateOptionalParams): Promise<ProfilesCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, profileName: string, options?: ProfilesDeleteOptionalParams): Promise<ProfilesDeleteResponse>;
+    get(resourceGroupName: string, profileName: string, options?: ProfilesGetOptionalParams): Promise<ProfilesGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: ProfilesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Profile>;
+    listBySubscription(options?: ProfilesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Profile>;
+    update(resourceGroupName: string, profileName: string, parameters: Profile, options?: ProfilesUpdateOptionalParams): Promise<ProfilesUpdateResponse>;
+}
+
+// @public
+export interface ProfilesCheckTrafficManagerRelativeDnsNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProfilesCheckTrafficManagerRelativeDnsNameAvailabilityResponse = TrafficManagerNameAvailability;
+
+// @public
+export interface ProfilesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProfilesCreateOrUpdateResponse = Profile;
+
+// @public
+export interface ProfilesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProfilesDeleteResponse = DeleteOperationResult;
+
+// @public
+export interface ProfilesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProfilesGetResponse = Profile;
+
+// @public
+export interface ProfilesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProfilesListByResourceGroupResponse = ProfileListResult;
+
+// @public
+export interface ProfilesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProfilesListBySubscriptionResponse = ProfileListResult;
+
+// @public
+export type ProfileStatus = string;
+
+// @public
+export interface ProfilesUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ProfilesUpdateResponse = Profile;
+
+// @public
+export type ProxyResource = Resource & {};
+
+// @public
+export interface QueryExperience {
+    endpointId: number;
+    latency?: number;
+    queryCount: number;
+}
+
+// @public
+export interface Region {
+    code?: string;
+    name?: string;
+    regions?: Region[];
+}
+
+// @public
+export interface Resource {
+    id?: string;
+    name?: string;
+    type?: string;
+}
+
+// @public
+export type TrackedResource = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    location?: string;
+};
+
+// @public
+export interface TrafficFlow {
+    latitude?: number;
+    longitude?: number;
+    queryExperiences?: QueryExperience[];
+    sourceIp?: string;
+}
+
+// @public
+export type TrafficManagerGeographicHierarchy = ProxyResource & {
+    geographicHierarchy?: Region;
+};
+
+// @public (undocumented)
+export class TrafficManagerManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: TrafficManagerManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    endpoints: Endpoints;
+    // (undocumented)
+    geographicHierarchies: GeographicHierarchies;
+    // (undocumented)
+    heatMap: HeatMap;
+    // (undocumented)
+    profiles: Profiles;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    trafficManagerUserMetricsKeys: TrafficManagerUserMetricsKeys;
+}
+
+// @public
+export interface TrafficManagerManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface TrafficManagerNameAvailability {
+    message?: string;
+    name?: string;
+    nameAvailable?: boolean;
+    reason?: string;
+    type?: string;
+}
+
+// @public
+export interface TrafficManagerUserMetricsKeys {
+    createOrUpdate(options?: TrafficManagerUserMetricsKeysCreateOrUpdateOptionalParams): Promise<TrafficManagerUserMetricsKeysCreateOrUpdateResponse>;
+    delete(options?: TrafficManagerUserMetricsKeysDeleteOptionalParams): Promise<TrafficManagerUserMetricsKeysDeleteResponse>;
+    get(options?: TrafficManagerUserMetricsKeysGetOptionalParams): Promise<TrafficManagerUserMetricsKeysGetResponse>;
+}
+
+// @public
+export interface TrafficManagerUserMetricsKeysCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TrafficManagerUserMetricsKeysCreateOrUpdateResponse = UserMetricsModel;
+
+// @public
+export interface TrafficManagerUserMetricsKeysDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TrafficManagerUserMetricsKeysDeleteResponse = DeleteOperationResult;
+
+// @public
+export interface TrafficManagerUserMetricsKeysGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TrafficManagerUserMetricsKeysGetResponse = UserMetricsModel;
+
+// @public
+export type TrafficRoutingMethod = string;
+
+// @public
+export type TrafficViewEnrollmentStatus = string;
+
+// @public
+export type UserMetricsModel = ProxyResource & {
+    key?: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -1,37 +1,188 @@
-import rollup from "rollup";
-import nodeResolve from "rollup-plugin-node-resolve";
-import sourcemaps from "rollup-plugin-sourcemaps";
-
-/**
- * @type {rollup.RollupFileOptions}
- */
-const config = {
-  input: "./esm/trafficManagerManagementClient.js",
-  external: [
-    "@azure/ms-rest-js",
-    "@azure/ms-rest-azure-js"
-  ],
-  output: {
-    file: "./dist/arm-trafficmanager.js",
-    format: "umd",
-    name: "Azure.ArmTrafficmanager",
-    sourcemap: true,
-    globals: {
-      "@azure/ms-rest-js": "msRest",
-      "@azure/ms-rest-azure-js": "msRestAzure"
-    },
-    banner: `/*
+/*
  * 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.
- */`
-  },
-  plugins: [
-    nodeResolve({ mainFields: ['module', 'main'] }),
-    sourcemaps()
-  ]
+ */
+
+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 default config;
+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"));

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 { TrafficManagerManagementClient } from "./trafficManagerManagementClient";
+export * from "./operationsInterfaces";