@azure-tools/typespec-azure-resource-manager 0.71.0-dev.11 → 0.71.0-dev.12

package/lib/common-types/billing-data.tsp

@@ -0,0 +1,211 @@
+using Azure.Core;
+using Versioning;
+
+namespace Azure.ResourceManager.CommonTypes;
+
+/**
+ * Billing Data
+ */
+@added(Versions.v6)
+model BillingData {
+  /**
+   * The system ID of the resource. Globally unique per cloud.
+   */
+  @visibility(Lifecycle.Read)
+  systemId?: uuid;
+
+  /**
+   * Indicates the billing state of the resource.
+   */
+  @visibility(Lifecycle.Read)
+  state?: BillingState = BillingState.Pending;
+
+  /**
+   * Indicates reason(s) for the current billing state of the resource.
+   */
+  @visibility(Lifecycle.Read)
+  reasons?: BillingStateReason[];
+
+  /**
+   * The product identifier referencing a product in the catalog.
+   */
+  productCode: uuid;
+
+  /**
+   * Product token (JWT) identifying a specific version of the product.
+   */
+  @visibility(Lifecycle.Create, Lifecycle.Update)
+  productToken?: string;
+
+  /**
+   * The number of instances of the product.
+   */
+  quantity: int64 = 1;
+
+  /**
+   * Start date indicating the beginning of the term for which the resource is committed.
+   */
+  startDate?: utcDateTime;
+
+  /**
+   * End date indicating the end of the term for which the resource is committed.
+   */
+  endDate?: utcDateTime;
+
+  /**
+   * Billing token (JWT) representing additional billing context.
+   */
+  @visibility(Lifecycle.Create, Lifecycle.Update)
+  billingToken?: string;
+
+  /**
+   * The resource's billing schedule.
+   */
+  schedule?: BillingSchedule;
+}
+
+/**
+ * Billing schedule.
+ */
+@added(Versions.v6)
+model BillingSchedule {
+  /**
+   * Indicates the renewal behavior of this resource.
+   */
+  renewal: BillingRenewalType = BillingRenewalType.Automatic;
+
+  /**
+   * Schedules billing changes for this resource.
+   */
+  changes?: BillingScheduleChange[];
+}
+
+/**
+ * Billing schedule change.
+ */
+@added(Versions.v6)
+model BillingScheduleChange {
+  /**
+   * Indicates when the change is expected to become effective.
+   */
+  effective: BillingScheduleChangeEffectiveType = BillingScheduleChangeEffectiveType.Renewal;
+
+  /**
+   * The absolute date when the change is expected to become effective. Required when `effective` = `AbsoluteDate`.
+   */
+  effectiveDate?: utcDateTime;
+
+  /**
+   * The kind of change.
+   */
+  kind: BillingScheduleChangeKind = BillingScheduleChangeKind.Update;
+
+  /**
+   * The new product identifier. When not specified, the resource's product code remains unchanged.
+   */
+  productCode?: uuid;
+
+  /**
+   * Product token (JWT) identifying a specific version of the scheduled product. Can only be
+   * specified when productCode is specified also.
+   */
+  @visibility(Lifecycle.Create, Lifecycle.Update)
+  productToken?: string;
+
+  /**
+   * The new number of instances of the product. When not specified, the resource's quantity remains unchanged.
+   */
+  quantity?: int64;
+
+  /**
+   * The new (coterminous) end date of the product. Can only be specified when effective = renewal.
+   * When not specified, the resource's end date is calculated based on the renewal date and the
+   * product's term duration.
+   */
+  endDate?: utcDateTime;
+
+  /**
+   * Billing token (JWT) representing additional billing context.
+   */
+  @visibility(Lifecycle.Create, Lifecycle.Update)
+  billingToken?: string;
+}
+
+/**
+ * Billing state.
+ */
+@added(Versions.v6)
+union BillingState {
+  /** Resource's billing has not yet started. */
+  Pending: "Pending",
+
+  /** Resource's billing is activate. */
+  Active: "Active",
+
+  /** Resource's billing is in a warning state. */
+  Warned: "Warned",
+
+  /** Resource's billing is inactive. */
+  Inactive: "Inactive",
+
+  string,
+}
+
+/**
+ * Billing state reason.
+ */
+@added(Versions.v6)
+union BillingStateReason {
+  /** Resource's billing has been suspended by Microsoft. */
+  Suspended: "Suspended",
+
+  /** Resource has been canceled by the customer. */
+  Canceled: "Canceled",
+
+  /** Resource's billing has expired. */
+  Expired: "Expired",
+
+  string,
+}
+
+/**
+ * Type of renewal.
+ */
+@added(Versions.v6)
+union BillingRenewalType {
+  /** Automatically renew the product when its term ends. */
+  Automatic: "Automatic",
+
+  /** Don't automatically renew the product. */
+  None: "None",
+
+  string,
+}
+
+/**
+ * When a scheduled change is expected to become effective.
+ */
+@added(Versions.v6)
+union BillingScheduleChangeEffectiveType {
+  /** At a specified date. */
+  AbsoluteDate: "AbsoluteDate",
+
+  /** At time of term renewal. */
+  Renewal: "Renewal",
+
+  string,
+}
+
+/**
+ * Type of scheduled change.
+ */
+@added(Versions.v6)
+union BillingScheduleChangeKind {
+  /** Update the resource. */
+  Update: "Update",
+
+  /** Cancel the resource. */
+  Cancel: "Cancel",
+
+  string,
+}

package/lib/common-types/common-types.tsp

@@ -12,5 +12,5 @@ import "./versions.tsp";
 import "./mobo-ref.tsp";
 import "./network-security-perimeter-ref.tsp";
 import "./nsp-operations.tsp";
-
+import "./billing-data.tsp";
 namespace Azure.ResourceManager.CommonTypes;

package/lib/models.tsp

@@ -452,4 +452,21 @@ model AvailabilityZonesProperty {
   zones?: string[];
 }
 
+/**
+ * Standard resource billing data property to represent the resource's current billing state.
+ * Spread this model directly into your resource property model when modeling e.g. prepaid resources.
+ *
+ * @example
+ *
+ * ```typespec
+ * model FooProperties {
+ *   ...BillingDataProperty,
+ * }
+ * ```
+ */
+model BillingDataProperty {
+  /** The billing data of the resource. */
+  billingData: CommonTypes.BillingData;
+}
+
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.71.0-dev.11",
+  "version": "0.71.0-dev.12",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -48,8 +48,8 @@
   },
   "peerDependencies": {
     "@azure-tools/typespec-azure-core": "^0.70.0 || >= 0.71.0-dev.4",
-    "@typespec/compiler": "^1.14.0",
     "@typespec/http": "^1.14.0",
+    "@typespec/compiler": "^1.14.0",
     "@typespec/rest": "^0.84.0",
     "@typespec/openapi": "^1.14.0",
     "@typespec/versioning": "^0.84.0"
@@ -65,10 +65,10 @@
     "vitest": "^4.1.3",
     "@typespec/compiler": "^1.14.0",
     "@typespec/library-linter": "^0.84.0",
-    "@typespec/http": "^1.14.0",
-    "@typespec/versioning": "^0.84.0",
     "@typespec/rest": "^0.84.0",
+    "@typespec/versioning": "^0.84.0",
     "@typespec/tspd": "^0.76.0",
+    "@typespec/http": "^1.14.0",
     "@typespec/openapi": "^1.14.0"
   },
   "scripts": {