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

SubscriptionContract interface

  • Ссылка
Пакет:
@azure/arm-apimanagement

Сведения о подписке.

Extends
ProxyResource

Свойства

allowTracing

Определяет, включена ли трассировка
createdDate

Дата создания подписки. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.

ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
displayName

Имя подписки или значение NULL, если у подписки нет имени.
endDate

Дата отмены или истечения срока действия подписки. Параметр предназначен только для аудита, и подписка не отменяется автоматически. Жизненным циклом подписки можно управлять с помощью state свойства . Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.
expirationDate

Дата окончания срока действия подписки. Этот параметр предназначен только для аудита, и срок действия подписки не истекает автоматически. Жизненным циклом подписки можно управлять с помощью state свойства . Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.
notificationDate

Дата уведомления о предстоящем истечении срока действия подписки. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.
ownerId

Идентификатор ресурса пользователя, являющегося владельцем подписки. Значением является допустимый относительный URL-адрес в формате /users/{userId}, где {userId} — это идентификатор пользователя.
primaryKey

Первичный ключ подписки. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.
scope

Область действия, например /products/{productId} или /apis или /apis/{apiId}.
secondaryKey

Вторичный ключ подписки. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.
startDate

Дата активации подписки. Параметр предназначен только для аудита, и подписка не активируется автоматически. Жизненным циклом подписки можно управлять с помощью state свойства . Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.
state

Состояние подписки. Возможные состояния: * активный — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать API продукта, * отправлено — запрос подписки был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос подписки отклонен администратором, * отменен — подписка отменена администратором, * отменена — подписка отменена разработчиком или администратором. * истек срок действия подписки — срок действия подписки истек и был отключен.
stateComment

Необязательный комментарий подписки, добавленный администратором при изменении состояния на "отклонено".

Унаследованные свойства

id

Полный идентификатор ресурса. Пример — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
type

Тип ресурса. Например Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

Сведения о свойстве

allowTracing

Определяет, включена ли трассировка

allowTracing?: boolean

Значение свойства

boolean

createdDate

Дата создания подписки. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.

ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

createdDate?: Date

Значение свойства

Date

displayName

Имя подписки или значение NULL, если у подписки нет имени.

displayName?: string

Значение свойства

string

endDate

Дата отмены или истечения срока действия подписки. Параметр предназначен только для аудита, и подписка не отменяется автоматически. Жизненным циклом подписки можно управлять с помощью state свойства . Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.

endDate?: Date

Значение свойства

Date

expirationDate

Дата окончания срока действия подписки. Этот параметр предназначен только для аудита, и срок действия подписки не истекает автоматически. Жизненным циклом подписки можно управлять с помощью state свойства . Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.

expirationDate?: Date

Значение свойства

Date

notificationDate

Дата уведомления о предстоящем истечении срока действия подписки. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.

notificationDate?: Date

Значение свойства

Date

ownerId

Идентификатор ресурса пользователя, являющегося владельцем подписки. Значением является допустимый относительный URL-адрес в формате /users/{userId}, где {userId} — это идентификатор пользователя.

ownerId?: string

Значение свойства

string

primaryKey

Первичный ключ подписки. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.

primaryKey?: string

Значение свойства

string

scope

Область действия, например /products/{productId} или /apis или /apis/{apiId}.

scope?: string

Значение свойства

string

secondaryKey

Вторичный ключ подписки. Это свойство не будет заполнено при операциях GET! Используйте запрос POST /listSecrets, чтобы получить значение.

secondaryKey?: string

Значение свойства

string

startDate

Дата активации подписки. Параметр предназначен только для аудита, и подписка не активируется автоматически. Жизненным циклом подписки можно управлять с помощью state свойства . Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.

startDate?: Date

Значение свойства

Date

state

Состояние подписки. Возможные состояния: * активный — подписка активна, * приостановлена — подписка заблокирована, и подписчик не может вызывать API продукта, * отправлено — запрос подписки был сделан разработчиком, но еще не утвержден или отклонен, * отклонен — запрос подписки отклонен администратором, * отменен — подписка отменена администратором, * отменена — подписка отменена разработчиком или администратором. * истек срок действия подписки — срок действия подписки истек и был отключен.

state?: SubscriptionState

Значение свойства

SubscriptionState

stateComment

Необязательный комментарий подписки, добавленный администратором при изменении состояния на "отклонено".

stateComment?: string

Значение свойства

string

Сведения об унаследованном свойстве

id

Полный идентификатор ресурса. Пример — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

id?: string

Значение свойства

string

Наследуетсяот ProxyResource.id

name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

name?: string

Значение свойства

string

Наследуетсяот ProxyResource.name

type

Тип ресурса. Например Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

type?: string

Значение свойства

string

Наследуется отProxyResource.type