共用方式為

Microsoft.ApiManagement 服務/subscriptions 2019-12-01

  • 發行項

Bicep 資源定義

您可以使用目標作業來部署服務/訂用帳戶資源類型：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/subscriptions 資源，請將下列 Bicep 新增至範本。

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

屬性值

Microsoft.ApiManagement/service/subscriptions

名字 描述 價值
名字 資源名稱 字串

約束：
最大長度 =
模式 = ^[^*#&+:<>?]+$ （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
性能 訂用帳戶合約屬性。 SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

名字 描述 價值
allowTracing 判斷是否可以啟用追蹤 bool
displayName 訂用帳戶名稱。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
ownerId 以 /users/{userId} 形式建立訂用帳戶的使用者（使用者標識符路徑） 字串
primaryKey 主要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。 字串

約束：
最小長度 = 1
最大長度 = 1
範圍 範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}。 字串 （必要）
secondaryKey 次要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。 字串

約束：
最小長度 = 1
最大長度 = 1
州 初始訂閱狀態。 如果未指定任何值，則會使用 [送出] 狀態來建立訂用帳戶。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。 'active'
'cancelled'
'expired'
'rejected'
'submitted'
'suspended'

ARM 樣本資源定義

您可以使用目標作業來部署服務/訂用帳戶資源類型：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/subscriptions 資源，請將下列 JSON 新增至範本。

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

屬性值

Microsoft.ApiManagement/service/subscriptions

名字 描述 價值
apiVersion API 版本 '2019-12-01'
名字 資源名稱 字串

約束：
最大長度 =
模式 = ^[^*#&+:<>?]+$ （必要）
性能 訂用帳戶合約屬性。 SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
類型 資源類型 'Microsoft.ApiManagement/service/subscriptions'

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

名字 描述 價值
allowTracing 判斷是否可以啟用追蹤 bool
displayName 訂用帳戶名稱。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
ownerId 以 /users/{userId} 形式建立訂用帳戶的使用者（使用者標識符路徑） 字串
primaryKey 主要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。 字串

約束：
最小長度 = 1
最大長度 = 1
範圍 範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}。 字串 （必要）
secondaryKey 次要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。 字串

約束：
最小長度 = 1
最大長度 = 1
州 初始訂閱狀態。 如果未指定任何值，則會使用 [送出] 狀態來建立訂用帳戶。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。 'active'
'cancelled'
'expired'
'rejected'
'submitted'
'suspended'

Terraform （AzAPI 提供者） 資源定義

您可以使用目標作業來部署服務/訂用帳戶資源類型：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/subscriptions 資源，請將下列 Terraform 新增至範本。

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

屬性值

Microsoft.ApiManagement/service/subscriptions

名字 描述 價值
名字 資源名稱 字串

約束：
最大長度 =
模式 = ^[^*#&+:<>?]+$ （必要）
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
性能 訂用帳戶合約屬性。 SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
類型 資源類型 “Microsoft.ApiManagement/service/subscriptions@2019-12-01”

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

名字 描述 價值
allowTracing 判斷是否可以啟用追蹤 bool
displayName 訂用帳戶名稱。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
ownerId 以 /users/{userId} 形式建立訂用帳戶的使用者（使用者標識符路徑） 字串
primaryKey 主要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。 字串

約束：
最小長度 = 1
最大長度 = 1
範圍 範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}。 字串 （必要）
secondaryKey 次要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。 字串

約束：
最小長度 = 1
最大長度 = 1
州 初始訂閱狀態。 如果未指定任何值，則會使用 [送出] 狀態來建立訂用帳戶。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。 'active'
'cancelled'
'expired'
'rejected'
'submitted'
'suspended'