---
title: "GET /providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}"
method: GET
path: "/providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}"
tags: ["ReservationOrderAliasResponses"]
---

# GET /providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}

`GET /providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}`

## Request

- Base URL: `https://management.azure.com`
- URL: `https://management.azure.com/providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}`
- Auth: OAuth 2
  - Implicit: `https://login.microsoftonline.com/common/oauth2/authorize`
  - Scopes: `user_impersonation`

Get a reservation order alias.

## Path parameters

- `reservationOrderAliasName` string, required

## Query parameters

- `api-version` string, required

## Response `200`

Azure operation completed successfully.

- ReservationOrderAliasResponse: Reservation order alias
  - `id` string, arm-id: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
  - `name` string: The name of the resource
  - `type` string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
  - `systemData` SystemData: Metadata pertaining to creation and last modification of the resource.
    - `createdBy` string: The identity that created the resource.
    - `createdByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key': The type of identity that created the resource.
    - `createdAt` string, date-time: The timestamp of resource creation (UTC).
    - `lastModifiedBy` string: The identity that last modified the resource.
    - `lastModifiedByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key': The type of identity that last modified the resource.
    - `lastModifiedAt` string, date-time: The timestamp of resource last modification (UTC)
  - `properties` ReservationOrderAliasResponseProperties: Reservation properties
    - `displayName` string: Display name
    - `reservationOrderId` string: Identifier of the reservation order created
    - `provisioningState` 'Creating' | 'PendingBilling' | 'ConfirmedBilling' | 'Created' | 'Succeeded' | 'Cancelled' | 'Expired' | 'Failed': Provisioning state
    - `billingScopeId` string: Subscription that will be charged for purchasing the benefit
    - `term` 'P1M' | 'P1Y' | 'P3Y' | 'P5Y': Represent benefit term in ISO 8601 format.
    - `billingPlan` 'P1M': Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
    - `appliedScopeType` 'Single' | 'Shared' | 'ManagementGroup': Type of the Applied Scope.
    - `appliedScopeProperties` AppliedScopeProperties: Properties specific to applied scope type. Not required if not applicable.
      - `tenantId` string: Tenant ID where the benefit is applied.
      - `managementGroupId` string: Fully-qualified identifier of the management group where the benefit must be applied.
      - `subscriptionId` string: Fully-qualified identifier of the subscription.
      - `resourceGroupId` string: Fully-qualified identifier of the resource group.
      - `displayName` string: Display name
      - `benefitFilter` string: A filter string passed to downstream services to categorize and apply usage benefits to specific resource models. Expected format: "key/value" (e.g., "contractId/2025 H2CPU"). The value is not validated by BillingBenefits and is forwarded as-is.
    - `quantity` integer: Total Quantity of the SKUs purchased in the Reservation.
    - `renew` boolean: Setting this to true will automatically purchase a new benefit on the expiration date time.
    - `renewAction` 'CreateNew' | 'RenewExisting': Represents the renewal action for a reservation to be a new purchase or existing renewal.
    - `renewalPurchaseDateTime` string, date-time: This is the date-time when the reservation was renewed.
    - `reservedResourceType` 'VirtualMachines' | 'SqlDatabases' | 'SuseLinux' | 'CosmosDb' | 'RedHat' | 'SqlDataWarehouse' | 'VMwareCloudSimple' | 'RedHatOsa' | 'Databricks' | 'AppService' | 'ManagedDisk' | 'BlockBlob' | 'RedisCache' | 'AzureDataExplorer' | 'MySql' | 'MariaDb' | 'PostgreSql' | 'DedicatedHost' | 'SapHana' | 'SqlAzureHybridBenefit' | 'AVS' | 'DataFactory' | 'NetAppStorage' | 'AzureFiles' | 'SqlEdge' | 'VirtualMachineSoftware': The type of the resource that is being reserved.
    - `reviewDateTime` string, date-time: This is the date-time when the Reservation needs to be reviewed.
    - `benefitStartTime` string, date-time: This is the DateTime when the reservation benefit started.
    - `reservedResourceProperties` ReservationOrderAliasResponsePropertiesReservedResourceProperties: Properties specific to each reserved resource type. Not required if not applicable.
      - `instanceFlexibility` 'On' | 'Off': Turning this on will apply the reservation discount to other VMs in the same VM size group.
  - `sku` ResourceSku, required
    - `name` string
  - `location` string: The Azure Region where the reserved resource lives.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-07-13** (2022-11-01) `524c785862c5`: 1 breaking
  - added the new required `query` request parameter `api-version`
- **2026-07-13** (2022-11-01) `a1c0ddb43231`: 1 warning, 2 info
  - deleted the `query` request parameter `api-version`
  - api tag `ReservationOrderAliasResponses` added
  - api tag `Reservation order aliases` removed
- **2026-07-13** (2022-11-01) `47d61aaf3262`: 1 breaking, 2 info
  - added the new required `query` request parameter `api-version`
  - api tag `Reservation order aliases` added
  - api tag `ReservationOrderAliasResponses` removed
- **2022-11-14** (2022-11-01) `2a40ceec2c00`: 1 breaking, 2 info
  - added the new required `query` request parameter `api-version`
  - api tag `Reservation order aliases` added
  - api tag `ReservationOrderAliasResponses` removed

[Operation history](https://skmtc.dev/azure/apis/billingbenefits-microsoft-billingbenefits/changes/providers/Microsoft.BillingBenefits/reservationOrderAliases/:reservationOrderAliasName/get.md)

---

[API](https://skmtc.dev/azure/apis/billingbenefits-microsoft-billingbenefits.md) - [All operations](https://skmtc.dev/azure/apis/billingbenefits-microsoft-billingbenefits/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/billingbenefits-microsoft-billingbenefits/revisions/524c785862c5?raw)
