Savings Plans - Get By Billing Account

Служба:: Billing

Версия API:: 2024-04-01

Получение плана экономии по счету выставления счетов.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2024-04-01

С использованием необязательных параметров:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}?api-version=2024-04-01&expand={expand}

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountName	path	True	string pattern: ^([0-9]+\|([Pp][Cc][Nn]\.[A-Za-z0-9]+)\|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	Идентификатор, который однозначно идентифицирует учетную запись выставления счетов.
savingsPlanId	path	True	string	Идентификатор плана экономии
savingsPlanOrderId	path	True	string	Идентификатор заказа плана экономии
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
expand	query		string	Может использоваться для расширения planInformation.

Ответы

Имя	Тип	Описание
200 OK	SavingsPlanModel	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

SavingsPlanGet

SavingsPlanGetExpandRenewProperties

SavingsPlanGet

Образец запроса

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2024-04-01

Пример ответа

Код состояния:: 200

{
  "name": "30000000-0000-0000-0000-000000000000",
  "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "properties": {
    "appliedScopeProperties": {
      "displayName": "TestRg",
      "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
      "tenantId": "70000000-0000-0000-0000-000000000000"
    },
    "appliedScopeType": "ManagementGroup",
    "benefitStartTime": "2022-11-16T02:25:11.7183866Z",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
    "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000",
    "commitment": {
      "amount": 0.001,
      "currencyCode": "USD",
      "grain": "Hourly"
    },
    "displayName": "SP1",
    "displayProvisioningState": "NoBenefit",
    "effectiveDateTime": "2022-12-16T01:35:36.2909462Z",
    "expiryDateTime": "2025-11-16T02:25:11.7183866Z",
    "productCode": "20000000-0000-0000-0000-000000000005",
    "provisioningState": "Succeeded",
    "purchaseDateTime": "2022-11-16T02:23:21.3864783Z",
    "renew": false,
    "term": "P3Y",
    "userFriendlyAppliedScopeType": "ManagementGroup",
    "utilization": {
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        }
      ],
      "trend": "SAME"
    }
  },
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

SavingsPlanGetExpandRenewProperties

Образец запроса

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000?api-version=2024-04-01

Пример ответа

Код состояния:: 200

{
  "name": "30000000-0000-0000-0000-000000000000",
  "type": "microsoft.billing/billingAccounts/savingsPlanOrders/savingsPlans",
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/savingsPlanOrders/20000000-0000-0000-0000-000000000000/savingsPlans/30000000-0000-0000-0000-000000000000",
  "properties": {
    "appliedScopeProperties": {
      "displayName": "TestRg",
      "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
      "tenantId": "70000000-0000-0000-0000-000000000000"
    },
    "appliedScopeType": "ManagementGroup",
    "benefitStartTime": "2022-11-16T02:25:11.7183866Z",
    "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    "billingPlan": "P1M",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/AAAA-BBBB-CCC-DDD",
    "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000",
    "commitment": {
      "amount": 0.001,
      "currencyCode": "USD",
      "grain": "Hourly"
    },
    "displayName": "SP1",
    "displayProvisioningState": "NoBenefit",
    "effectiveDateTime": "2022-12-16T01:35:36.2909462Z",
    "expiryDateTime": "2025-11-16T02:25:11.7183866Z",
    "productCode": "20000000-0000-0000-0000-000000000005",
    "provisioningState": "Succeeded",
    "purchaseDateTime": "2022-11-16T02:23:21.3864783Z",
    "renew": false,
    "renewProperties": {
      "purchaseProperties": {
        "properties": {
          "appliedScopeProperties": {
            "managementGroupId": "/providers/Microsoft.Management/managementGroups/TestRg",
            "tenantId": "70000000-0000-0000-0000-000000000000"
          },
          "appliedScopeType": "ManagementGroup",
          "billingPlan": "Monthly",
          "billingScopeId": "/subscriptions/50000000-0000-0000-0000-000000000000",
          "commitment": {
            "amount": 0.001,
            "currencyCode": "USD",
            "grain": "Hourly"
          },
          "displayName": "SP1_renewed",
          "term": "P3Y"
        },
        "sku": {
          "name": "Compute_Savings_Plan"
        }
      }
    },
    "term": "P3Y",
    "userFriendlyAppliedScopeType": "ManagementGroup",
    "utilization": {
      "aggregates": [
        {
          "grain": 1,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 7,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        },
        {
          "grain": 30,
          "grainUnit": "days",
          "value": 0,
          "valueUnit": "percentage"
        }
      ],
      "trend": "SAME"
    }
  },
  "sku": {
    "name": "Compute_Savings_Plan"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  }
}

Определения

Имя	Описание
AppliedScopeProperties	Свойства, относящиеся к примененным типу области. Не требуется, если применимо.
AppliedScopeType	Тип примененной области.
BillingPlan	Представляет план выставления счетов в формате ISO 8601. Требуется только для ежемесячных покупок.
Commitment	Приверженность преимуществам.
CommitmentGrain	Зерно обязательств.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ExtendedStatusInfo	Сведения о расширенном состоянии
ProvisioningState	Состояние снабжения ресурса во время длительной операции.
PurchaseRequest	Запрос на покупку.
RenewProperties	Свойства, относящиеся к продлению.
SavingsPlanModel	План экономии
SavingsPlanTerm	Представляет термин плана экономии в формате ISO 8601.
Sku	Номер SKU для этого ресурса
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Utilization	Использование плана экономии
UtilizationAggregates	Агрегированные значения использования плана экономии

AppliedScopeProperties

Объект

Свойства, относящиеся к примененным типу области. Не требуется, если применимо.

Имя	Тип	Описание
displayName	string	Отображаемое имя
managementGroupId	string	Полный идентификатор группы управления, в которой применяется преимущество.
resourceGroupId	string	Полный идентификатор группы ресурсов, в которой применяется преимущество.
subscriptionId	string	Полный идентификатор подписки, в которой применяется преимущество.
tenantId	string	Идентификатор клиента, в котором применяется план экономии, в котором применяется преимущество.

AppliedScopeType

Перечисление

Тип примененной области.

Значение	Описание
Single	Single
Shared	Общее
ManagementGroup	ManagementGroup

BillingPlan

Перечисление

Представляет план выставления счетов в формате ISO 8601. Требуется только для ежемесячных покупок.

Значение	Описание
P1M	P1M

Commitment

Объект

Приверженность преимуществам.

Имя	Тип	Описание
amount	number (double)
currencyCode	string	Код валюты ISO 4217 3-буквы для валюты, используемой этой записью покупки.
grain	CommitmentGrain	Зерно обязательств.

CommitmentGrain

Перечисление

Зерно обязательств.

Значение	Описание
Hourly	Ежечасный

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExtendedStatusInfo

Объект

Сведения о расширенном состоянии

Имя	Тип	Описание
message	string	В сообщении содержатся подробные сведения о коде состояния.
properties.subscriptionId	string	Подписка, которая завершилась сбоем проверки кредитной строки.
statusCode	string	Код состояния, предоставляющий дополнительные сведения.

ProvisioningState

Перечисление

Состояние снабжения ресурса во время длительной операции.

Значение	Описание
Succeeded	Succeeded
Canceled	Отменено
Failed	Неудача
New	Новое
Pending	В ожидании
Provisioning	Provisioning
PendingBilling	Ожидается выставление счетов
ConfirmedBilling	ПодтвержденоВыставление счетов
Creating	Создавать
Created	Создано
Expired	Срок действия истек

PurchaseRequest

Объект

Запрос на покупку.

Имя	Тип	Default value	Описание
properties.appliedScopeProperties	AppliedScopeProperties		Свойства, относящиеся к примененным типу области. Не требуется, если применимо.
properties.appliedScopeType	AppliedScopeType		Тип примененной области.
properties.billingPlan	BillingPlan		Представляет план выставления счетов в формате ISO 8601. Требуется только для ежемесячных покупок.
properties.billingScopeId	string		Подписка, которая будет взиматься за покупку SavingsPlan
properties.commitment	Commitment		Приверженность преимуществам.
properties.displayName	string		Понятное имя плана экономии
properties.renew	boolean	False	Если задано значение true, вы автоматически приобретете новое преимущество в течение даты окончания срока действия.
properties.term	SavingsPlanTerm		Представляет термин плана экономии в формате ISO 8601.
sku	Sku		Номер SKU для этого ресурса

RenewProperties

Объект

Свойства, относящиеся к продлению.

Имя	Тип	Описание
purchaseProperties	PurchaseRequest	Запрос на покупку.

SavingsPlanModel

Объект

План экономии

Имя	Тип	Default value	Описание
id	string (arm-id)		Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Имя ресурса
properties.appliedScopeProperties	AppliedScopeProperties		Свойства, относящиеся к примененным типу области. Не требуется, если применимо.
properties.appliedScopeType	AppliedScopeType		Тип примененной области.
properties.benefitStartTime	string (date-time)		Это dateTime, когда начинается преимущество плана экономии.
properties.billingAccountId	string		Полный идентификатор учетной записи выставления счетов, в которой применяется план экономии.
properties.billingPlan	BillingPlan		Представляет план выставления счетов в формате ISO 8601. Требуется только для ежемесячных покупок.
properties.billingProfileId	string		Полный идентификатор профиля выставления счетов, в котором применяется план экономии. Присутствует только для клиентов, управляемых по полю или на основе клиентов.
properties.billingScopeId	string		Подписка, которая будет взиматься за покупку SavingsPlan
properties.commitment	Commitment		Приверженность преимуществам.
properties.customerId	string		Полный идентификатор клиента, в котором применяется план экономии. Присутствует только для клиентов, управляемых партнером.
properties.displayName	string		Отображаемое имя
properties.displayProvisioningState	string		Состояние подготовки плана экономии для отображения, например успешное выполнение
properties.effectiveDateTime	string (date-time)		DateTime плана экономии, начиная с этой версии.
properties.expiryDateTime	string (date-time)		Это время даты, когда срок действия плана экономии истекает.
properties.extendedStatusInfo	ExtendedStatusInfo		Сведения о расширенном состоянии
properties.productCode	string		Представляет имя участника-участника-участника
properties.provisioningState	ProvisioningState		Состояние снабжения ресурса во время длительной операции.
properties.purchaseDateTime	string (date-time)		Дата приобретения плана экономии.
properties.renew	boolean	False	Если задано значение true, вы автоматически приобретете новое преимущество в течение даты окончания срока действия.
properties.renewDestination	string		Идентификатор сберегательного плана для приобретения из-за продления.
properties.renewProperties	RenewProperties		Свойства, относящиеся к продлению.
properties.renewSource	string		Идентификатор сберегательного плана, из которого обновляется этот план экономии.
properties.term	SavingsPlanTerm		Представляет термин плана экономии в формате ISO 8601.
properties.userFriendlyAppliedScopeType	string		Примененный тип области плана экономии для отображения, например "Общий".
properties.utilization	Utilization		Использование плана экономии
sku	Sku		Номер SKU плана экономии
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Словарь метаданных, связанных с ресурсом. Он не может быть заполнен для всех типов ресурсов. Максимальная длина ключа и значения, поддерживаемая 256 символами. Ключи или значение не должны пустыми значениями и значениями NULL. Ключи не могут содержать <> % & \ ? /
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SavingsPlanTerm

Перечисление

Представляет термин плана экономии в формате ISO 8601.

Значение	Описание
P1Y	P1Y
P3Y	P3Y
P5Y	P5Y

Sku

Объект

Номер SKU для этого ресурса

Имя	Тип	Описание
name	string	Имя применяемого номера SKU

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Utilization

Объект

Использование плана экономии

Имя	Тип	Описание
aggregates	UtilizationAggregates[]	Массив статистических выражений использования плана экономии
trend	string	Тенденция использования плана экономии

UtilizationAggregates

Объект

Агрегированные значения использования плана экономии

Имя	Тип	Описание
grain	number (float)	Зерно агрегата
grainUnit	string	Единица зерна агрегата
value	number (float)	Агрегированное значение
valueUnit	string	Единица агрегированного значения

Поделиться через

Savings Plans - Get By Billing Account

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

SavingsPlanGet

Образец запроса

Пример ответа

SavingsPlanGetExpandRenewProperties

Образец запроса

Пример ответа

Определения

AppliedScopeProperties

AppliedScopeType

BillingPlan

Commitment

CommitmentGrain

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedStatusInfo

ProvisioningState

PurchaseRequest

RenewProperties

SavingsPlanModel

SavingsPlanTerm

Sku

systemData

Utilization

UtilizationAggregates