你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SubscriptionContract interface

包:

@azure/arm-apimanagement

订阅详细信息。

扩展

ProxyResource

属性

allowTracing	确定是否启用跟踪
createdDate	订阅创建日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。 注意：此属性不会序列化。 它只能由服务器填充。
displayName	订阅的名称，如果订阅没有名称，则为 null。
endDate	订阅已取消或过期的日期。 此设置仅用于审核目的，订阅不会自动取消。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
expirationDate	订阅到期日期。 此设置仅用于审核目的，订阅不会自动过期。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
notificationDate	即将推出的订阅过期通知日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
ownerId	订阅所有者的用户资源标识符。 该值是 /users/{userId} 格式的有效相对 URL，其中 {userId} 是用户标识符。
primaryKey	订阅主密钥。 此属性不会在“GET”作上填充！ 使用“/listSecrets”POST 请求获取值。
scope	范围，如 /products/{productId} 或 /apis 或 /apis/{apiId}。
secondaryKey	订阅辅助密钥。 此属性不会在“GET”作上填充！ 使用“/listSecrets”POST 请求获取值。
startDate	订阅激活日期。 此设置仅用于审核目的，订阅不会自动激活。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
state	订阅状态。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。
stateComment	当状态更改为“已拒绝”时，管理员添加的可选订阅注释。

继承属性

id	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。
name	资源说明的名称：此属性不会序列化。 它只能由服务器填充。
type	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

allowTracing

确定是否启用跟踪

allowTracing?: boolean

属性值

boolean

createdDate

订阅创建日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。

注意：此属性不会序列化。 它只能由服务器填充。

createdDate?: Date

属性值

Date

displayName

订阅的名称，如果订阅没有名称，则为 null。

displayName?: string

属性值

string

endDate

订阅已取消或过期的日期。 此设置仅用于审核目的，订阅不会自动取消。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。

endDate?: Date

属性值

Date

expirationDate

订阅到期日期。 此设置仅用于审核目的，订阅不会自动过期。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。

expirationDate?: Date

属性值

Date

notificationDate

即将推出的订阅过期通知日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。

notificationDate?: Date

属性值

Date

ownerId

订阅所有者的用户资源标识符。 该值是 /users/{userId} 格式的有效相对 URL，其中 {userId} 是用户标识符。

ownerId?: string

属性值

string

primaryKey

订阅主密钥。 此属性不会在“GET”作上填充！ 使用“/listSecrets”POST 请求获取值。

primaryKey?: string

属性值

string

scope

范围，如 /products/{productId} 或 /apis 或 /apis/{apiId}。

scope?: string

属性值

string

secondaryKey

订阅辅助密钥。 此属性不会在“GET”作上填充！ 使用“/listSecrets”POST 请求获取值。

secondaryKey?: string

属性值

string

startDate

订阅激活日期。 此设置仅用于审核目的，订阅不会自动激活。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。

startDate?: Date

属性值

Date

state

订阅状态。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。

state?: SubscriptionState

属性值

SubscriptionState

stateComment

当状态更改为“已拒绝”时，管理员添加的可选订阅注释。

stateComment?: string

属性值

string

继承属性详细信息

id

资源的完全限定资源 ID。 Ex - /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