@azure/arm-containerservicefleet 1.0.0-beta.2 → 1.0.0

package/types/arm-containerservicefleet.d.ts

@@ -13,22 +13,6 @@ import { SimplePollerLike } from '@azure/core-lro';
  */
 export declare type ActionType = string;
 
-/** Agent profile for the Fleet hub. */
-export declare interface AgentProfile {
-    /** The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used. */
-    subnetId?: string;
-}
-
-/** Access profile for the Fleet hub API server. */
-export declare interface APIServerAccessProfile {
-    /** Whether to create the Fleet hub as a private cluster or not. */
-    enablePrivateCluster?: boolean;
-    /** Whether to enable apiserver vnet integration for the Fleet hub or not. */
-    enableVnetIntegration?: boolean;
-    /** The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. */
-    subnetId?: string;
-}
-
 export declare class ContainerServiceFleetClient extends coreClient.ServiceClient {
     $host: string;
     apiVersion: string;
@@ -46,6 +30,7 @@ export declare class ContainerServiceFleetClient extends coreClient.ServiceClien
     fleets: Fleets;
     fleetMembers: FleetMembers;
     updateRuns: UpdateRuns;
+    fleetUpdateStrategies: FleetUpdateStrategies;
 }
 
 /** Optional parameters. */
@@ -133,8 +118,6 @@ export declare interface Fleet extends TrackedResource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly provisioningState?: FleetProvisioningState;
-    /** The FleetHubProfile configures the Fleet's hub. */
-    hubProfile?: FleetHubProfile;
 }
 
 /** One credential result item. */
@@ -160,26 +143,6 @@ export declare interface FleetCredentialResults {
     readonly kubeconfigs?: FleetCredentialResult[];
 }
 
-/** The FleetHubProfile configures the fleet hub. */
-export declare interface FleetHubProfile {
-    /** DNS prefix used to create the FQDN for the Fleet hub. */
-    dnsPrefix?: string;
-    /** The access profile for the Fleet hub API server. */
-    apiServerAccessProfile?: APIServerAccessProfile;
-    /** The agent profile for the Fleet hub. */
-    agentProfile?: AgentProfile;
-    /**
-     * The FQDN of the Fleet hub.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly fqdn?: string;
-    /**
-     * The Kubernetes version of the Fleet hub.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly kubernetesVersion?: string;
-}
-
 /** The response of a Fleet list operation. */
 export declare interface FleetListResult {
     /** The Fleet items on this page */
@@ -587,6 +550,154 @@ export declare interface FleetsUpdateOptionalParams extends coreClient.Operation
 /** Contains response data for the update operation. */
 export declare type FleetsUpdateResponse = Fleet;
 
+/** Interface representing a FleetUpdateStrategies. */
+export declare interface FleetUpdateStrategies {
+    /**
+     * List FleetUpdateStrategy resources by Fleet
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param fleetName The name of the Fleet resource.
+     * @param options The options parameters.
+     */
+    listByFleet(resourceGroupName: string, fleetName: string, options?: FleetUpdateStrategiesListByFleetOptionalParams): PagedAsyncIterableIterator<FleetUpdateStrategy>;
+    /**
+     * Get a FleetUpdateStrategy
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param fleetName The name of the Fleet resource.
+     * @param updateStrategyName The name of the UpdateStrategy resource.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, fleetName: string, updateStrategyName: string, options?: FleetUpdateStrategiesGetOptionalParams): Promise<FleetUpdateStrategiesGetResponse>;
+    /**
+     * Create a FleetUpdateStrategy
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param fleetName The name of the Fleet resource.
+     * @param updateStrategyName The name of the UpdateStrategy resource.
+     * @param resource Resource create parameters.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdate(resourceGroupName: string, fleetName: string, updateStrategyName: string, resource: FleetUpdateStrategy, options?: FleetUpdateStrategiesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FleetUpdateStrategiesCreateOrUpdateResponse>, FleetUpdateStrategiesCreateOrUpdateResponse>>;
+    /**
+     * Create a FleetUpdateStrategy
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param fleetName The name of the Fleet resource.
+     * @param updateStrategyName The name of the UpdateStrategy resource.
+     * @param resource Resource create parameters.
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAndWait(resourceGroupName: string, fleetName: string, updateStrategyName: string, resource: FleetUpdateStrategy, options?: FleetUpdateStrategiesCreateOrUpdateOptionalParams): Promise<FleetUpdateStrategiesCreateOrUpdateResponse>;
+    /**
+     * Delete a FleetUpdateStrategy
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param fleetName The name of the Fleet resource.
+     * @param updateStrategyName The name of the UpdateStrategy resource.
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, fleetName: string, updateStrategyName: string, options?: FleetUpdateStrategiesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    /**
+     * Delete a FleetUpdateStrategy
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param fleetName The name of the Fleet resource.
+     * @param updateStrategyName The name of the UpdateStrategy resource.
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, fleetName: string, updateStrategyName: string, options?: FleetUpdateStrategiesDeleteOptionalParams): Promise<void>;
+}
+
+/** Defines headers for FleetUpdateStrategies_createOrUpdate operation. */
+export declare interface FleetUpdateStrategiesCreateOrUpdateHeaders {
+    /** The Retry-After header can indicate how long the client should wait before polling the operation status. */
+    retryAfter?: number;
+}
+
+/** Optional parameters. */
+export declare interface FleetUpdateStrategiesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    /** The request should only proceed if an entity matches this string. */
+    ifMatch?: string;
+    /** The request should only proceed if no entity matches this string. */
+    ifNoneMatch?: string;
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type FleetUpdateStrategiesCreateOrUpdateResponse = FleetUpdateStrategy;
+
+/** Defines headers for FleetUpdateStrategies_delete operation. */
+export declare interface FleetUpdateStrategiesDeleteHeaders {
+    /** The Retry-After header can indicate how long the client should wait before polling the operation status. */
+    retryAfter?: number;
+    /** The Location header contains the URL where the status of the long running operation can be checked. */
+    location?: string;
+}
+
+/** Optional parameters. */
+export declare interface FleetUpdateStrategiesDeleteOptionalParams extends coreClient.OperationOptions {
+    /** The request should only proceed if an entity matches this string. */
+    ifMatch?: string;
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Optional parameters. */
+export declare interface FleetUpdateStrategiesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type FleetUpdateStrategiesGetResponse = FleetUpdateStrategy;
+
+/** Optional parameters. */
+export declare interface FleetUpdateStrategiesListByFleetNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByFleetNext operation. */
+export declare type FleetUpdateStrategiesListByFleetNextResponse = FleetUpdateStrategyListResult;
+
+/** Optional parameters. */
+export declare interface FleetUpdateStrategiesListByFleetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByFleet operation. */
+export declare type FleetUpdateStrategiesListByFleetResponse = FleetUpdateStrategyListResult;
+
+/** Defines a multi-stage process to perform update operations across members of a Fleet. */
+export declare interface FleetUpdateStrategy extends ProxyResource {
+    /**
+     * If eTag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly eTag?: string;
+    /**
+     * The provisioning state of the UpdateStrategy resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: FleetUpdateStrategyProvisioningState;
+    /** Defines the update sequence of the clusters. */
+    strategy?: UpdateRunStrategy;
+}
+
+/** The response of a FleetUpdateStrategy list operation. */
+export declare interface FleetUpdateStrategyListResult {
+    /** The FleetUpdateStrategy items on this page */
+    value: FleetUpdateStrategy[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+
+/**
+ * Defines values for FleetUpdateStrategyProvisioningState. \
+ * {@link KnownFleetUpdateStrategyProvisioningState} can be used interchangeably with FleetUpdateStrategyProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded**: Resource has been created. \
+ * **Failed**: Resource creation failed. \
+ * **Canceled**: Resource creation was canceled.
+ */
+export declare type FleetUpdateStrategyProvisioningState = string;
+
 /**
  * Given the last `.value` produced by the `byPage` iterator,
  * returns a continuation token that can be used to begin paging from
@@ -646,6 +757,16 @@ export declare enum KnownFleetProvisioningState {
     Deleting = "Deleting"
 }
 
+/** Known values of {@link FleetUpdateStrategyProvisioningState} that the service accepts. */
+export declare enum KnownFleetUpdateStrategyProvisioningState {
+    /** Resource has been created. */
+    Succeeded = "Succeeded",
+    /** Resource creation failed. */
+    Failed = "Failed",
+    /** Resource creation was canceled. */
+    Canceled = "Canceled"
+}
+
 /** Known values of {@link ManagedClusterUpgradeType} that the service accepts. */
 export declare enum KnownManagedClusterUpgradeType {
     /** Full upgrades the control plane and all agent pools of the target ManagedClusters. */
@@ -992,9 +1113,8 @@ export declare interface TrackedResource extends Resource {
 /** A group to be updated. */
 export declare interface UpdateGroup {
     /**
-     * The name of the Fleet member group to update.
-     * It should match the name of an existing FleetMember group.
-     * A group can only appear once across all UpdateStages in the UpdateRun.
+     * Name of the group.
+     * It must match a group name of an existing fleet member.
      */
     name: string;
 }
@@ -1018,7 +1138,7 @@ export declare interface UpdateGroupStatus {
     readonly members?: MemberUpdateStatus[];
 }
 
-/** An UpdateRun is a multi-stage process to perform update operations across members of a Fleet. */
+/** A multi-stage process to perform update operations across members of a Fleet. */
 export declare interface UpdateRun extends ProxyResource {
     /**
      * If eTag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
@@ -1030,6 +1150,21 @@ export declare interface UpdateRun extends ProxyResource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly provisioningState?: UpdateRunProvisioningState;
+    /**
+     * The resource id of the FleetUpdateStrategy resource to reference.
+     *
+     * When creating a new run, there are three ways to define a strategy for the run:
+     * 1. Define a new strategy in place: Set the "strategy" field.
+     * 2. Use an existing strategy: Set the "updateStrategyId" field. (since 2023-08-15-preview)
+     * 3. Use the default strategy to update all the members one by one: Leave both "updateStrategyId" and "strategy" unset. (since 2023-08-15-preview)
+     *
+     * Setting both "updateStrategyId" and "strategy" is invalid.
+     *
+     * UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field.
+     * Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate.
+     * UpdateRunStrategy changes can be made directly on the "strategy" field before launching the UpdateRun.
+     */
+    updateStrategyId?: string;
     /**
      * The strategy defines the order in which the clusters will be updated.
      * If not set, all members will be updated sequentially. The UpdateRun status will show a single UpdateStage and a single UpdateGroup targeting all members.
@@ -1270,26 +1405,25 @@ export declare interface UpdateRunStatus {
     readonly nodeImageSelection?: NodeImageSelectionStatus;
 }
 
-/** The UpdateRunStrategy configures the sequence of Stages and Groups in which the clusters will be updated. */
+/**
+ * Defines the update sequence of the clusters via stages and groups.
+ *
+ * Stages within a run are executed sequentially one after another.
+ * Groups within a stage are executed in parallel.
+ * Member clusters within a group are updated sequentially one after another.
+ *
+ * A valid strategy contains no duplicate groups within or across stages.
+ */
 export declare interface UpdateRunStrategy {
-    /** The list of stages that compose this update run. */
+    /** The list of stages that compose this update run. Min size: 1. */
     stages: UpdateStage[];
 }
 
-/**
- * Contains the groups to be updated by an UpdateRun.
- * Update order:
- * - Sequential between stages: Stages run sequentially. The previous stage must complete before the next one starts.
- * - Parallel within a stage: Groups within a stage run in parallel.
- * - Sequential within a group: Clusters within a group are updated sequentially.
- */
+/** Defines a stage which contains the groups to update and the steps to take (e.g., wait for a time period) before starting the next stage. */
 export declare interface UpdateStage {
     /** The name of the stage. Must be unique within the UpdateRun. */
     name: string;
-    /**
-     * A list of group names that compose the stage.
-     * The groups will be updated in parallel. Each group name can only appear once in the UpdateRun.
-     */
+    /** Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. */
     groups?: UpdateGroup[];
     /** The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. */
     afterStageWaitInSeconds?: number;

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.36.4"
+      "packageVersion": "7.38.0"
     }
   ]
 }

package/rollup.config.js

@@ -1,122 +0,0 @@
-/*
- * 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"));