你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SubscriptionCreateParameters interface
订阅创建详细信息。
属性
allow |
确定是否可以启用跟踪 |
display |
订阅名称。 |
owner |
正在为其创建订阅的用户(用户 ID 路径)格式为 /users/{userId} |
primary |
主订阅密钥。 如果未在请求密钥期间指定,将自动生成。 |
scope | 范围,如 /products/{productId} 或 /apis 或 /apis/{apiId}。 |
secondary |
辅助订阅密钥。 如果未在请求密钥期间指定,将自动生成。 |
state | 初始订阅状态。 如果未指定任何值,则使用“已提交”状态创建订阅。 可能的状态为 * 活动 – 订阅处于活动状态, * 已暂停 – 订阅被阻止,订阅者无法调用产品的任何 API, * 已提交 – 订阅请求已由开发人员发出,但尚未批准或拒绝,* 已拒绝 – 订阅请求已被管理员拒绝,* 已取消 – 订阅已被开发人员或管理员取消, * 已过期 – 订阅已达到到期日期并已停用。 |
属性详细信息
allowTracing
确定是否可以启用跟踪
allowTracing?: boolean
属性值
boolean
displayName
订阅名称。
displayName?: string
属性值
string
ownerId
正在为其创建订阅的用户(用户 ID 路径)格式为 /users/{userId}
ownerId?: string
属性值
string
primaryKey
主订阅密钥。 如果未在请求密钥期间指定,将自动生成。
primaryKey?: string
属性值
string
scope
范围,如 /products/{productId} 或 /apis 或 /apis/{apiId}。
scope?: string
属性值
string
secondaryKey
辅助订阅密钥。 如果未在请求密钥期间指定,将自动生成。
secondaryKey?: string
属性值
string
state
初始订阅状态。 如果未指定任何值,则使用“已提交”状态创建订阅。 可能的状态为 * 活动 – 订阅处于活动状态, * 已暂停 – 订阅被阻止,订阅者无法调用产品的任何 API, * 已提交 – 订阅请求已由开发人员发出,但尚未批准或拒绝,* 已拒绝 – 订阅请求已被管理员拒绝,* 已取消 – 订阅已被开发人员或管理员取消, * 已过期 – 订阅已达到到期日期并已停用。
state?: SubscriptionState