通过

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

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

  • 项目

Bicep 资源定义

可以使用面向以下操作部署 service/identityProviders 资源类型：

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

资源格式

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

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

属性值

service/identityProviders

名称 说明 值
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-80

有效字符：
字母数字和连字符。

以字母开头且以字母数字结尾。
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为“服务”的资源的符号名称
properties 标识提供者协定属性。 IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

名称 说明 值
allowedTenants 配置 Azure Active Directory 登录名时允许的租户列表。 string[]
authority AAD 或 AAD B2C 的 OpenID Connect 发现终结点主机名。 字符串
clientId 外部标识提供者中应用程序的客户端 ID。 它是Facebook登录的应用 ID、Google 登录的客户端 ID、Microsoft 的应用 ID。 字符串 (必需)
clientLibrary 要用于开发人员门户的客户端库。 仅适用于 AAD 和 AAD B2C 标识提供者。 字符串
clientSecret 外部标识提供者中应用程序的客户端密码，用于对登录请求进行身份验证。 例如，它是用于Facebook登录的应用机密、用于 Google 登录的 API 密钥、Microsoft 的公钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串 (必需)
passwordResetPolicyName 密码重置策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
profileEditingPolicyName 配置文件编辑策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
signinPolicyName 登录策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
signinTenant 登录 Active Directory 时要使用的 TenantId 而不是 Common 字符串
signupPolicyName 注册策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
type 标识提供者类型标识符。 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
使用模板创建 API 管理实例和所有子资源

部署到 Azure		 此模板演示如何创建API 管理服务和配置子实体

ARM 模板资源定义

可以使用面向以下操作部署 service/identityProviders 资源类型：

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

资源格式

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

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

属性值

service/identityProviders

名称 说明 Value
type 资源类型 'Microsoft.ApiManagement/service/identityProviders'
apiVersion 资源 API 版本 “2021-12-01-preview”
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-80

有效字符：
字母数字和连字符。

以字母开头且以字母数字结尾。
properties 标识提供者协定属性。 IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

名称 说明 值
allowedTenants 配置 Azure Active Directory 登录名时允许的租户列表。 string[]
authority AAD 或 AAD B2C 的 OpenID Connect 发现终结点主机名。 字符串
clientId 外部标识提供者中应用程序的客户端 ID。 它是Facebook登录的应用 ID、Google 登录的客户端 ID、Microsoft 的应用 ID。 字符串 (必需)
clientLibrary 要用于开发人员门户的客户端库。 仅适用于 AAD 和 AAD B2C 标识提供者。 字符串
clientSecret 外部标识提供者中应用程序的客户端密码，用于对登录请求进行身份验证。 例如，它是用于Facebook登录的应用机密、用于 Google 登录的 API 密钥、Microsoft 的公钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串 (必需)
passwordResetPolicyName 密码重置策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
profileEditingPolicyName 配置文件编辑策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
signinPolicyName 登录策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
signinTenant 登录 Active Directory 时要使用的 TenantId 而不是 Common 字符串
signupPolicyName 注册策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
type 标识提供者类型标识符。 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
使用模板创建 API 管理实例和所有子资源

部署到 Azure		 此模板演示如何创建API 管理服务和配置子实体

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 service/identityProviders 资源类型：

  • 资源组

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

资源格式

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

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

属性值

service/identityProviders

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/identityProviders@2021-12-01-preview”
name 资源名称 字符串 (必需)

字符限制：1-80

有效字符：
字母数字和连字符。

以字母开头且以字母数字结尾。
parent_id 此资源的父资源 ID。 类型为“服务”的资源的 ID
properties 标识提供者协定属性。 IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

名称 说明 值
allowedTenants 配置 Azure Active Directory 登录名时允许的租户列表。 string[]
authority AAD 或 AAD B2C 的 OpenID Connect 发现终结点主机名。 字符串
clientId 外部标识提供者中应用程序的客户端 ID。 它是Facebook登录的应用 ID、Google 登录的客户端 ID、Microsoft 的应用 ID。 字符串 (必需)
clientLibrary 要用于开发人员门户的客户端库。 仅适用于 AAD 和 AAD B2C 标识提供者。 字符串
clientSecret 外部标识提供者中应用程序的客户端密码，用于对登录请求进行身份验证。 例如，它是用于Facebook登录的应用机密、用于 Google 登录的 API 密钥、Microsoft 的公钥。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 字符串 (必需)
passwordResetPolicyName 密码重置策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
profileEditingPolicyName 配置文件编辑策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
signinPolicyName 登录策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
signinTenant 登录 Active Directory 时要使用的 TenantId 而不是 Common 字符串
signupPolicyName 注册策略名称。 仅适用于 AAD B2C 标识提供者。 字符串
type 标识提供者类型标识符。 “aad”
“aadB2C”
“facebook”
“google”
“microsoft”
“twitter”