Microsoft.ApiManagement 服務/使用者 2021-08-01

  • 發行項

Bicep 資源定義

服務/使用者資源類型可以使用目標作業來部署：

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

資源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

屬性值

服務/使用者

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

請參閱如何在 Bicep 中設定子資源的名稱和類型。		 字串 （必要）

字元限制：1-80

合法字元：
英數位元和連字元。

以字母開頭，並以英數位元結尾。
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
性能 用戶實體建立合約屬性。 UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

名字 描述 價值
appType 決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。 'developerPortal'
'portal'
確認 決定將傳送給新建立使用者的確認電子郵件類型。 'invite'
'signup'
電子郵件 電子郵件位址。 不能是空的，而且在服務實例內必須是唯一的。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 254
firstName 名字。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
身份 使用者身分識別的集合。 UserIdentityContract[]
lastName 姓。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
注意 系統管理員所設定使用者的相關選擇性注意事項。 字串
密碼 用戶密碼。 如果未提供任何值，則會產生默認密碼。 字串
州 帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。 'active'
'blocked'
'deleted'
'pending'

UserIdentityContract

名字 描述 價值
id 提供者內的標識碼值。 字串
供應商 識別提供者名稱。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用範本 建立 API 管理實例和所有子資源

部署至 Azure 		此範本示範如何建立 API 管理服務及設定子實體

ARM 樣本資源定義

服務/使用者資源類型可以使用目標作業來部署：

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

資源格式

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "appType": "string",
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

屬性值

服務/使用者

名字 描述 價值
類型 資源類型 'Microsoft.ApiManagement/service/users'
apiVersion 資源 API 版本 '2021-08-01'
名字 資源名稱

請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。		 字串 （必要）

字元限制：1-80

合法字元：
英數位元和連字元。

以字母開頭，並以英數位元結尾。
性能 用戶實體建立合約屬性。 UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

名字 描述 價值
appType 決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。 'developerPortal'
'portal'
確認 決定將傳送給新建立使用者的確認電子郵件類型。 'invite'
'signup'
電子郵件 電子郵件位址。 不能是空的，而且在服務實例內必須是唯一的。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 254
firstName 名字。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
身份 使用者身分識別的集合。 UserIdentityContract[]
lastName 姓。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
注意 系統管理員所設定使用者的相關選擇性注意事項。 字串
密碼 用戶密碼。 如果未提供任何值，則會產生默認密碼。 字串
州 帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。 'active'
'blocked'
'deleted'
'pending'

UserIdentityContract

名字 描述 價值
id 提供者內的標識碼值。 字串
供應商 識別提供者名稱。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用範本 建立 API 管理實例和所有子資源

部署至 Azure 		此範本示範如何建立 API 管理服務及設定子實體

Terraform （AzAPI 提供者） 資源定義

服務/使用者資源類型可以使用目標作業來部署：

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appType = "string"
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

屬性值

服務/使用者

名字 描述 價值
類型 資源類型 “Microsoft.ApiManagement/service/users@2021-08-01”
名字 資源名稱 字串 （必要）

字元限制：1-80

合法字元：
英數位元和連字元。

以字母開頭，並以英數位元結尾。
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
性能 用戶實體建立合約屬性。 UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

名字 描述 價值
appType 決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。 “developerPortal”
“portal”
確認 決定將傳送給新建立使用者的確認電子郵件類型。 “邀請”
“signup”
電子郵件 電子郵件位址。 不能是空的，而且在服務實例內必須是唯一的。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 254
firstName 名字。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
身份 使用者身分識別的集合。 UserIdentityContract[]
lastName 姓。 字串 （必要）

約束：
最小長度 = 1
最大長度 = 100
注意 系統管理員所設定使用者的相關選擇性注意事項。 字串
密碼 用戶密碼。 如果未提供任何值，則會產生默認密碼。 字串
州 帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站，或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。 “active”
“blocked”
“deleted”
“pending”

UserIdentityContract

名字 描述 價值
id 提供者內的標識碼值。 字串
供應商 識別提供者名稱。 字串