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

Microsoft.ApiManagement service/authorizationProviders 2023-05-01-preview

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    displayName: 'string'
    identityProvider: 'string'
    oauth2: {
      grantTypes: {
        authorizationCode: {
          {customized property}: 'string'
        }
        clientCredentials: {
          {customized property}: 'string'
        }
      }
      redirectUrl: 'string'
    }
  }
}

属性值

service/authorizationProviders

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为:service 的资源的符号名称
properties 授权提供程序协定的属性。 AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

名称 说明
displayName 授权提供程序名称。 长度必须为 1 到 300 个字符。 字符串
identityProvider 标识提供者名称。 长度必须为 1 到 300 个字符。 字符串
oauth2 OAuth2 设置 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

名称 说明
grantTypes OAuth2 设置 AuthorizationProviderOAuth2GrantTypes
redirectUrl 在 OAuth 应用程序中设置的重定向 URL。 字符串

AuthorizationProviderOAuth2GrantTypes

名称 说明
authorizationCode OAuth2 授权代码授予参数 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials OAuth2 客户端凭据授予参数 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名称 说明
{customized property} 字符串

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名称 说明
{customized property} 字符串

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/authorizationProviders",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "identityProvider": "string",
    "oauth2": {
      "grantTypes": {
        "authorizationCode": {
          "{customized property}": "string"
        },
        "clientCredentials": {
          "{customized property}": "string"
        }
      },
      "redirectUrl": "string"
    }
  }
}

属性值

service/authorizationProviders

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

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)
properties 授权提供程序协定的属性。 AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

名称 说明
displayName 授权提供程序名称。 长度必须为 1 到 300 个字符。 字符串
identityProvider 标识提供者名称。 长度必须为 1 到 300 个字符。 字符串
oauth2 OAuth2 设置 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

名称 说明
grantTypes OAuth2 设置 AuthorizationProviderOAuth2GrantTypes
redirectUrl 要在 OAuth 应用程序中设置的重定向 URL。 字符串

AuthorizationProviderOAuth2GrantTypes

名称 说明
authorizationCode OAuth2 授权代码授予参数 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials OAuth2 客户端凭据授予参数 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名称 说明
{customized property} 字符串

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名称 说明
{customized property} 字符串

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

service/authorizationProviders 资源类型可以使用面向以下对象的操作进行部署:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      identityProvider = "string"
      oauth2 = {
        grantTypes = {
          authorizationCode = {
            {customized property} = "string"
          }
          clientCredentials = {
            {customized property} = "string"
          }
        }
        redirectUrl = "string"
      }
    }
  })
}

属性值

service/authorizationProviders

名称 说明 Value
type 资源类型 “Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为“服务”的资源的 ID
properties 授权提供程序协定的属性。 AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

名称 说明
displayName 授权提供程序名称。 长度必须为 1 到 300 个字符。 字符串
identityProvider 标识提供者名称。 长度必须为 1 到 300 个字符。 字符串
oauth2 OAuth2 设置 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

名称 说明
grantTypes OAuth2 设置 AuthorizationProviderOAuth2GrantTypes
redirectUrl 要在 OAuth 应用程序中设置的重定向 URL。 字符串

AuthorizationProviderOAuth2GrantTypes

名称 说明
authorizationCode OAuth2 授权代码授予参数 AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials OAuth2 客户端凭据授予参数 AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名称 说明
{customized property} 字符串

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名称 说明
{customized property} 字符串