通过

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

Microsoft.ApiManagement 服务/subscriptions 2021-04-01-preview

  • 项目

Bicep 资源定义

可以使用目标操作部署服务/订阅资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/subscriptions 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

属性值

Microsoft.ApiManagement/service/subscriptions

名字 描述 价值
名字 资源名称 字符串

约束：
最大长度 = 256
模式 = ^[^*#&+:<>?]+$ （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：服务
性能 订阅协定属性。 SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

名字 描述 价值
allowTracing 确定是否可以启用跟踪 bool
displayName 订阅名称。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
ownerId 正在为其创建订阅的用户（用户 ID 路径）格式为 /users/{userId} 字符串
primaryKey 主订阅密钥。 如果未在请求密钥期间指定，将自动生成。 字符串

约束：
最小长度 = 1
最大长度 = 256
范围 范围，如 /products/{productId} 或 /apis 或 /apis/{apiId}。 string （必需）
secondaryKey 辅助订阅密钥。 如果未在请求密钥期间指定，将自动生成。 字符串

约束：
最小长度 = 1
最大长度 = 256
州 初始订阅状态。 如果未指定任何值，则使用“已提交”状态创建订阅。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。 “active”
“cancelled”
“expired”
“rejected”
“submitted”
“suspended”

ARM 模板资源定义

可以使用目标操作部署服务/订阅资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/subscriptions 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

属性值

Microsoft.ApiManagement/service/subscriptions

名字 描述 价值
apiVersion API 版本 '2021-04-01-preview'
名字 资源名称 字符串

约束：
最大长度 = 256
模式 = ^[^*#&+:<>?]+$ （必需）
性能 订阅协定属性。 SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/subscriptions”

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

名字 描述 价值
allowTracing 确定是否可以启用跟踪 bool
displayName 订阅名称。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
ownerId 正在为其创建订阅的用户（用户 ID 路径）格式为 /users/{userId} 字符串
primaryKey 主订阅密钥。 如果未在请求密钥期间指定，将自动生成。 字符串

约束：
最小长度 = 1
最大长度 = 256
范围 范围，如 /products/{productId} 或 /apis 或 /apis/{apiId}。 string （必需）
secondaryKey 辅助订阅密钥。 如果未在请求密钥期间指定，将自动生成。 字符串

约束：
最小长度 = 1
最大长度 = 256
州 初始订阅状态。 如果未指定任何值，则使用“已提交”状态创建订阅。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。 “active”
“cancelled”
“expired”
“rejected”
“submitted”
“suspended”

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务/订阅资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/subscriptions 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2021-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

属性值

Microsoft.ApiManagement/service/subscriptions

名字 描述 价值
名字 资源名称 字符串

约束：
最大长度 = 256
模式 = ^[^*#&+:<>?]+$ （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：服务
性能 订阅协定属性。 SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/subscriptions@2021-04-01-preview”

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

名字 描述 价值
allowTracing 确定是否可以启用跟踪 bool
displayName 订阅名称。 字符串

约束：
最小长度 = 1
最大长度 = 100 （必需）
ownerId 正在为其创建订阅的用户（用户 ID 路径）格式为 /users/{userId} 字符串
primaryKey 主订阅密钥。 如果未在请求密钥期间指定，将自动生成。 字符串

约束：
最小长度 = 1
最大长度 = 256
范围 范围，如 /products/{productId} 或 /apis 或 /apis/{apiId}。 string （必需）
secondaryKey 辅助订阅密钥。 如果未在请求密钥期间指定，将自动生成。 字符串

约束：
最小长度 = 1
最大长度 = 256
州 初始订阅状态。 如果未指定任何值，则使用“已提交”状态创建订阅。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。 “active”
“cancelled”
“expired”
“rejected”
“submitted”
“suspended”