Skip to main content

API Reference

CMS API API Reference

Version: v1

Cloud Management Service

Authentication

All endpoints require a Bearer token in the Authorization header unless otherwise noted. Example: Authorization: Bearer <token>

Alerts

GET /api/v1/alerts

Responses

  • 200: OK

POST /api/v1/alerts

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/alerts

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/alerts/area/{area}

Parameters

  • area (path, required) • type: string Responses
  • 200: OK

GET /api/v1/alerts/related/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

DELETE /api/v1/alerts/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/alerts/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Auth

POST /api/v1/auth/activate/code

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/auth/activate/{code}

Parameters

  • code (path, required) • type: string Responses
  • 200: OK

POST /api/v1/auth/password-change

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/auth/password-reset

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/auth/status

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/auth/token

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/auth/token-refresh

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

Billing

GET /api/v1/billing

Responses

  • 200: OK

GET /api/v1/billing/chart

Parameters

  • period (query, optional) • type: string • default: monthly Responses
  • 200: OK

GET /api/v1/billing/chart/{relatedId}

Parameters

  • relatedId (path, required) • type: string • format: uuid
  • period (query, optional) • type: string • default: monthly Responses
  • 200: OK

GET /api/v1/billing/currentmonth

Responses

  • 200: OK

GET /api/v1/billing/generate/{yearmonth}

Parameters

  • yearmonth (path, required) • type: string Responses
  • 200: OK

GET /api/v1/billing/metersummary/{period}

Parameters

  • period (path, required) • type: string Responses
  • 200: OK

GET /api/v1/billing/previousmonth

Responses

  • 200: OK

GET /api/v1/billing/summary

Responses

  • 200: OK

GET /api/v1/billing/summary/{period}

Parameters

  • period (path, required) • type: string Responses
  • 200: OK

GET /api/v1/billing/yearmonth/{yearmonth}

Parameters

  • yearmonth (path, required) • type: string Responses
  • 200: OK

CommissionChart

PUT /api/v1/commissions

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/commissions/calculate

Responses

  • 200: OK

GET /api/v1/commissions/calculate/related

Parameters

  • relatedId (query, optional) • type: string • format: uuid
  • relatedType (query, optional) • type: string Responses
  • 200: OK

GET /api/v1/commissions/chart/{relatedId}

Parameters

  • relatedId (path, required) • type: string • format: uuid
  • period (query, optional) • type: string • default: monthly Responses
  • 200: OK

GET /api/v1/commissions/summary/{period}

Parameters

  • period (path, required) • type: string Responses
  • 200: OK

CommissionRates

POST /api/v1/commissionrates

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/commissionrates

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

DELETE /api/v1/commissionrates/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/commissionrates/{relatedId}

Parameters

  • relatedId (path, required) • type: string • format: uuid Responses
  • 200: OK

Costs

GET /api/v1/costs

Responses

  • 200: OK

POST /api/v1/costs

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/costs

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/costs/related/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

DELETE /api/v1/costs/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/costs/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Currencies

GET /api/v1/currencies

Responses

  • 200: OK

PUT /api/v1/currencies

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/currencies/code/{code}

Parameters

  • code (path, required) • type: string Responses
  • 200: OK

GET /api/v1/currencies/rates/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/currencies/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Distributors

GET /api/v1/distributors

Responses

  • 200: OK

POST /api/v1/distributors

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/distributors

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/distributors/summary

Responses

  • 200: OK

DELETE /api/v1/distributors/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/distributors/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Invoices

GET /api/v1/invoices

Responses

  • 200: OK

POST /api/v1/invoices

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/invoices

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/invoices/emailtenant

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/invoices/generate/{period}

Parameters

  • period (path, required) • type: string Responses
  • 200: OK

GET /api/v1/invoices/period/{period}

Parameters

  • period (path, required) • type: string Responses
  • 200: OK

GET /api/v1/invoices/tenant/{tenantId}

Parameters

  • tenantId (path, required) • type: string • format: uuid Responses
  • 200: OK

DELETE /api/v1/invoices/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/invoices/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Jobs

GET /api/v1/jobs

Responses

  • 200: OK

POST /api/v1/jobs

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/jobs

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/jobs/range

Parameters

  • startdate (query, optional) • type: string
  • enddate (query, optional) • type: string Responses
  • 200: OK

GET /api/v1/jobs/today

Parameters

  • period (query, optional) • type: string Responses
  • 200: OK

DELETE /api/v1/jobs/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/jobs/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Meters

GET /api/v1/meters

Responses

  • 200: OK

POST /api/v1/meters

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/meters

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/meters/meterid/{id}

Parameters

  • id (path, required) • type: string Responses
  • 200: OK

GET /api/v1/meters/summary

Responses

  • 200: OK

DELETE /api/v1/meters/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/meters/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Partners

GET /api/v1/partners

Responses

  • 200: OK

POST /api/v1/partners

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/partners

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/partners/performance

Parameters

  • yearmonth (query, optional) • type: string Responses
  • 200: OK

GET /api/v1/partners/summary

Responses

  • 200: OK

DELETE /api/v1/partners/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/partners/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Pricing

GET /api/v1/pricing

Responses

  • 200: OK

POST /api/v1/pricing

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/pricing

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/pricing/azure/{currencycode}

Parameters

  • currencycode (path, required) • type: string Responses
  • 200: OK

POST /api/v1/pricing/clone

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/pricing/createall

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/pricing/deleteall

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

POST /api/v1/pricing/increase

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/pricing/region/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/pricing/summary

Responses

  • 200: OK

DELETE /api/v1/pricing/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/pricing/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

PricingThresholds

GET /api/v1/pricingthresholds

Responses

  • 200: OK

POST /api/v1/pricingthresholds

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/pricingthresholds

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/pricingthresholds/pricing/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

DELETE /api/v1/pricingthresholds/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/pricingthresholds/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Regions

GET /api/v1/regions

Responses

  • 200: OK

POST /api/v1/regions

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/regions

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/regions/identityhealth/{regionid}

Parameters

  • regionid (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/regions/licenses

Responses

  • 200: OK

GET /api/v1/regions/platform/{platform}/vmsizes/{regionid}

Parameters

  • platform (path, required) • type: #/components/schemas/PlatformTypes
  • regionid (path, required) • type: string • format: uuid Responses
  • 200: OK

PUT /api/v1/regions/regionhealth

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/regions/regionhealth/{regionid}

Parameters

  • regionid (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/regions/summary

Responses

  • 200: OK

GET /api/v1/regions/updateusage

Responses

  • 200: OK

PUT /api/v1/regions/updateusage

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

DELETE /api/v1/regions/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/regions/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Settings

GET /api/v1/settings

Responses

  • 200: OK

PUT /api/v1/settings

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/settings/category/{category}

Parameters

  • category (path, required) • type: string Responses
  • 200: OK

GET /api/v1/settings/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Sku

GET /api/v1/skus

Responses

  • 200: OK

POST /api/v1/skus

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/skus

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/skus/platform/{platform}/{regionid}

Parameters

  • platform (path, required) • type: string
  • regionid (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/skus/sku/{skuid}

Parameters

  • skuid (path, required) • type: string Responses
  • 200: OK

DELETE /api/v1/skus/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/skus/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/skus/{platform}/{regionid}/sync

Parameters

  • platform (path, required) • type: #/components/schemas/PlatformTypes
  • regionid (path, required) • type: string • format: uuid Responses
  • 200: OK

Subscriptions

GET /api/v1/subscriptions

Responses

  • 200: OK

POST /api/v1/subscriptions

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/subscriptions

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/subscriptions/summary

Responses

  • 200: OK

GET /api/v1/subscriptions/tenant/{tenantId}

Parameters

  • tenantId (path, required) • type: string • format: uuid Responses
  • 200: OK

PUT /api/v1/subscriptions/updateusage

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

DELETE /api/v1/subscriptions/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/subscriptions/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Tenants

GET /api/v1/tenants

Responses

  • 200: OK

POST /api/v1/tenants

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/tenants

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/tenants/performance

Parameters

  • yearmonth (query, optional) • type: string Responses
  • 200: OK

GET /api/v1/tenants/summary

Responses

  • 200: OK

PUT /api/v1/tenants/updateinvoices

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

DELETE /api/v1/tenants/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/tenants/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Usage

GET /api/v1/usage

Responses

  • 200: OK

POST /api/v1/usage

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/usage

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/usage/hash/{usagehash}

Parameters

  • usagehash (path, required) • type: string Responses
  • 200: OK

GET /api/v1/usage/resources/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/usage/subscription/{subscriptionId}/range

Parameters

  • subscriptionId (path, required) • type: string • format: uuid
  • start (query, optional) • type: string • format: date-time
  • end (query, optional) • type: string • format: date-time Responses
  • 200: OK

GET /api/v1/usage/update/{period}

Parameters

  • period (path, required) • type: string Responses
  • 200: OK

DELETE /api/v1/usage/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/usage/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Users

GET /api/v1/users

Responses

  • 200: OK

POST /api/v1/users

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

PUT /api/v1/users

Request Body

  • Supported Content Types: application/json, text/json, application/*+json Responses
  • 200: OK

GET /api/v1/users/activation-reset/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/users/summary

Responses

  • 200: OK

GET /api/v1/users/welcome/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

DELETE /api/v1/users/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

GET /api/v1/users/{id}

Parameters

  • id (path, required) • type: string • format: uuid Responses
  • 200: OK

Schemas

AlertAreaTypes

  • type: string

AlertEntity

  • type: object Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • Type: #/components/schemas/AlertTypes
  • Status: #/components/schemas/AlertStatusTypes
  • Area: #/components/schemas/AlertAreaTypes
  • Closed: boolean
  • Title: string (nullable)
  • Message: string (nullable)
  • RelatedType: #/components/schemas/AlertRelatedTypes
  • RelatedId: string (uuid)

AlertRelatedTypes

  • type: string

AlertStatusTypes

  • type: string

AlertTypes

  • type: string

AuthRequest

  • type: object
  • required: EmailAddress, Password Properties
  • EmailAddress: string (email)
  • Password: string
  • MFACode: string (nullable)
  • FederatedAuthToken: string (nullable)
  • AuthType: #/components/schemas/FederatedAuthTypes

AzureStackCategoryTypes

  • type: string

ClonePricingRequest

  • type: object
  • required: DestinationId, PlatformType, RelatedType, SourceId Properties
  • SourceId: string (uuid)
  • DestinationId: string (uuid)
  • RelatedType: #/components/schemas/PricingRelatedTypes
  • PlatformType: #/components/schemas/PlatformTypes
  • SourceDisplayName: string (nullable)

CommissionEntity

  • type: object Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • RelatedId: string (uuid)
  • RelatedType: #/components/schemas/CommissionRatesRelatedTypes
  • Rate: number (double)
  • TotalConsumption: number (double)
  • TotalCommission: number (double)
  • PaidOut: boolean
  • Period: string (nullable)

CommissionRateEntity

  • type: object Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • FromAmmount: number (double)
  • ToAmmount: number (double)
  • Percentage: number (double)
  • RelatedId: string (uuid)
  • RelatedType: #/components/schemas/CommissionRatesRelatedTypes

CommissionRatesRelatedTypes

  • type: string

CostCategoryTypes

  • type: string

CostEntity

  • type: object Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string (nullable)
  • Category: #/components/schemas/CostCategoryTypes
  • RelatedId: string (uuid)
  • RelatedType: #/components/schemas/CostRelatedTypes
  • Cost: number (double)

CostRelatedTypes

  • type: string

CountryTypes

  • type: string

CreatePricingRequest

  • type: object
  • required: Platform, PricingType, RelatedId, RelatedType Properties
  • RelatedId: string (uuid)
  • RelatedType: #/components/schemas/PricingRelatedTypes
  • Platform: #/components/schemas/PlatformTypes
  • PricingType: #/components/schemas/PricingTypes

CurrencyEntity

  • type: object
  • required: Code, Country, DisplayName, Name, Number Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string
  • Name: string
  • Code: string
  • Number: integer (int32)
  • Country: string
  • ExchangeRate: number (double)
  • IsBaseCurrency: boolean

DeletePricingRequest

  • type: object
  • required: RelatedId Properties
  • RelatedId: string (uuid)
  • PricingType: #/components/schemas/PricingTypes

DistributorEntity

  • type: object
  • required: DisplayName Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string
  • PrimaryContactName: string (nullable)
  • PrimaryContactEmailAddress: string (nullable)
  • PrimaryContactPhoneNumber: string (nullable)
  • BillingContactName: string (nullable)
  • BillingContactEmailAddress: string (nullable)
  • BillingContactPhoneNumber: string (nullable)
  • BillingAddress: string (nullable)
  • BillingCity: string (nullable)
  • BillingState: string (nullable)
  • BillingCountry: #/components/schemas/CountryTypes
  • BillingPostcode: string (nullable)
  • SupportContactName: string (nullable)
  • SupportContactEmailAddress: string (nullable)
  • SupportContactPhoneNumber: string (nullable)
  • CurrencyId: string (uuid)

FederatedAuthTypes

  • type: string

IncreasePricingRequest

  • type: object
  • required: IncreaseAmount, IncreaseType, RelatedId, RelatedType Properties
  • IncreaseType: #/components/schemas/PriceIncreaseTypes
  • IncreaseAmount: number (double)
  • RelatedId: string (uuid)
  • RelatedType: #/components/schemas/PricingRelatedTypes

InvoiceEntity

  • type: object
  • required: TenantId Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • InvoiceNumber: integer (int32)
  • InvoiceName: string (nullable)
  • Period: string (nullable)
  • DueDate: string (date-time)
  • TenantName: string (nullable)
  • TenantId: string (uuid)
  • Status: #/components/schemas/InvoiceStatusTypes
  • Content: string (byte) (nullable)
  • TotalValueIncludingTax: number (double)
  • CurrencyId: string (uuid)
  • EmailSent: boolean

InvoiceStatusTypes

  • type: string

JobEntity

  • type: object Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • Type: #/components/schemas/JobTypes
  • Status: #/components/schemas/JobStatusTypes
  • Updated: string (date-time)
  • Started: string (date-time)
  • Ended: string (date-time)
  • TotalSteps: integer (int32)
  • CurrentStep: integer (int32)
  • History: string (nullable)
  • RelatedId: string (uuid)
  • RerunIfFailed: boolean
  • FailedRerunCount: integer (int32)

JobStatusTypes

  • type: string

JobTypes

  • type: string

MeterCreditTypes

  • type: string

MeterEntity

  • type: object
  • required: DisplayName, MeterId Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • MeterId: string
  • DisplayName: string
  • Offer: string (nullable)
  • Platform: #/components/schemas/PlatformTypes
  • Category: #/components/schemas/AzureStackCategoryTypes
  • Unit: string (nullable)
  • Deprecated: boolean
  • Custom: boolean
  • Billable: boolean
  • SystemOnly: boolean
  • PlatformCost: number (double)
  • PlatformCostDescription: string (nullable)
  • PlatformCostCurrencyId: string (uuid)
  • CategoryDescription: string (nullable)
  • RateBasis: #/components/schemas/MeterRateBasisTypes

MeterRateBasisTypes

  • type: string

OperatingSystemTypes

  • type: string

PartnerEntity

  • type: object
  • required: DisplayName Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string
  • DistributorId: string (uuid)
  • PrimaryContactName: string (nullable)
  • PrimaryContactEmailAddress: string (nullable)
  • PrimaryContactPhoneNumber: string (nullable)
  • BillingContactName: string (nullable)
  • BillingContactEmailAddress: string (nullable)
  • BillingContactPhoneNumber: string (nullable)
  • BillingAddress: string (nullable)
  • BillingCity: string (nullable)
  • BillingState: string (nullable)
  • BillingCountry: #/components/schemas/CountryTypes
  • BillingPostcode: string (nullable)
  • SupportContactName: string (nullable)
  • SupportContactEmailAddress: string (nullable)
  • SupportContactPhoneNumber: string (nullable)
  • CurrencyId: string (uuid)

PasswordChangeRequest

  • type: object
  • required: EmailAddress, ExistingPassword, Password Properties
  • EmailAddress: string (email)
  • ExistingPassword: string
  • Password: string

PasswordResetRequest

  • type: object
  • required: EmailAddress, Password, PasswordResetRequired Properties
  • EmailAddress: string (email)
  • Password: string
  • PasswordResetRequired: boolean

PlatformTypes

  • type: string

PriceIncreaseTypes

  • type: string

PricingEntity

  • type: object
  • required: DisplayName, MeterId Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • PricingType: #/components/schemas/PricingTypes
  • DisplayName: string
  • RelatedId: string (uuid)
  • MeterId: string
  • SkuId: string (nullable)
  • Offer: string (nullable)
  • Rate: number (double)
  • Costs: number (double)
  • Credits: number (double)
  • Platform: #/components/schemas/PlatformTypes
  • RelatedType: #/components/schemas/PricingRelatedTypes
  • MeterCreditType: #/components/schemas/MeterCreditTypes
  • PricingThresholdScope: #/components/schemas/PricingThresholdScopeTypes
  • History: string (nullable)
  • UsesTiers: boolean

PricingRelatedTypes

  • type: string

PricingThresholdEntity

  • type: object Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • PricingId: string (uuid)
  • FromQuantity: number (double)
  • ToQuantity: number (double)
  • Rate: number (double)

PricingThresholdScopeTypes

  • type: string

PricingTypes

  • type: string

RefreshTokenRequest

  • type: object
  • required: RefreshToken Properties
  • RefreshToken: string

RegionEntity

  • type: object
  • required: DisplayName Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string
  • CurrencyId: string (uuid)
  • TaxRate: number (double)
  • Region: string (nullable)
  • DomainName: string (nullable)
  • RegistrationResourceGroup: string (nullable)
  • OffersResourceGroup: string (nullable)
  • BasePlan: string (nullable)
  • AuthThumbprint: string (nullable)
  • AuthCertPassword: string (nullable)
  • EntraAppId: string (uuid)
  • EntraTenantId: string (nullable)
  • HealthStatus: #/components/schemas/RegionHealthStatusTypes
  • UsedMemory: integer (int32)
  • AvailableMemory: integer (int32)
  • TotalMemory: integer (int32)
  • UsedCPUCores: integer (int32)
  • AvailableCPUCores: integer (int32)
  • TotalCPUCores: integer (int32)
  • UsedStorage: integer (int32)
  • AvailableStorage: integer (int32)
  • TotalStorage: integer (int32)
  • UsedPublicIPAddresses: integer (int32)
  • AvailablePublicIPAddresses: integer (int32)
  • TotalPublicIPAddresses: integer (int32)
  • UsedGPU: integer (int32)
  • AvailableGPU: integer (int32)
  • TotalGPU: integer (int32)

RegionHealthStatusTypes

  • type: string

RoleTypes

  • type: string

SettingCategoryTypes

  • type: string

SettingControlTypes

  • type: string

SettingEntity

  • type: object Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string (nullable)
  • Setting: string (nullable)
  • Value: string (nullable)
  • Category: #/components/schemas/SettingCategoryTypes
  • DataType: string (nullable)
  • Control: #/components/schemas/SettingControlTypes

SkuEntity

  • type: object
  • required: DisplayName, Family, SKU Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • RegionId: string (uuid)
  • Platform: #/components/schemas/PlatformTypes
  • OperatingSystem: #/components/schemas/OperatingSystemTypes
  • DisplayName: string
  • Family: string
  • SKU: string
  • CPUs: integer (int32)
  • vCPUs: integer (int32)
  • MemoryGB: number (double)
  • vMemoryGB: number (double)
  • GPUs: integer (int32)
  • vGPUs: integer (int32)
  • AutoManaged: boolean
  • FamilyDescription: string (nullable)

StatusTypes

  • type: string

SubscriptionEntity

  • type: object
  • required: DisplayName, EntraTenantId, Owner Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string
  • AzsSubscriptionId: string (uuid)
  • TenantId: string (uuid)
  • RegionId: string (uuid)
  • CurrencyId: string (uuid)
  • EntraTenantId: string
  • Owner: string
  • Status: #/components/schemas/StatusTypes
  • Type: #/components/schemas/SubscriptionTypes
  • Platform: #/components/schemas/PlatformTypes
  • LastUsageCollection: string (date-time)
  • IdentityHealthStatus: string (nullable)
  • Budget: number (double)

SubscriptionTypes

  • type: string

TenantEntity

  • type: object
  • required: BillingAddress, BillingCity, BillingContactEmailAddress, BillingContactName, BillingContactPhoneNumber, BillingPostcode, BillingState, DisplayName Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • DisplayName: string
  • PartnerId: string (uuid)
  • PrimaryContactName: string (nullable)
  • PrimaryContactEmailAddress: string (nullable)
  • PrimaryContactPhoneNumber: string (nullable)
  • BillingContactName: string
  • BillingContactEmailAddress: string (email)
  • BillingContactPhoneNumber: string
  • BillingAddress: string
  • BillingCity: string
  • BillingState: string
  • BillingCountry: #/components/schemas/CountryTypes
  • BillingPostcode: string
  • SupportContactName: string (nullable)
  • SupportContactEmailAddress: string (nullable)
  • SupportContactPhoneNumber: string (nullable)
  • PaymentTermDays: integer (int32)
  • CurrencyId: string (uuid)
  • Budget: number (double)
  • Discount: number (double)
  • InternalReference: string (nullable)

UsageEntity

  • type: object
  • required: Location, MeterId, Name, Quantity, ResourceId, ResourceName, ResourceType, UsageEndTime, UsageHash, UsageStartTime Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • UsageHash: string
  • MeterId: string
  • RegionId: string (uuid)
  • SubscriptionId: string (uuid)
  • Name: string
  • Quantity: number (double)
  • AzsSubscriptionId: string (uuid)
  • UsageStartTime: string (date-time)
  • UsageEndTime: string (date-time)
  • Location: string
  • ResourceId: string
  • ResourceType: string
  • ResourceName: string
  • ResourceGroup: string (nullable)
  • ProviderName: string (nullable)
  • ProviderService: string (nullable)
  • ServiceType: string (nullable)
  • ImageType: string (nullable)
  • ImagePublisher: string (nullable)
  • ImageOffer: string (nullable)
  • ImageSku: string (nullable)
  • Tags: string (nullable)
  • Billed: boolean

UserEntity

  • type: object
  • required: EmailAddress, FirstName, LastName Properties
  • Id: string (uuid)
  • Description: string (nullable)
  • CreatedAt: string (date-time)
  • FirstName: string
  • LastName: string
  • FullName: string (nullable)
  • EmailAddress: string (email)
  • PhoneNumber: string (nullable)
  • LocaleCode: string (nullable)
  • CurrencyCode: string (nullable)
  • RelatedId: string (uuid)
  • RoleType: #/components/schemas/RoleTypes
  • MFARequired: boolean
  • MFARegistered: boolean
  • EmailConfirmed: boolean
  • Disabled: boolean
  • LockedOut: boolean
  • BadLoginCount: integer (int32)
  • LockoutDate: string (date-time)
  • LoginIP: string (nullable)
  • ChangePassword: boolean
  • PasswordLastChanged: string (date-time)
  • LastLogon: string (date-time)
  • FederatedOnly: boolean
Back to top