- Latest
- 2025-09-01-預覽
- 2025-03-01-preview
- 2024-10-01-preview
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-預覽版
- 2023-03-01-預覽版
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-預覽版
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-預覽版
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-預覽版
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep 資源定義
服務/使用者資源類型可以使用目標作業來部署:
- 資源群組 - 請參見 資源群組部署指令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/users 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.ApiManagement/service/users@2025-09-01-preview' = {
parent: resourceSymbolicName
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
| Name | Description | 價值 |
|---|---|---|
| 名稱 | 資源名稱 | string Constraints: 最小長度 = 1 最大長度 = 80 (必要) |
| 父代 | 在 Bicep 中,你可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。 欲了解更多資訊,請參閱 Child 資源 外部 parent resource。 |
類型的資源符號名稱:服務 |
| 屬性 | 用戶實體建立合約屬性。 | UserCreateParameterPropertiesOrUserContractProperties |
UserCreateParameterPropertiesOrUserContractProperties
| Name | Description | 價值 |
|---|---|---|
| 應用程式類型 | 決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。 | 'developerPortal' 'portal' |
| 確認 | 決定將傳送給新建立使用者的確認電子郵件類型。 | 'invite' 'signup' |
| 電子郵件 | 電子郵件地址。 不能是空的,而且在服務實例內必須是唯一的。 | string Constraints: 最小長度 = 1 最大長度 = 254 (必要) |
| firstName | 名字。 | string Constraints: 最小長度 = 1 最大長度 = 100 (必要) |
| 身分識別 | 使用者身分識別的集合。 | UserIdentityContract[] |
| 姓氏 | 姓。 | string Constraints: 最小長度 = 1 最大長度 = 100 (必要) |
| 注意 | 系統管理員所設定使用者的相關選擇性注意事項。 | 字串 |
| 密碼 | 用戶密碼。 如果未提供任何值,則會產生默認密碼。 | 字串 |
| 狀態 | 帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站,或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。 | 'active' 'blocked' 'deleted' 'pending' |
UserIdentityContract
| Name | Description | 價值 |
|---|---|---|
| 識別碼 | 提供者內的標識碼值。 | 字串 |
| 提供者 | 識別提供者名稱。 | 字串 |
使用範例
Bicep 範例
部署 API 管理 使用者的基本範例。
param location string = 'westeurope'
param resourceName string = 'acctest0001'
resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
name: resourceName
location: location
sku: {
capacity: 1
name: 'Developer'
}
properties: {
certificates: []
customProperties: {
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
}
disableGateway: false
publicNetworkAccess: 'Enabled'
publisherEmail: 'pub1@email.com'
publisherName: 'pub1'
virtualNetworkType: 'None'
}
}
resource user 'Microsoft.ApiManagement/service/users@2021-08-01' = {
name: resourceName
parent: service
properties: {
email: 'azure-acctest230630032559695401@example.com'
firstName: 'Acceptance'
lastName: 'Test'
}
}
ARM 樣本資源定義
服務/使用者資源類型可以使用目標作業來部署:
- 資源群組 - 請參見 資源群組部署指令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/users 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.ApiManagement/service/users",
"apiVersion": "2025-09-01-preview",
"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
| Name | Description | 價值 |
|---|---|---|
| apiVersion | API 版本 | “2025-09-01-預覽” |
| 名稱 | 資源名稱 | string Constraints: 最小長度 = 1 最大長度 = 80 (必要) |
| 屬性 | 用戶實體建立合約屬性。 | UserCreateParameterPropertiesOrUserContractProperties |
| 型別 | 資源類型 | 'Microsoft.ApiManagement/service/users' |
UserCreateParameterPropertiesOrUserContractProperties
| Name | Description | 價值 |
|---|---|---|
| 應用程式類型 | 決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。 | 'developerPortal' 'portal' |
| 確認 | 決定將傳送給新建立使用者的確認電子郵件類型。 | 'invite' 'signup' |
| 電子郵件 | 電子郵件地址。 不能是空的,而且在服務實例內必須是唯一的。 | string Constraints: 最小長度 = 1 最大長度 = 254 (必要) |
| firstName | 名字。 | string Constraints: 最小長度 = 1 最大長度 = 100 (必要) |
| 身分識別 | 使用者身分識別的集合。 | UserIdentityContract[] |
| 姓氏 | 姓。 | string Constraints: 最小長度 = 1 最大長度 = 100 (必要) |
| 注意 | 系統管理員所設定使用者的相關選擇性注意事項。 | 字串 |
| 密碼 | 用戶密碼。 如果未提供任何值,則會產生默認密碼。 | 字串 |
| 狀態 | 帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站,或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。 | 'active' 'blocked' 'deleted' 'pending' |
UserIdentityContract
| Name | Description | 價值 |
|---|---|---|
| 識別碼 | 提供者內的標識碼值。 | 字串 |
| 提供者 | 識別提供者名稱。 | 字串 |
使用範例
Terraform (AzAPI 提供者) 資源定義
服務/使用者資源類型可以使用目標作業來部署:
- 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/users 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/users@2025-09-01-preview"
name = "string"
parent_id = "string"
body = {
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
| Name | Description | 價值 |
|---|---|---|
| 名稱 | 資源名稱 | string Constraints: 最小長度 = 1 最大長度 = 80 (必要) |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼:服務 |
| 屬性 | 用戶實體建立合約屬性。 | UserCreateParameterPropertiesOrUserContractProperties |
| 型別 | 資源類型 | 「Microsoft。ApiManagement/service/users@2025-09-01-preview” |
UserCreateParameterPropertiesOrUserContractProperties
| Name | Description | 價值 |
|---|---|---|
| 應用程式類型 | 決定傳送建立使用者要求的應用程式類型。 預設值為舊版入口網站。 | 'developerPortal' 'portal' |
| 確認 | 決定將傳送給新建立使用者的確認電子郵件類型。 | 'invite' 'signup' |
| 電子郵件 | 電子郵件地址。 不能是空的,而且在服務實例內必須是唯一的。 | string Constraints: 最小長度 = 1 最大長度 = 254 (必要) |
| firstName | 名字。 | string Constraints: 最小長度 = 1 最大長度 = 100 (必要) |
| 身分識別 | 使用者身分識別的集合。 | UserIdentityContract[] |
| 姓氏 | 姓。 | string Constraints: 最小長度 = 1 最大長度 = 100 (必要) |
| 注意 | 系統管理員所設定使用者的相關選擇性注意事項。 | 字串 |
| 密碼 | 用戶密碼。 如果未提供任何值,則會產生默認密碼。 | 字串 |
| 狀態 | 帳戶狀態。 指定使用者是否為使用中。 封鎖的用戶無法登入開發人員入口網站,或呼叫任何已訂閱產品的 API。 默認狀態為 [作用中]。 | 'active' 'blocked' 'deleted' 'pending' |
UserIdentityContract
| Name | Description | 價值 |
|---|---|---|
| 識別碼 | 提供者內的標識碼值。 | 字串 |
| 提供者 | 識別提供者名稱。 | 字串 |
使用範例
Terraform 範例
部署 API 管理 使用者的基本範例。
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "service" {
type = "Microsoft.ApiManagement/service@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
certificates = [
]
customProperties = {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11" = "false"
}
disableGateway = false
publicNetworkAccess = "Enabled"
publisherEmail = "pub1@email.com"
publisherName = "pub1"
virtualNetworkType = "None"
}
sku = {
capacity = 1
name = "Developer"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
timeouts {
create = "180m"
update = "180m"
delete = "180m"
}
}
resource "azapi_resource" "user" {
type = "Microsoft.ApiManagement/service/users@2021-08-01"
parent_id = azapi_resource.service.id
name = var.resource_name
body = {
properties = {
email = "azure-acctest230630032559695401@example.com"
firstName = "Acceptance"
lastName = "Test"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}