Files
Deyaaeldeen AlmahallawiandGitHub 421539f1b0 [API view] Generate one per runtime (#35024)
Updates the API extraction logic to generate the full report for the
node package. It also generates API difference report for any other
supported package/runtime.
2025-07-16 13:07:16 -07:00

11 KiB

API Report File for "@azure/arm-commitmentplans"

Do not edit this file. It is a report generated by API Extractor.


import * as coreAuth from '@azure/core-auth';
import * as coreClient from '@azure/core-client';
import { PagedAsyncIterableIterator } from '@azure/core-paging';

// @public (undocumented)
export class AzureMLCommitmentPlansManagementClient extends coreClient.ServiceClient {
    // (undocumented)
    $host: string;
    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureMLCommitmentPlansManagementClientOptionalParams);
    // (undocumented)
    apiVersion: string;
    // (undocumented)
    commitmentAssociations: CommitmentAssociations;
    // (undocumented)
    commitmentPlans: CommitmentPlans;
    // (undocumented)
    operations: Operations;
    // (undocumented)
    skus: Skus;
    // (undocumented)
    subscriptionId: string;
    // (undocumented)
    usageHistory: UsageHistory;
}

// @public
export interface AzureMLCommitmentPlansManagementClientOptionalParams extends coreClient.ServiceClientOptions {
    $host?: string;
    apiVersion?: string;
    endpoint?: string;
}

// @public
export interface CatalogSku {
    readonly capabilities?: SkuCapability[];
    readonly capacity?: SkuCapacity;
    readonly costs?: SkuCost[];
    readonly locations?: string[];
    readonly name?: string;
    readonly resourceType?: string;
    readonly restrictions?: SkuRestrictions[];
    readonly tier?: string;
}

// @public
export interface CommitmentAssociation extends Resource {
    etag?: string;
    properties?: CommitmentAssociationProperties;
}

// @public
export interface CommitmentAssociationListResult {
    nextLink?: string;
    value?: CommitmentAssociation[];
}

// @public
export interface CommitmentAssociationProperties {
    readonly associatedResourceId?: string;
    readonly commitmentPlanId?: string;
    readonly creationDate?: Date;
}

// @public
export interface CommitmentAssociations {
    get(resourceGroupName: string, commitmentPlanName: string, commitmentAssociationName: string, options?: CommitmentAssociationsGetOptionalParams): Promise<CommitmentAssociationsGetResponse>;
    list(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentAssociationsListOptionalParams): PagedAsyncIterableIterator<CommitmentAssociation>;
    move(resourceGroupName: string, commitmentPlanName: string, commitmentAssociationName: string, movePayload: MoveCommitmentAssociationRequest, options?: CommitmentAssociationsMoveOptionalParams): Promise<CommitmentAssociationsMoveResponse>;
}

// @public
export interface CommitmentAssociationsGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CommitmentAssociationsGetResponse = CommitmentAssociation;

// @public
export interface CommitmentAssociationsListNextOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type CommitmentAssociationsListNextResponse = CommitmentAssociationListResult;

// @public
export interface CommitmentAssociationsListOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type CommitmentAssociationsListResponse = CommitmentAssociationListResult;

// @public
export interface CommitmentAssociationsMoveOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CommitmentAssociationsMoveResponse = CommitmentAssociation;

// @public
export interface CommitmentPlan extends Resource {
    etag?: string;
    readonly properties?: CommitmentPlanProperties;
    sku?: ResourceSku;
}

// @public
export interface CommitmentPlanListResult {
    nextLink?: string;
    value?: CommitmentPlan[];
}

// @public
export interface CommitmentPlanPatchPayload {
    sku?: ResourceSku;
    tags?: {
        [propertyName: string]: string;
    };
}

// @public
export interface CommitmentPlanProperties {
    readonly chargeForOverage?: boolean;
    readonly chargeForPlan?: boolean;
    readonly creationDate?: Date;
    readonly includedQuantities?: {
        [propertyName: string]: PlanQuantity;
    };
    readonly maxAssociationLimit?: number;
    readonly maxCapacityLimit?: number;
    readonly minCapacityLimit?: number;
    readonly planMeter?: string;
    readonly refillFrequencyInDays?: number;
    readonly suspendPlanOnOverage?: boolean;
}

// @public
export interface CommitmentPlans {
    createOrUpdate(resourceGroupName: string, commitmentPlanName: string, createOrUpdatePayload: CommitmentPlan, options?: CommitmentPlansCreateOrUpdateOptionalParams): Promise<CommitmentPlansCreateOrUpdateResponse>;
    get(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansGetOptionalParams): Promise<CommitmentPlansGetResponse>;
    list(options?: CommitmentPlansListOptionalParams): PagedAsyncIterableIterator<CommitmentPlan>;
    listInResourceGroup(resourceGroupName: string, options?: CommitmentPlansListInResourceGroupOptionalParams): PagedAsyncIterableIterator<CommitmentPlan>;
    patch(resourceGroupName: string, commitmentPlanName: string, patchPayload: CommitmentPlanPatchPayload, options?: CommitmentPlansPatchOptionalParams): Promise<CommitmentPlansPatchResponse>;
    remove(resourceGroupName: string, commitmentPlanName: string, options?: CommitmentPlansRemoveOptionalParams): Promise<void>;
}

// @public
export interface CommitmentPlansCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CommitmentPlansCreateOrUpdateResponse = CommitmentPlan;

// @public
export interface CommitmentPlansGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CommitmentPlansGetResponse = CommitmentPlan;

// @public
export interface CommitmentPlansListInResourceGroupNextOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type CommitmentPlansListInResourceGroupNextResponse = CommitmentPlanListResult;

// @public
export interface CommitmentPlansListInResourceGroupOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type CommitmentPlansListInResourceGroupResponse = CommitmentPlanListResult;

// @public
export interface CommitmentPlansListNextOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type CommitmentPlansListNextResponse = CommitmentPlanListResult;

// @public
export interface CommitmentPlansListOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type CommitmentPlansListResponse = CommitmentPlanListResult;

// @public
export interface CommitmentPlansPatchOptionalParams extends coreClient.OperationOptions {
}

// @public
export type CommitmentPlansPatchResponse = CommitmentPlan;

// @public
export interface CommitmentPlansRemoveOptionalParams extends coreClient.OperationOptions {
}

// @public
export function getContinuationToken(page: unknown): string | undefined;

// @public
export enum KnownResourceSkuRestrictionsReasonCode {
    NotAvailableForSubscription = "NotAvailableForSubscription",
    QuotaId = "QuotaId"
}

// @public
export enum KnownResourceSkuRestrictionsType {
    Location = "location",
    Zone = "zone"
}

// @public
export enum KnownSkuCapacityScaleType {
    Automatic = "Automatic",
    Manual = "Manual",
    None = "None"
}

// @public
export interface MoveCommitmentAssociationRequest {
    destinationPlanId?: string;
}

// @public
export interface OperationDisplayInfo {
    readonly description?: string;
    readonly operation?: string;
    readonly provider?: string;
    readonly resource?: string;
}

// @public
export interface OperationEntity {
    display?: OperationDisplayInfo;
    readonly name?: string;
}

// @public
export interface OperationEntityListResult {
    readonly value?: OperationEntity[];
}

// @public
export interface Operations {
    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationEntity>;
}

// @public
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type OperationsListResponse = OperationEntityListResult;

// @public
export interface PlanQuantity {
    readonly allowance?: number;
    readonly amount?: number;
    readonly includedQuantityMeter?: string;
    readonly overageMeter?: string;
}

// @public
export interface PlanUsageHistory {
    planDeletionOverage?: {
        [propertyName: string]: number;
    };
    planMigrationOverage?: {
        [propertyName: string]: number;
    };
    planQuantitiesAfterUsage?: {
        [propertyName: string]: number;
    };
    planQuantitiesBeforeUsage?: {
        [propertyName: string]: number;
    };
    planUsageOverage?: {
        [propertyName: string]: number;
    };
    usage?: {
        [propertyName: string]: number;
    };
    usageDate?: Date;
}

// @public
export interface PlanUsageHistoryListResult {
    nextLink?: string;
    value?: PlanUsageHistory[];
}

// @public
export interface Resource {
    readonly id?: string;
    location: string;
    readonly name?: string;
    tags?: {
        [propertyName: string]: string;
    };
    readonly type?: string;
}

// @public
export interface ResourceSku {
    capacity?: number;
    name?: string;
    tier?: string;
}

// @public
export type ResourceSkuRestrictionsReasonCode = string;

// @public
export type ResourceSkuRestrictionsType = string;

// @public
export interface SkuCapability {
    readonly name?: string;
    readonly value?: string;
}

// @public
export interface SkuCapacity {
    readonly default?: number;
    readonly maximum?: number;
    readonly minimum?: number;
    readonly scaleType?: SkuCapacityScaleType;
}

// @public
export type SkuCapacityScaleType = string;

// @public
export interface SkuCost {
    readonly extendedUnit?: string;
    readonly meterID?: string;
    readonly quantity?: number;
}

// @public
export interface SkuListResult {
    readonly value?: CatalogSku[];
}

// @public
export interface SkuRestrictions {
    readonly reasonCode?: ResourceSkuRestrictionsReasonCode;
    readonly type?: ResourceSkuRestrictionsType;
    readonly values?: string[];
}

// @public
export interface Skus {
    list(options?: SkusListOptionalParams): PagedAsyncIterableIterator<CatalogSku>;
}

// @public
export interface SkusListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type SkusListResponse = SkuListResult;

// @public
export interface UsageHistory {
    list(resourceGroupName: string, commitmentPlanName: string, options?: UsageHistoryListOptionalParams): PagedAsyncIterableIterator<PlanUsageHistory>;
}

// @public
export interface UsageHistoryListNextOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type UsageHistoryListNextResponse = PlanUsageHistoryListResult;

// @public
export interface UsageHistoryListOptionalParams extends coreClient.OperationOptions {
    skipToken?: string;
}

// @public
export type UsageHistoryListResponse = PlanUsageHistoryListResult;

// (No @packageDocumentation comment for this package)