@azure/arm-commerce 2.1.1 → 4.0.0-beta.1

package/types/arm-commerce.d.ts

@@ -0,0 +1,247 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+/** Defines values for AggregationGranularity. */
+export declare type AggregationGranularity = "Daily" | "Hourly";
+
+/** Describes the format of Error response. */
+export declare interface ErrorResponse {
+    /** Error code */
+    code?: string;
+    /** Error message indicating why the operation failed. */
+    message?: string;
+}
+
+/** Key-value pairs of instance details in the legacy format. */
+export declare interface InfoField {
+    /** Identifies the name of the instance provisioned by the user. */
+    project?: string;
+}
+
+/** Detailed information about the meter. */
+export declare interface MeterInfo {
+    /** The unique identifier of the resource. */
+    meterId?: string;
+    /** The name of the meter, within the given meter category */
+    meterName?: string;
+    /** The category of the meter, e.g., 'Cloud services', 'Networking', etc.. */
+    meterCategory?: string;
+    /** The subcategory of the meter, e.g., 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. */
+    meterSubCategory?: string;
+    /** The unit in which the meter consumption is charged, e.g., 'Hours', 'GB', etc. */
+    unit?: string;
+    /** Provides additional meter data. 'Third Party' indicates a meter with no discount. Blanks indicate First Party. */
+    meterTags?: string[];
+    /** The region in which the Azure service is available. */
+    meterRegion?: string;
+    /** The list of key/value pairs for the meter rates, in the format 'key':'value' where key = the meter quantity, and value = the corresponding price */
+    meterRates?: {
+        [propertyName: string]: number;
+    };
+    /** Indicates the date from which the meter rate is effective. */
+    effectiveDate?: Date;
+    /** The resource quantity that is included in the offer at no cost. Consumption beyond this quantity will be charged. */
+    includedQuantity?: number;
+}
+
+/** Indicates that a monetary commitment is required for this offer */
+export declare type MonetaryCommitment = OfferTermInfoAutoGenerated & {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    name: "Monetary Commitment";
+    /** The list of key/value pairs for the tiered meter rates, in the format 'key':'value' where key = price, and value = the corresponding discount percentage. This field is used only by offer terms of type 'Monetary Commitment'. */
+    tieredDiscount?: {
+        [propertyName: string]: number;
+    };
+    /** An array of meter ids that are excluded from the given offer terms. */
+    excludedMeterIds?: string[];
+};
+
+/** Indicates that this is a monetary credit offer. */
+export declare type MonetaryCredit = OfferTermInfoAutoGenerated & {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    name: "Monetary Credit";
+    /** The amount of credit provided under the terms of the given offer level. */
+    credit?: number;
+    /** An array of meter ids that are excluded from the given offer terms. */
+    excludedMeterIds?: string[];
+};
+
+/** Defines values for OfferTermInfo. */
+export declare type OfferTermInfo = "Recurring Charge" | "Monetary Commitment" | "Monetary Credit";
+
+/** Describes the offer term. */
+export declare interface OfferTermInfoAutoGenerated {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    name: "Monetary Credit" | "Monetary Commitment" | "Recurring Charge";
+    /** Indicates the date from which the offer term is effective. */
+    effectiveDate?: Date;
+}
+
+export declare type OfferTermInfoAutoGeneratedUnion = OfferTermInfoAutoGenerated | MonetaryCredit | MonetaryCommitment | RecurringCharge;
+
+/** Interface representing a RateCard. */
+export declare interface RateCard {
+    /**
+     * Enables you to query for the resource/meter metadata and related prices used in a given subscription
+     * by Offer ID, Currency, Locale and Region. The metadata associated with the billing meters, including
+     * but not limited to service names, types, resources, units of measure, and regions, is subject to
+     * change at any time and without notice. If you intend to use this billing data in an automated
+     * fashion, please use the billing meter GUID to uniquely identify each billable item. If the billing
+     * meter GUID is scheduled to change due to a new billing model, you will be notified in advance of the
+     * change.
+     * @param filter The filter to apply on the operation. It ONLY supports the 'eq' and 'and' logical
+     *               operators at this time. All the 4 query parameters 'OfferDurableId',  'Currency', 'Locale', 'Region'
+     *               are required to be a part of the $filter.
+     * @param options The options parameters.
+     */
+    get(filter: string, options?: RateCardGetOptionalParams): Promise<RateCardGetResponse>;
+}
+
+/** Optional parameters. */
+export declare interface RateCardGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type RateCardGetResponse = ResourceRateCardInfo;
+
+/** Parameters that are used in the odata $filter query parameter for providing RateCard information. */
+export declare interface RateCardQueryParameters {
+    /** The Offer ID parameter consists of the 'MS-AZR-' prefix, plus the Offer ID number (e.g., MS-AZR-0026P). See https://azure.microsoft.com/en-us/support/legal/offer-details/ for more information on the list of available Offer IDs, country/region availability, and billing currency. */
+    offerDurableId: string;
+    /** The currency in which the rates need to be provided. */
+    currency: string;
+    /** The culture in which the resource metadata needs to be localized. */
+    locale: string;
+    /** 2 letter ISO code where the offer was purchased. */
+    regionInfo: string;
+}
+
+/** Indicates a recurring charge is present for this offer. */
+export declare type RecurringCharge = OfferTermInfoAutoGenerated & {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    name: "Recurring Charge";
+    /** The amount of recurring charge as per the offer term. */
+    recurringCharge?: number;
+};
+
+/** Price and Metadata information for resources */
+export declare interface ResourceRateCardInfo {
+    /** The currency in which the rates are provided. */
+    currency?: string;
+    /** The culture in which the resource information is localized. */
+    locale?: string;
+    /** All rates are pretax, so this will always be returned as 'false'. */
+    isTaxIncluded?: boolean;
+    /** A list of offer terms. */
+    offerTerms?: OfferTermInfoAutoGeneratedUnion[];
+    /** A list of meters. */
+    meters?: MeterInfo[];
+}
+
+/** Interface representing a UsageAggregates. */
+export declare interface UsageAggregates {
+    /**
+     * Query aggregated Azure subscription consumption data for a date range.
+     * @param reportedStartTime The start of the time range to retrieve data for.
+     * @param reportedEndTime The end of the time range to retrieve data for.
+     * @param options The options parameters.
+     */
+    list(reportedStartTime: Date, reportedEndTime: Date, options?: UsageAggregatesListOptionalParams): PagedAsyncIterableIterator<UsageAggregation>;
+}
+
+/** Optional parameters. */
+export declare interface UsageAggregatesListNextOptionalParams extends coreClient.OperationOptions {
+    /** `True` returns usage data in instance-level detail, `false` causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime). */
+    showDetails?: boolean;
+    /** `Daily` (default) returns the data in daily granularity, `Hourly` returns the data in hourly granularity. */
+    aggregationGranularity?: AggregationGranularity;
+    /** Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in. */
+    continuationToken?: string;
+}
+
+/** Contains response data for the listNext operation. */
+export declare type UsageAggregatesListNextResponse = UsageAggregationListResult;
+
+/** Optional parameters. */
+export declare interface UsageAggregatesListOptionalParams extends coreClient.OperationOptions {
+    /** `True` returns usage data in instance-level detail, `false` causes server-side aggregation with fewer details. For example, if you have 3 website instances, by default you will get 3 line items for website consumption. If you specify showDetails = false, the data will be aggregated as a single line item for website consumption within the time period (for the given subscriptionId, meterId, usageStartTime and usageEndTime). */
+    showDetails?: boolean;
+    /** `Daily` (default) returns the data in daily granularity, `Hourly` returns the data in hourly granularity. */
+    aggregationGranularity?: AggregationGranularity;
+    /** Used when a continuation token string is provided in the response body of the previous call, enabling paging through a large result set. If not present, the data is retrieved from the beginning of the day/hour (based on the granularity) passed in. */
+    continuationToken?: string;
+}
+
+/** Contains response data for the list operation. */
+export declare type UsageAggregatesListResponse = UsageAggregationListResult;
+
+/** Describes the usageAggregation. */
+export declare interface UsageAggregation {
+    /** Unique Id for the usage aggregate. */
+    id?: string;
+    /** Name of the usage aggregate. */
+    name?: string;
+    /** Type of the resource being returned. */
+    type?: string;
+    /** The subscription identifier for the Azure user. */
+    subscriptionId?: string;
+    /** Unique ID for the resource that was consumed (aka ResourceID). */
+    meterId?: string;
+    /** UTC start time for the usage bucket to which this usage aggregate belongs. */
+    usageStartTime?: Date;
+    /** UTC end time for the usage bucket to which this usage aggregate belongs. */
+    usageEndTime?: Date;
+    /** The amount of the resource consumption that occurred in this time frame. */
+    quantity?: number;
+    /** The unit in which the usage for this resource is being counted, e.g. Hours, GB. */
+    unit?: string;
+    /** Friendly name of the resource being consumed. */
+    meterName?: string;
+    /** Category of the consumed resource. */
+    meterCategory?: string;
+    /** Sub-category of the consumed resource. */
+    meterSubCategory?: string;
+    /** Region of the meterId used for billing purposes */
+    meterRegion?: string;
+    /** Key-value pairs of instance details (legacy format). */
+    infoFields?: InfoField;
+    /** Key-value pairs of instance details represented as a string. */
+    instanceData?: string;
+}
+
+/** The Get UsageAggregates operation response. */
+export declare interface UsageAggregationListResult {
+    /** Gets or sets details for the requested aggregation. */
+    value?: UsageAggregation[];
+    /** Gets or sets the link to the next set of results. */
+    nextLink?: string;
+}
+
+export declare class UsageManagementClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the UsageManagementClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId It uniquely identifies Microsoft Azure subscription. The subscription ID forms
+     *                       part of the URI for every service call.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: UsageManagementClientOptionalParams);
+    usageAggregates: UsageAggregates;
+    rateCard: RateCard;
+}
+
+/** Optional parameters. */
+export declare interface UsageManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+export { }

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.19.4"
+    }
+  ]
+}