通过

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

Microsoft.ApiManagement service/identityProviders 2019-12-01-preview

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowedTenants: [
      'string'
    ]
    authority: 'string'
    clientId: 'string'
    clientSecret: 'string'
    passwordResetPolicyName: 'string'
    profileEditingPolicyName: 'string'
    signinPolicyName: 'string'
    signinTenant: 'string'
    signupPolicyName: 'string'
    type: 'string'
  }
}

属性值

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

名字 描述 价值
allowedTenants 配置 Azure Active Directory 登录时允许的租户列表。 string[]
柄 AAD 或 AAD B2C 的 OpenID Connect 发现终结点主机名。 字符串
clientId 外部标识提供者中应用程序的客户端 ID。 它是 Facebook 登录的应用 ID、Google 登录的客户端 ID、Microsoft的应用 ID。 字符串

约束：
最小长度 = 1 （必需）
clientSecret 外部标识提供者中应用程序的客户端密码，用于对登录请求进行身份验证。 例如，它是 Facebook 登录的应用机密、Google 登录的 API 密钥、Microsoft公钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串

约束：
最小长度 = 1
敏感值。 以安全参数的形式传入。 （必需）
passwordResetPolicyName 密码重置策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
profileEditingPolicyName 配置文件编辑策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
signinPolicyName 登录策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
signinTenant 登录到 Active Directory 时要使用的 TenantId 而不是 Common 字符串
signupPolicyName 注册策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
类型 标识提供者类型标识符。 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”

Microsoft.ApiManagement/service/identityProviders

名字 描述 价值
名字 资源名称 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”（必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

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

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2019-12-01-preview",
  "name": "string",
  "properties": {
    "allowedTenants": [ "string" ],
    "authority": "string",
    "clientId": "string",
    "clientSecret": "string",
    "passwordResetPolicyName": "string",
    "profileEditingPolicyName": "string",
    "signinPolicyName": "string",
    "signinTenant": "string",
    "signupPolicyName": "string",
    "type": "string"
  }
}

属性值

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

名字 描述 价值
allowedTenants 配置 Azure Active Directory 登录时允许的租户列表。 string[]
柄 AAD 或 AAD B2C 的 OpenID Connect 发现终结点主机名。 字符串
clientId 外部标识提供者中应用程序的客户端 ID。 它是 Facebook 登录的应用 ID、Google 登录的客户端 ID、Microsoft的应用 ID。 字符串

约束：
最小长度 = 1 （必需）
clientSecret 外部标识提供者中应用程序的客户端密码，用于对登录请求进行身份验证。 例如，它是 Facebook 登录的应用机密、Google 登录的 API 密钥、Microsoft公钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串

约束：
最小长度 = 1
敏感值。 以安全参数的形式传入。 （必需）
passwordResetPolicyName 密码重置策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
profileEditingPolicyName 配置文件编辑策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
signinPolicyName 登录策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
signinTenant 登录到 Active Directory 时要使用的 TenantId 而不是 Common 字符串
signupPolicyName 注册策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
类型 标识提供者类型标识符。 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”

Microsoft.ApiManagement/service/identityProviders

名字 描述 价值
apiVersion API 版本 '2019-12-01-preview'
名字 资源名称 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”（必需）
性能 标识提供者协定属性。 IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/identityProviders”

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      allowedTenants = [
        "string"
      ]
      authority = "string"
      clientId = "string"
      clientSecret = "string"
      passwordResetPolicyName = "string"
      profileEditingPolicyName = "string"
      signinPolicyName = "string"
      signinTenant = "string"
      signupPolicyName = "string"
      type = "string"
    }
  })
}

属性值

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

名字 描述 价值
allowedTenants 配置 Azure Active Directory 登录时允许的租户列表。 string[]
柄 AAD 或 AAD B2C 的 OpenID Connect 发现终结点主机名。 字符串
clientId 外部标识提供者中应用程序的客户端 ID。 它是 Facebook 登录的应用 ID、Google 登录的客户端 ID、Microsoft的应用 ID。 字符串

约束：
最小长度 = 1 （必需）
clientSecret 外部标识提供者中应用程序的客户端密码，用于对登录请求进行身份验证。 例如，它是 Facebook 登录的应用机密、Google 登录的 API 密钥、Microsoft公钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串

约束：
最小长度 = 1
敏感值。 以安全参数的形式传入。 （必需）
passwordResetPolicyName 密码重置策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
profileEditingPolicyName 配置文件编辑策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
signinPolicyName 登录策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
signinTenant 登录到 Active Directory 时要使用的 TenantId 而不是 Common 字符串
signupPolicyName 注册策略名称。 仅适用于 AAD B2C 标识提供者。 字符串

约束：
最小长度 = 1
类型 标识提供者类型标识符。 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”

Microsoft.ApiManagement/service/identityProviders

名字 描述 价值
名字 资源名称 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”（必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：服务
性能 标识提供者协定属性。 IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/identityProviders@2019-12-01-preview”