@azure/arm-computeschedule 1.0.0-beta.1

package/review/arm-computeschedule-models.api.md

@@ -0,0 +1,306 @@
+## API Report File for "@azure/arm-computeschedule"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { OperationOptions } from '@azure-rest/core-client';
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface CancelOperationsRequest {
+    correlationid: string;
+    operationIds: string[];
+}
+
+// @public
+export interface CancelOperationsResponse {
+    results: ResourceOperation[];
+}
+
+// @public
+export type DeadlineType = string;
+
+// @public
+export interface DeallocateResourceOperationResponse {
+    description: string;
+    location: string;
+    results?: ResourceOperation[];
+    type: string;
+}
+
+// @public
+export interface ExecuteDeallocateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+}
+
+// @public
+export interface ExecuteHibernateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+}
+
+// @public
+export interface ExecuteStartRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+}
+
+// @public
+export interface ExecutionParameters {
+    optimizationPreference?: OptimizationPreference;
+    retryPolicy?: RetryPolicy;
+}
+
+// @public
+export interface GetOperationErrorsRequest {
+    operationIds: string[];
+}
+
+// @public
+export interface GetOperationErrorsResponse {
+    results: OperationErrorsResult[];
+}
+
+// @public
+export interface GetOperationStatusRequest {
+    correlationid: string;
+    operationIds: string[];
+}
+
+// @public
+export interface GetOperationStatusResponse {
+    results: ResourceOperation[];
+}
+
+// @public
+export interface HibernateResourceOperationResponse {
+    description: string;
+    location: string;
+    results?: ResourceOperation[];
+    type: string;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownDeadlineType {
+    CompleteBy = "CompleteBy",
+    InitiateAt = "InitiateAt",
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownOperationState {
+    Blocked = "Blocked",
+    Cancelled = "Cancelled",
+    Executing = "Executing",
+    Failed = "Failed",
+    PendingExecution = "PendingExecution",
+    PendingScheduling = "PendingScheduling",
+    Scheduled = "Scheduled",
+    Succeeded = "Succeeded",
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownOptimizationPreference {
+    Availability = "Availability",
+    Cost = "Cost",
+    CostAvailabilityBalanced = "CostAvailabilityBalanced"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownResourceOperationType {
+    Deallocate = "Deallocate",
+    Hibernate = "Hibernate",
+    Start = "Start",
+    Unknown = "Unknown"
+}
+
+// @public
+export interface Operation {
+    actionType?: ActionType;
+    readonly 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 OperationErrorDetails {
+    crpOperationId: string;
+    errorCode: string;
+    errorDetails: string;
+    timeStamp: string;
+}
+
+// @public
+export interface OperationErrorsResult {
+    activationTime?: string;
+    completedAt?: string;
+    creationTime?: string;
+    operationErrors?: OperationErrorDetails[];
+    operationId?: string;
+    requestErrorCode?: string;
+    requestErrorDetails?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export type OperationState = string;
+
+// @public
+export type OptimizationPreference = string;
+
+// @public
+export type Origin = string;
+
+// @public
+export interface ResourceOperation {
+    errorCode?: string;
+    errorDetails?: string;
+    operation?: ResourceOperationDetails;
+    resourceId?: string;
+}
+
+// @public
+export interface ResourceOperationDetails {
+    completedAt?: string;
+    deadline: string;
+    deadlineType: DeadlineType;
+    operationId: string;
+    opType: ResourceOperationType;
+    resourceId: string;
+    resourceOperationError?: ResourceOperationError;
+    retryPolicy?: RetryPolicy;
+    state: OperationState;
+    subscriptionId: string;
+    timeZone?: string;
+}
+
+// @public
+export interface ResourceOperationError {
+    errorCode: string;
+    errorDetails: string;
+}
+
+// @public
+export type ResourceOperationType = string;
+
+// @public
+export interface Resources {
+    ids: string[];
+}
+
+// @public
+export interface RetryPolicy {
+    retryCount?: number;
+    retryWindowInMinutes?: number;
+}
+
+// @public
+export interface Schedule {
+    deadLine: string;
+    deadlineType: DeadlineType;
+    timeZone: string;
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesCancelOperationsOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesExecuteDeallocateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesExecuteHibernateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesExecuteStartOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesGetOperationErrorsOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesGetOperationStatusOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesSubmitDeallocateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesSubmitHibernateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesSubmitStartOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface StartResourceOperationResponse {
+    description: string;
+    location: string;
+    results?: ResourceOperation[];
+    type: string;
+}
+
+// @public
+export interface SubmitDeallocateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+    schedule: Schedule;
+}
+
+// @public
+export interface SubmitHibernateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+    schedule: Schedule;
+}
+
+// @public
+export interface SubmitStartRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+    schedule: Schedule;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/review/arm-computeschedule.api.md

@@ -0,0 +1,357 @@
+## API Report File for "@azure/arm-computeschedule"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface CancelOperationsRequest {
+    correlationid: string;
+    operationIds: string[];
+}
+
+// @public
+export interface CancelOperationsResponse {
+    results: ResourceOperation[];
+}
+
+// @public (undocumented)
+export class ComputeScheduleClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: ComputeScheduleClientOptionalParams);
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+    readonly scheduledActions: ScheduledActionsOperations;
+}
+
+// @public
+export interface ComputeScheduleClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type DeadlineType = string;
+
+// @public
+export interface DeallocateResourceOperationResponse {
+    description: string;
+    location: string;
+    results?: ResourceOperation[];
+    type: string;
+}
+
+// @public
+export interface ExecuteDeallocateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+}
+
+// @public
+export interface ExecuteHibernateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+}
+
+// @public
+export interface ExecuteStartRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+}
+
+// @public
+export interface ExecutionParameters {
+    optimizationPreference?: OptimizationPreference;
+    retryPolicy?: RetryPolicy;
+}
+
+// @public
+export interface GetOperationErrorsRequest {
+    operationIds: string[];
+}
+
+// @public
+export interface GetOperationErrorsResponse {
+    results: OperationErrorsResult[];
+}
+
+// @public
+export interface GetOperationStatusRequest {
+    correlationid: string;
+    operationIds: string[];
+}
+
+// @public
+export interface GetOperationStatusResponse {
+    results: ResourceOperation[];
+}
+
+// @public
+export interface HibernateResourceOperationResponse {
+    description: string;
+    location: string;
+    results?: ResourceOperation[];
+    type: string;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownDeadlineType {
+    CompleteBy = "CompleteBy",
+    InitiateAt = "InitiateAt",
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownOperationState {
+    Blocked = "Blocked",
+    Cancelled = "Cancelled",
+    Executing = "Executing",
+    Failed = "Failed",
+    PendingExecution = "PendingExecution",
+    PendingScheduling = "PendingScheduling",
+    Scheduled = "Scheduled",
+    Succeeded = "Succeeded",
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownOptimizationPreference {
+    Availability = "Availability",
+    Cost = "Cost",
+    CostAvailabilityBalanced = "CostAvailabilityBalanced"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownResourceOperationType {
+    Deallocate = "Deallocate",
+    Hibernate = "Hibernate",
+    Start = "Start",
+    Unknown = "Unknown"
+}
+
+// @public
+export interface Operation {
+    actionType?: ActionType;
+    readonly 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 OperationErrorDetails {
+    crpOperationId: string;
+    errorCode: string;
+    errorDetails: string;
+    timeStamp: string;
+}
+
+// @public
+export interface OperationErrorsResult {
+    activationTime?: string;
+    completedAt?: string;
+    creationTime?: string;
+    operationErrors?: OperationErrorDetails[];
+    operationId?: string;
+    requestErrorCode?: string;
+    requestErrorDetails?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export type OperationState = string;
+
+// @public
+export type OptimizationPreference = string;
+
+// @public
+export type Origin = string;
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+export interface ResourceOperation {
+    errorCode?: string;
+    errorDetails?: string;
+    operation?: ResourceOperationDetails;
+    resourceId?: string;
+}
+
+// @public
+export interface ResourceOperationDetails {
+    completedAt?: string;
+    deadline: string;
+    deadlineType: DeadlineType;
+    operationId: string;
+    opType: ResourceOperationType;
+    resourceId: string;
+    resourceOperationError?: ResourceOperationError;
+    retryPolicy?: RetryPolicy;
+    state: OperationState;
+    subscriptionId: string;
+    timeZone?: string;
+}
+
+// @public
+export interface ResourceOperationError {
+    errorCode: string;
+    errorDetails: string;
+}
+
+// @public
+export type ResourceOperationType = string;
+
+// @public
+export interface Resources {
+    ids: string[];
+}
+
+// @public
+export interface RetryPolicy {
+    retryCount?: number;
+    retryWindowInMinutes?: number;
+}
+
+// @public
+export interface Schedule {
+    deadLine: string;
+    deadlineType: DeadlineType;
+    timeZone: string;
+}
+
+// @public
+export interface ScheduledActionsOperations {
+    virtualMachinesCancelOperations: (locationparameter: string, requestBody: CancelOperationsRequest, options?: ScheduledActionsVirtualMachinesCancelOperationsOptionalParams) => Promise<CancelOperationsResponse>;
+    virtualMachinesExecuteDeallocate: (locationparameter: string, requestBody: ExecuteDeallocateRequest, options?: ScheduledActionsVirtualMachinesExecuteDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>;
+    virtualMachinesExecuteHibernate: (locationparameter: string, requestBody: ExecuteHibernateRequest, options?: ScheduledActionsVirtualMachinesExecuteHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>;
+    virtualMachinesExecuteStart: (locationparameter: string, requestBody: ExecuteStartRequest, options?: ScheduledActionsVirtualMachinesExecuteStartOptionalParams) => Promise<StartResourceOperationResponse>;
+    virtualMachinesGetOperationErrors: (locationparameter: string, requestBody: GetOperationErrorsRequest, options?: ScheduledActionsVirtualMachinesGetOperationErrorsOptionalParams) => Promise<GetOperationErrorsResponse>;
+    virtualMachinesGetOperationStatus: (locationparameter: string, requestBody: GetOperationStatusRequest, options?: ScheduledActionsVirtualMachinesGetOperationStatusOptionalParams) => Promise<GetOperationStatusResponse>;
+    virtualMachinesSubmitDeallocate: (locationparameter: string, requestBody: SubmitDeallocateRequest, options?: ScheduledActionsVirtualMachinesSubmitDeallocateOptionalParams) => Promise<DeallocateResourceOperationResponse>;
+    virtualMachinesSubmitHibernate: (locationparameter: string, requestBody: SubmitHibernateRequest, options?: ScheduledActionsVirtualMachinesSubmitHibernateOptionalParams) => Promise<HibernateResourceOperationResponse>;
+    virtualMachinesSubmitStart: (locationparameter: string, requestBody: SubmitStartRequest, options?: ScheduledActionsVirtualMachinesSubmitStartOptionalParams) => Promise<StartResourceOperationResponse>;
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesCancelOperationsOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesExecuteDeallocateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesExecuteHibernateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesExecuteStartOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesGetOperationErrorsOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesGetOperationStatusOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesSubmitDeallocateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesSubmitHibernateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ScheduledActionsVirtualMachinesSubmitStartOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface StartResourceOperationResponse {
+    description: string;
+    location: string;
+    results?: ResourceOperation[];
+    type: string;
+}
+
+// @public
+export interface SubmitDeallocateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+    schedule: Schedule;
+}
+
+// @public
+export interface SubmitHibernateRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+    schedule: Schedule;
+}
+
+// @public
+export interface SubmitStartRequest {
+    correlationid: string;
+    executionParameters: ExecutionParameters;
+    resources: Resources;
+    schedule: Schedule;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```