@azure/arm-standbypool 1.0.0-beta.1

package/review/arm-standbypool.api.md

@@ -0,0 +1,520 @@
+## API Report File for "@azure/arm-standbypool"
+
+> 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 { OperationState } from '@azure/core-lro';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { SimplePollerLike } from '@azure/core-lro';
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface ContainerGroupProfile {
+    id: string;
+    revision?: number;
+}
+
+// @public
+export interface ContainerGroupProfileUpdate {
+    id?: string;
+    revision?: number;
+}
+
+// @public
+export interface ContainerGroupProperties {
+    containerGroupProfile: ContainerGroupProfile;
+    subnetIds?: Subnet[];
+}
+
+// @public
+export interface ContainerGroupPropertiesUpdate {
+    containerGroupProfile?: ContainerGroupProfileUpdate;
+    subnetIds?: Subnet[];
+}
+
+// @public
+export type CreatedByType = 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 function getContinuationToken(page: unknown): string | undefined;
+
+// @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",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownRefillPolicy {
+    Always = "always"
+}
+
+// @public
+export enum KnownVirtualMachineState {
+    Deallocated = "Deallocated",
+    Running = "Running"
+}
+
+// @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 type RefillPolicy = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface StandbyContainerGroupPoolElasticityProfile {
+    maxReadyCapacity: number;
+    refillPolicy?: RefillPolicy;
+}
+
+// @public
+export interface StandbyContainerGroupPoolElasticityProfileUpdate {
+    maxReadyCapacity?: number;
+    refillPolicy?: RefillPolicy;
+}
+
+// @public
+export interface StandbyContainerGroupPoolResource extends TrackedResource {
+    properties?: StandbyContainerGroupPoolResourceProperties;
+}
+
+// @public
+export interface StandbyContainerGroupPoolResourceListResult {
+    nextLink?: string;
+    value: StandbyContainerGroupPoolResource[];
+}
+
+// @public
+export interface StandbyContainerGroupPoolResourceProperties {
+    containerGroupProperties: ContainerGroupProperties;
+    elasticityProfile: StandbyContainerGroupPoolElasticityProfile;
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface StandbyContainerGroupPoolResourceUpdate {
+    properties?: StandbyContainerGroupPoolResourceUpdateProperties;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface StandbyContainerGroupPoolResourceUpdateProperties {
+    containerGroupProperties?: ContainerGroupPropertiesUpdate;
+    elasticityProfile?: StandbyContainerGroupPoolElasticityProfileUpdate;
+}
+
+// @public
+export interface StandbyContainerGroupPools {
+    beginCreateOrUpdate(resourceGroupName: string, standbyContainerGroupPoolName: string, resource: StandbyContainerGroupPoolResource, options?: StandbyContainerGroupPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<StandbyContainerGroupPoolsCreateOrUpdateResponse>, StandbyContainerGroupPoolsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, standbyContainerGroupPoolName: string, resource: StandbyContainerGroupPoolResource, options?: StandbyContainerGroupPoolsCreateOrUpdateOptionalParams): Promise<StandbyContainerGroupPoolsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, standbyContainerGroupPoolName: string, options?: StandbyContainerGroupPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<StandbyContainerGroupPoolsDeleteResponse>, StandbyContainerGroupPoolsDeleteResponse>>;
+    beginDeleteAndWait(resourceGroupName: string, standbyContainerGroupPoolName: string, options?: StandbyContainerGroupPoolsDeleteOptionalParams): Promise<StandbyContainerGroupPoolsDeleteResponse>;
+    get(resourceGroupName: string, standbyContainerGroupPoolName: string, options?: StandbyContainerGroupPoolsGetOptionalParams): Promise<StandbyContainerGroupPoolsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: StandbyContainerGroupPoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StandbyContainerGroupPoolResource>;
+    listBySubscription(options?: StandbyContainerGroupPoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StandbyContainerGroupPoolResource>;
+    update(resourceGroupName: string, standbyContainerGroupPoolName: string, properties: StandbyContainerGroupPoolResourceUpdate, options?: StandbyContainerGroupPoolsUpdateOptionalParams): Promise<StandbyContainerGroupPoolsUpdateResponse>;
+}
+
+// @public
+export interface StandbyContainerGroupPoolsCreateOrUpdateHeaders {
+    retryAfter?: number;
+}
+
+// @public
+export interface StandbyContainerGroupPoolsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type StandbyContainerGroupPoolsCreateOrUpdateResponse = StandbyContainerGroupPoolResource;
+
+// @public
+export interface StandbyContainerGroupPoolsDeleteHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface StandbyContainerGroupPoolsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type StandbyContainerGroupPoolsDeleteResponse = StandbyContainerGroupPoolsDeleteHeaders;
+
+// @public
+export interface StandbyContainerGroupPoolsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyContainerGroupPoolsGetResponse = StandbyContainerGroupPoolResource;
+
+// @public
+export interface StandbyContainerGroupPoolsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyContainerGroupPoolsListByResourceGroupNextResponse = StandbyContainerGroupPoolResourceListResult;
+
+// @public
+export interface StandbyContainerGroupPoolsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyContainerGroupPoolsListByResourceGroupResponse = StandbyContainerGroupPoolResourceListResult;
+
+// @public
+export interface StandbyContainerGroupPoolsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyContainerGroupPoolsListBySubscriptionNextResponse = StandbyContainerGroupPoolResourceListResult;
+
+// @public
+export interface StandbyContainerGroupPoolsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyContainerGroupPoolsListBySubscriptionResponse = StandbyContainerGroupPoolResourceListResult;
+
+// @public
+export interface StandbyContainerGroupPoolsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyContainerGroupPoolsUpdateResponse = StandbyContainerGroupPoolResource;
+
+// @public (undocumented)
+export class StandbyPoolManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: StandbyPoolManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    standbyContainerGroupPools: StandbyContainerGroupPools;
+    // (undocumented)
+    standbyVirtualMachinePools: StandbyVirtualMachinePools;
+    // (undocumented)
+    standbyVirtualMachines: StandbyVirtualMachines;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface StandbyPoolManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolElasticityProfile {
+    maxReadyCapacity: number;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolElasticityProfileUpdate {
+    maxReadyCapacity?: number;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolResource extends TrackedResource {
+    properties?: StandbyVirtualMachinePoolResourceProperties;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolResourceListResult {
+    nextLink?: string;
+    value: StandbyVirtualMachinePoolResource[];
+}
+
+// @public
+export interface StandbyVirtualMachinePoolResourceProperties {
+    attachedVirtualMachineScaleSetId?: string;
+    elasticityProfile?: StandbyVirtualMachinePoolElasticityProfile;
+    readonly provisioningState?: ProvisioningState;
+    virtualMachineState: VirtualMachineState;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolResourceUpdate {
+    properties?: StandbyVirtualMachinePoolResourceUpdateProperties;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface StandbyVirtualMachinePoolResourceUpdateProperties {
+    attachedVirtualMachineScaleSetId?: string;
+    elasticityProfile?: StandbyVirtualMachinePoolElasticityProfileUpdate;
+    virtualMachineState?: VirtualMachineState;
+}
+
+// @public
+export interface StandbyVirtualMachinePools {
+    beginCreateOrUpdate(resourceGroupName: string, standbyVirtualMachinePoolName: string, resource: StandbyVirtualMachinePoolResource, options?: StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<StandbyVirtualMachinePoolsCreateOrUpdateResponse>, StandbyVirtualMachinePoolsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, standbyVirtualMachinePoolName: string, resource: StandbyVirtualMachinePoolResource, options?: StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams): Promise<StandbyVirtualMachinePoolsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, standbyVirtualMachinePoolName: string, options?: StandbyVirtualMachinePoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<StandbyVirtualMachinePoolsDeleteResponse>, StandbyVirtualMachinePoolsDeleteResponse>>;
+    beginDeleteAndWait(resourceGroupName: string, standbyVirtualMachinePoolName: string, options?: StandbyVirtualMachinePoolsDeleteOptionalParams): Promise<StandbyVirtualMachinePoolsDeleteResponse>;
+    get(resourceGroupName: string, standbyVirtualMachinePoolName: string, options?: StandbyVirtualMachinePoolsGetOptionalParams): Promise<StandbyVirtualMachinePoolsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: StandbyVirtualMachinePoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StandbyVirtualMachinePoolResource>;
+    listBySubscription(options?: StandbyVirtualMachinePoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StandbyVirtualMachinePoolResource>;
+    update(resourceGroupName: string, standbyVirtualMachinePoolName: string, properties: StandbyVirtualMachinePoolResourceUpdate, options?: StandbyVirtualMachinePoolsUpdateOptionalParams): Promise<StandbyVirtualMachinePoolsUpdateResponse>;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolsCreateOrUpdateHeaders {
+    retryAfter?: number;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type StandbyVirtualMachinePoolsCreateOrUpdateResponse = StandbyVirtualMachinePoolResource;
+
+// @public
+export interface StandbyVirtualMachinePoolsDeleteHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface StandbyVirtualMachinePoolsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type StandbyVirtualMachinePoolsDeleteResponse = StandbyVirtualMachinePoolsDeleteHeaders;
+
+// @public
+export interface StandbyVirtualMachinePoolsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinePoolsGetResponse = StandbyVirtualMachinePoolResource;
+
+// @public
+export interface StandbyVirtualMachinePoolsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinePoolsListByResourceGroupNextResponse = StandbyVirtualMachinePoolResourceListResult;
+
+// @public
+export interface StandbyVirtualMachinePoolsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinePoolsListByResourceGroupResponse = StandbyVirtualMachinePoolResourceListResult;
+
+// @public
+export interface StandbyVirtualMachinePoolsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinePoolsListBySubscriptionNextResponse = StandbyVirtualMachinePoolResourceListResult;
+
+// @public
+export interface StandbyVirtualMachinePoolsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinePoolsListBySubscriptionResponse = StandbyVirtualMachinePoolResourceListResult;
+
+// @public
+export interface StandbyVirtualMachinePoolsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinePoolsUpdateResponse = StandbyVirtualMachinePoolResource;
+
+// @public
+export interface StandbyVirtualMachineResource extends ProxyResource {
+    properties?: StandbyVirtualMachineResourceProperties;
+}
+
+// @public
+export interface StandbyVirtualMachineResourceListResult {
+    nextLink?: string;
+    value: StandbyVirtualMachineResource[];
+}
+
+// @public
+export interface StandbyVirtualMachineResourceProperties {
+    readonly provisioningState?: ProvisioningState;
+    virtualMachineResourceId: string;
+}
+
+// @public
+export interface StandbyVirtualMachines {
+    get(resourceGroupName: string, standbyVirtualMachinePoolName: string, standbyVirtualMachineName: string, options?: StandbyVirtualMachinesGetOptionalParams): Promise<StandbyVirtualMachinesGetResponse>;
+    listByStandbyVirtualMachinePoolResource(resourceGroupName: string, standbyVirtualMachinePoolName: string, options?: StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceOptionalParams): PagedAsyncIterableIterator<StandbyVirtualMachineResource>;
+}
+
+// @public
+export interface StandbyVirtualMachinesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinesGetResponse = StandbyVirtualMachineResource;
+
+// @public
+export interface StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceNextResponse = StandbyVirtualMachineResourceListResult;
+
+// @public
+export interface StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type StandbyVirtualMachinesListByStandbyVirtualMachinePoolResourceResponse = StandbyVirtualMachineResourceListResult;
+
+// @public
+export interface Subnet {
+    id: string;
+}
+
+// @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 type VirtualMachineState = string;
+
+// (No @packageDocumentation comment for this package)
+
+```

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

package/src/lroImpl.ts

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { AbortSignalLike } from "@azure/abort-controller";
+import { LongRunningOperation, LroResponse } from "@azure/core-lro";
+
+export function createLroSpec<T>(inputs: {
+  sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>;
+  args: Record<string, unknown>;
+  spec: {
+    readonly requestBody?: unknown;
+    readonly path?: string;
+    readonly httpMethod: string;
+  } & Record<string, any>;
+}): LongRunningOperation<T> {
+  const { args, spec, sendOperationFn } = inputs;
+  return {
+    requestMethod: spec.httpMethod,
+    requestPath: spec.path!,
+    sendInitialRequest: () => sendOperationFn(args, spec),
+    sendPollRequest: (
+      path: string,
+      options?: { abortSignal?: AbortSignalLike },
+    ) => {
+      const { requestBody, ...restSpec } = spec;
+      return sendOperationFn(args, {
+        ...restSpec,
+        httpMethod: "GET",
+        path,
+        abortSignal: options?.abortSignal,
+      });
+    },
+  };
+}