Ресурсы подписки
Область применения: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud for US Government
Подписка позволяет клиенту использовать службу в течение определенного периода времени. Не все поля применяются ко всем подпискам. Многие поля применяются только в определенных точках жизненного цикла, например, если подписка приостановлена или отменена.
Отток подписок
Примечание.
Ресурс подписки имеет ограничение скорости в 500 запросов в минуту на идентификатор клиента.
Ресурс подписки представляет жизненный цикл подписки и включает свойства, определяющие состояния в течение жизненного цикла подписки.
| Свойство | Type | Описание |
|---|---|---|
| Идентификатор | строка | Идентификатор подписки. |
| offerId | строка | Идентификатор предложения. |
| entitlementId | строка | Идентификатор права (идентификатор подписки Azure). |
| offerName | строка | Имя предложения. |
| friendlyName | строка | Понятное имя подписки, определенной партнером, чтобы помочь диамбигуировать. |
| quantity | number | Количество. Это свойство имеет значение счетчика лицензий для выставления счетов на основе лицензий. |
| unitType | строка | Единицы, определяющие количество для подписки: "Лицензии", "На основе использования" или "Преимущество". |
| parentSubscriptionId | строка | Возвращает или задает идентификатор родительской подписки. |
| creationDate | строка | Возвращает или задает дату создания в формате даты и времени. |
| effectiveStartDate | Строка в формате даты и времени UTC | Возвращает или задает дату начала для этой подписки в формате даты и времени. Это свойство используется для обратной даты перенесенной подписки или выравнивания ее с другой. |
| commitmentEndDate | Строка в формате даты и времени UTC | Дата окончания обязательства для этой подписки в формате даты и времени. Для подписок, которые не являются автоматически обновляемыми, это свойство представляет дату далеко в будущем. Новые даты окончания торговли включительно, то есть конец срока находится в конце полного дня. Устаревшие даты окончания не являются инклюзивными. |
| commitmentEndDateTime | Строка в формате даты и времени UTC | Дата и время окончания обязательства для этой подписки в формате даты и времени. Для подписок, которые не являются автоматически обновляемыми, это свойство представляет дату далеко в будущем. |
| статус | строка | Состояние подписки: "none", "активный", "ожидающий", "приостановлено", "истек срок действия", "отключено" или "удалено". |
| autoRenewEnabled | boolean | Возвращает значение, указывающее, обновляется ли подписка автоматически. |
| billingType | строка | Указывает, как взимается плата за подписку: "none", "использование", "лицензия" или "преимущество". |
| billingCycle | строка | Указывает частоту выставления счетов партнером за этот заказ. Поддерживаемые значения: имена участников в BillingCycleType. |
| hasPurchasableAddons | boolean | Возвращает или задает значение, указывающее, имеет ли подписка доступные надстройки. |
| isTrial | boolean | Значение, указывающее, является ли подписка пробной версией. |
| isMicrosoftProduct | boolean | Значение, указывающее, является ли подписка продуктом Майкрософт. |
| publisherName | строка | Имя издателя. |
| actions | массив строк | Возвращает или задает допустимые действия. Возможные значения: "edit", "cancel" |
| partnerId | строка | PartnerID торгового посредника записи, используемого в непрямой модели партнера. |
| suspensionReasons | массив строк | Только чтение. Если подписка была приостановлена, указывает, почему. |
| contractType | строка | Только чтение. Тип контракта: "подписка", "productKey" или "redemptionCode". |
| возвратoptions | массив ресурсов RefundOption | Только для чтения. Набор вариантов возврата средств, доступных для этой подписки. |
| scheduledNextTermInstructions | scheduledNextTermInstructions | Возвращает или задает запланированные инструкции, выполняемые при запуске следующего термина. |
| nextChargeInstructions | nextChargeInstructions | Возвращает сведения о следующих инструкциях по выставлению счетов за ожидающие период выставления счетов изменения в конце текущего срока. |
| ссылки | SubscriptionLinks | Возвращает или задает ссылки на подписку. |
| orderId | строка | Идентификатор заказа, размещенного для начала подписки. |
| termDuration | строка | Представление срока действия термина ISO 8601. Текущие поддерживаемые значения: P1M (1 месяц), P1Y (1 год) и P3Y (3 года). |
| атрибутов | ResourceAttributes | Атрибуты метаданных, соответствующие подписке. |
| обновлениеTermDuration | строка | Представление срока действия термина ISO 8601. Текущие поддерживаемые значения: P1M (1 месяц) и P1Y (1 год). |
| ProductType | Itemtype | Только чтение. Тип продукта, для который используется подписка. |
| consumptionType | массив избыточных ресурсов | Возвращает или задает превышение параметров для данного клиента. |
| promotionId | строка | Идентификатор повышения, если применяется к подписке. Пример формата: "39NFJQT1PJQB:0001:39NFJQT1QT1Q5KN" |
| ОтменаAllowedUntilDate | Дата/время | Последняя дата отмены. |
| BillingCycleEndDate | Дата/время | Возвращает или задает дату окончания период выставления счетов для этой подписки в формате даты и времени. |
| BillingCycleEndDateTime | Дата/время | Возвращает период выставления счетов время окончания этой подписки в формате даты и времени. |
| productOrderId | строка | Идентификатор для определенной покупки продукта (например, резервирования или плана экономии Azure). |
| lineItems | SubscriptionLineItem | Элемент строки содержит сведения о покупке определенной подписки. |
SubscriptionLinks
Ресурс SubscriptionLinks описывает коллекцию ссылок, подключенных к ресурсу подписки.
| Свойство | Type | Описание |
|---|---|---|
| предложение | Ссылка | Возвращает или задает предложение. |
| parentSubscription | Ссылка | Возвращает или задает родительскую подписку. |
| продукт | Ссылка | Возвращает продукт, связанный с подпиской. |
| sku | Ссылка | Возвращает номер SKU продукта, связанный с подпиской. |
| доступность | Ссылка | Возвращает доступность номера SKU продукта, связанную с подпиской. |
| activationLinks | Ссылка | Возвращает список ссылок активации, связанных с подпиской. |
| self | Ссылка | URI для самостоятельного выполнения. |
| next | Ссылка | Следующая страница элементов. |
| previous | Ссылка | Предыдущая страница элементов. |
SubscriptionProvisioningStatus
Ресурс SubscriptionProvisioningStatus содержит сведения о состоянии подготовки подписки.
| Свойство | Type | Описание |
|---|---|---|
| skuId | строка | Строка, определяющая номер SKU продукта. |
| статус | строка | Указывает состояние подготовки: "success", "pending" или "failed". |
| quantity | number | Предоставляет количество подписок после подготовки. |
| endDate | Строка в формате даты и времени UTC | Дата окончания подписки. |
| атрибутов | ResourceAttributes | Атрибуты метаданных. |
scheduledNextTermInstructions
Ресурс scheduledNextTermInstructions определяет инструкции, которые будут применены в начале следующего срока подписки. Присутствует только в том случае, если запланированные изменения заданы или для всех пробных подписок.
| Свойство | Type | Описание |
|---|---|---|
| продукт | product | Отформатированная строка GUID, определяющая номер SKU продукта. |
| quantity | number | Предоставляет количество подписок после подготовки. |
| customTermEndDate | Строка в формате даты и времени UTC | Настраиваемая дата окончания подписки при выравнивании по дате окончания другой подписки |
Продукт
Ресурс продукта scheduledNextTermInstructions.product и атрибуты запланированного изменения будут применяться в следующем термине.
| Свойство | Type | Описание |
|---|---|---|
| productId | Строка | Идентификатор продукта. |
| skuId | Строка | Предоставляет количество подписок после подготовки. |
| availabilityId | Строка | Идентификатор этой доступности. Этот идентификатор является уникальным только в контексте родительского продукта и номера SKU. Идентификаторы доступности заметок могут меняться с течением времени. Партнеры должны полагаться только на это значение в течение короткого промежутка времени после получения. |
| billingCycle | Строка | Указывает частоту выставления счетов партнером за этот заказ. Поддерживаемые значения: имена участников в BillingCycleType. |
| termDuration | Строка | Представление срока действия термина ISO 8601. Текущие поддерживаемые значения: P1M (1 месяц) и P1Y (1 год). |
| promotionId | Строка | Идентификатор повышения, который будет применен к следующему запланированному термину. Пример формата: "39NFJQT1PJQB:0001:39NFJQT1QT1Q5KN". |
nextChargeInstructions
Ресурс nextChargeInstructions определяет период выставления счетов инструкции, применяемые в начале следующего срока подписки. Присутствует только при ожидании период выставления счетов изменений.
| Свойство | Type | Описание |
|---|---|---|
| продукт | product | Отформатированная строка GUID, определяющая номер SKU продукта. |
| quantity | number | Предоставляет количество подписок после подготовки. |
SubscriptionRegistrationStatus
Ресурс SubscriptionRegistrationStatus описывает коллекцию ссылок, подключенных к ресурсу подписки.
| Свойство | Type | Описание |
|---|---|---|
| subscriptionId | строка | Идентификатор подписки. |
| статус | строка | Указывает состояние регистрации: "зарегистрировано", "регистрация" или "не зарегистрировано". |
SupportContact
Ресурс SupportContact представляет контакт в службу поддержки для подписки клиента.
| Свойство | Type | Описание |
|---|---|---|
| supportTenantId | строка | Отформатированная строка GUID, указывающая идентификатор клиента контакта поддержки. |
| supportMpnId | строка | Идентификатор партнера контакта. |
| name | строка | Имя контакта в службу поддержки. |
| ссылки | ResourceLinks | Связанные ссылки в службу поддержки. |
| атрибутов | ResourceAttributes | Атрибуты метаданных. Содержит объектType: "SupportContact". |
Избыток
Ресурс перебора представляет превышение потребления подписки может быть назначено, независимо от того, назначен ли он и назначен торговый посредник.
| Свойство | Type | Описание |
|---|---|---|
| azureEntitlementId | строка | Отформатированная строка GUID, указывающая идентификатор подписки на потребление. |
| partnerId | строка | Идентификатор партнера торгового посредника, связанного с подпиской. |
| type | строка | Тип превышения может быть "Телефон Services" |
| Излишки | boolean | Значение, указывающее, включена ли превышение. |
| ссылки | ResourceLinks | Перебор связанных ссылок. |
| атрибутов | ResourceAttributes | Атрибуты метаданных. Содержит объектType: Overage. |
RegisterSubscription
Ресурс RegisterSubscription возвращает ссылку, которую можно использовать для запроса состояния регистрации подписки. Состояние регистрации возвращается в тексте ответа успешно принятого запроса на регистрацию подписки Azure.
| Свойство | Type | Описание |
|---|---|---|
| httpResponseMessage | объект | Возвращает код состояния HTTP 202 "Принято" с заголовком расположения, содержащим ссылку для запроса состояния регистрации. Пример: "/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus" |
Возврат средств
Ресурс RefundOption представляет возможный вариант возврата для подписки.
| Свойство | Type | Описание |
|---|---|---|
| type | строка | Тип возврата. Поддерживаемые значения: "Частично" и "Full" |
| истекает срок действия после окончания срока действия | Строка в формате даты и времени UTC | Метка времени истечения срока действия этого параметра. Если значение null, операция возврата не имеет срока действия. |
AzureEntitlement
Ресурс AzureEntitlement представляет права Azure для подписки.
| Свойство | Type | Описание |
|---|---|---|
| Идентификатор | строка | Идентификатор права |
| friendlyName | строка | Понятное имя права. |
| статус | строка | Состояние права. |
| subscriptionId | строка | Идентификатор подписки, к которому принадлежит право. |
SubscriptionLineItem
Элемент строки содержит сведения о покупке определенной подписки.
| Свойство | Тип | Description |
|---|---|---|
| Идентификатор | строка | Идентификатор элемента строки подписки. |
| friendlyName | строка | Понятное имя для элемента строки подписки, определенного партнером, чтобы помочь диамбигуировать. |
| область | Область применения | Область указывает, где применяются преимущества. |
| autoRenewEnabled | Логический | Возвращает значение, указывающее, обновляется ли подписка автоматически. |
| статус | строка | Состояние подписки: "none", "активный", "ожидающий", "приостановлено", "истек срок действия", "отключено" или "удалено". |
| purchaseCommitment | Обязательство по приобретению | Фиксированный объем, зафиксированный в службах вычислений. |
Область
Область указывает, где применяются преимущества.
| Свойство | Тип | Description |
|---|---|---|
| type | строка | Тип область для покупки: "Single", "Shared", "Resource group" или "Management group". |
| subscriptionId | строка | Идентификатор плана Azure, который будет использоваться для покупки. Требуется для общих область. |
| entitlementId | строка | Идентификатор подписки Azure, которая будет использоваться для покупки. Требуется для одного область. |
| managementGroupId | строка | Идентификатор группы управления, которая будет использоваться для покупки. Этот область можно выбрать только через портал Azure сегодня, но обновления отражаются на компьютере. |
| resourceGroupId | строка | Идентификатор группы ресурсов, которая будет использоваться для покупки. Этот область можно выбрать только через портал Azure сегодня, но обновления отражаются на компьютере. |
Обязательство по приобретению
Фиксированный объем, зафиксированный в службах вычислений.
| Свойство | Тип | Description |
|---|---|---|
| amount | строка | Обязательство фиксированной суммы. |
| Зерна | строка | Период обязательства. |
| валюта | строка | Валюта обязательства. |