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

Microsoft.ApiManagement service/authorizationServers 2023-03-01-preview

项目
01/18/2024

Bicep 资源定义

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

资源组 - 请参阅资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

属性值

service/authorizationServers

名称	说明	值
name	资源名称了解如何在 Bicep 中设置子资源的名称和类型。	字符串 (必需) 字符限制：1-80 有效字符：字母数字和连字符。以字母开头且以字母数字结尾。
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。仅当子资源在父资源外部声明时，才需要添加此属性。有关详细信息，请参阅父资源之外的子资源。	类型为：service 的资源的符号名称
properties	外部 OAuth 授权服务器协定的属性。	AuthorizationServerContractProperties

AuthorizationServerContractProperties

名称	说明	值
authorizationEndpoint	OAuth 授权终结点。请参见`http://tools.ietf.org/html/rfc6749#section-3.2.`	字符串 (必需)
authorizationMethods	授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。	包含任何一项的字符串数组： 'DELETE' 'GET' “HEAD” 'OPTIONS' 'PATCH' “POST” 'PUT' 'TRACE'
bearerTokenSendingMethods	指定用于向 API 传递访问令牌的机制。	包含任何一项的字符串数组： “authorizationHeader” 'query'
clientAuthenticationMethod	此授权服务器的令牌终结点支持的身份验证方法。可能的值为 Basic 和/或 Body。指定 Body 时，客户端凭据和其他参数以 application/x-www-form-urlencoded 格式在请求正文中传递。	包含任何一项的字符串数组： 'Basic' “Body”
clientId	已注册到此授权服务器的客户端或应用程序 ID。	字符串 (必需)
clientRegistrationEndpoint	对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。包含所引用实体的绝对 URL。	字符串 (必需)
clientSecret	已注册到此授权服务器的客户端或应用程序机密。此属性不会在“GET”操作上填充！使用“/listSecrets”POST 请求获取值。	字符串
defaultScope	将按默认请求的访问令牌作用域。可以在 API 级别重写。应以包含空格分隔值的字符串形式提供。	字符串
description	授权服务器的说明。可以包含采用 HTML 格式的标记。	字符串
displayName	用户友好的授权服务器名称。	字符串 (必需)
grantTypes	授权的形式，客户端使用该授权请求访问令牌。	包含任何一项的字符串数组： “authorizationCode” 'clientCredentials' 'implicit' “resourceOwnerPassword” (必需)
resourceOwnerPassword	当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。默认的资源所有者密码。	字符串
resourceOwnerUsername	当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。默认的资源所有者用户名。	字符串
supportState	如果为 true，则授权服务器会将授权请求中的状态参数包含到其响应中。客户端可以使用状态参数来引发协议安全性。	bool
tokenBodyParameters	此授权服务器的令牌终结点所需的其他参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name” ： “name value”， “value”： “a value”}。	TokenBodyParameterContract[]
tokenEndpoint	OAuth 令牌终结点。包含所引用实体的绝对 URI。	字符串
useInApiDocumentation	如果为 true，则将在开发人员门户的 API 文档中使用授权服务器。如果未提供任何值，则默认为 False。	bool
useInTestConsole	如果为 true，可以在开发人员门户测试控制台中使用授权服务器。如果未提供任何值，则默认为 True。	bool

TokenBodyParameterContract

名称	说明	值
name	正文参数名称。	字符串 (必需)
value	body 参数值。	字符串 (必需)

ARM 模板资源定义

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

资源组 - 请参阅资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

属性值

service/authorizationServers

名称	说明	Value
type	资源类型	“Microsoft.ApiManagement/service/authorizationServers”
apiVersion	资源 API 版本	“2023-03-01-preview”
name	资源名称了解如何在 JSON ARM 模板中设置子资源的名称和类型。	字符串 (必需) 字符限制：1-80 有效字符：字母数字和连字符。以字母开头且以字母数字结尾。
properties	外部 OAuth 授权服务器协定的属性。	AuthorizationServerContractProperties

AuthorizationServerContractProperties

名称	说明	值
authorizationEndpoint	OAuth 授权终结点。请参见`http://tools.ietf.org/html/rfc6749#section-3.2.`	字符串 (必需)
authorizationMethods	授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。	包含任何一项的字符串数组： 'DELETE' 'GET' “HEAD” 'OPTIONS' 'PATCH' “POST” 'PUT' 'TRACE'
bearerTokenSendingMethods	指定用于向 API 传递访问令牌的机制。	包含任何一项的字符串数组： “authorizationHeader” 'query'
clientAuthenticationMethod	此授权服务器的令牌终结点支持的身份验证方法。可能的值为 Basic 和/或 Body。指定 Body 时，客户端凭据和其他参数以 application/x-www-form-urlencoded 格式在请求正文中传递。	包含任何一项的字符串数组： “Basic” “Body”
clientId	已注册到此授权服务器的客户端或应用程序 ID。	字符串 (必需)
clientRegistrationEndpoint	对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。包含所引用实体的绝对 URL。	字符串 (必需)
clientSecret	已注册到此授权服务器的客户端或应用程序机密。此属性不会在“GET”操作上填充！使用“/listSecrets”POST 请求获取值。	字符串
defaultScope	将按默认请求的访问令牌作用域。可以在 API 级别重写。应以包含空格分隔值的字符串形式提供。	字符串
description	授权服务器的说明。可以包含采用 HTML 格式的标记。	字符串
displayName	用户友好的授权服务器名称。	字符串 (必需)
grantTypes	授权的形式，客户端使用该授权请求访问令牌。	包含任意项的字符串数组： “authorizationCode” “clientCredentials” “implicit” “resourceOwnerPassword” (必需)
resourceOwnerPassword	当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。默认的资源所有者密码。	字符串
resourceOwnerUsername	当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。默认的资源所有者用户名。	字符串
supportState	如果为 true，授权服务器将包含授权请求中对其响应的状态参数。客户端可以使用状态参数来引发协议安全性。	bool
tokenBodyParameters	此授权服务器的令牌终结点所需的其他参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name” ： “name value”， “value”： “a value”}。	TokenBodyParameterContract[]
tokenEndpoint	OAuth 令牌终结点。包含所引用实体的绝对 URI。	字符串
useInApiDocumentation	如果为 true，则将在开发人员门户的 API 文档中使用授权服务器。如果未提供任何值，则默认为 False。	bool
useInTestConsole	如果为 true，可以在开发人员门户测试控制台中使用授权服务器。如果未提供任何值，则默认为 True。	bool

TokenBodyParameterContract

名称	说明	值
name	body 参数名称。	字符串 (必需)
value	body 参数值。	字符串 (必需)

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

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

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

属性值

service/authorizationServers

名称	说明	Value
type	资源类型	“Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview”
name	资源名称	字符串 (必需) 字符限制：1-80 有效字符：字母数字和连字符。以字母开头且以字母数字结尾。
parent_id	此资源的父资源 ID。	类型为“服务”的资源的 ID
properties	外部 OAuth 授权服务器协定的属性。	AuthorizationServerContractProperties

AuthorizationServerContractProperties

名称	说明	值
authorizationEndpoint	OAuth 授权终结点。请参见`http://tools.ietf.org/html/rfc6749#section-3.2.`	字符串 (必需)
authorizationMethods	授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。	包含任何一项的字符串数组： "DELETE" "GET" "HEAD" “OPTIONS” "PATCH" “POST” "PUT" “TRACE”
bearerTokenSendingMethods	指定用于向 API 传递访问令牌的机制。	包含任何一项的字符串数组： “authorizationHeader” “query”
clientAuthenticationMethod	此授权服务器的令牌终结点支持的身份验证方法。可能的值为 Basic 和/或 Body。指定 Body 时，客户端凭据和其他参数以 application/x-www-form-urlencoded 格式在请求正文中传递。	包含任何一项的字符串数组： "Basic" “正文”
clientId	已注册到此授权服务器的客户端或应用程序 ID。	字符串 (必需)
clientRegistrationEndpoint	对执行此授权服务器的客户端或应用程序注册时所在页的可选引用。包含所引用实体的绝对 URL。	字符串 (必需)
clientSecret	已注册到此授权服务器的客户端或应用程序机密。此属性不会在“GET”操作上填充！使用“/listSecrets”POST 请求获取值。	字符串
defaultScope	将按默认请求的访问令牌作用域。可以在 API 级别重写。应以包含空格分隔值的字符串形式提供。	字符串
description	授权服务器的说明。可以包含采用 HTML 格式的标记。	字符串
displayName	用户友好的授权服务器名称。	字符串 (必需)
grantTypes	授权的形式，客户端使用该授权请求访问令牌。	包含任何一项的字符串数组： “authorizationCode” “clientCredentials” “implicit” “resourceOwnerPassword” (必需)
resourceOwnerPassword	当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。默认的资源所有者密码。	字符串
resourceOwnerUsername	当此授权服务器支持资源所有者密码授权类型时，可以根据需要指定。默认的资源所有者用户名。	字符串
supportState	如果为 true，则授权服务器会将授权请求中的状态参数包含到其响应中。客户端可以使用状态参数来引发协议安全性。	bool
tokenBodyParameters	此授权服务器的令牌终结点所需的其他参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name” ： “name value”， “value”： “a value”}。	TokenBodyParameterContract[]
tokenEndpoint	OAuth 令牌终结点。包含所引用实体的绝对 URI。	字符串
useInApiDocumentation	如果为 true，则将在开发人员门户的 API 文档中使用授权服务器。如果未提供任何值，则默认为 False。	bool
useInTestConsole	如果为 true，可以在开发人员门户测试控制台中使用授权服务器。如果未提供任何值，则默认为 True。	bool

TokenBodyParameterContract

名称	说明	值
name	正文参数名称。	字符串 (必需)
value	body 参数值。	字符串 (必需)

Share via

Microsoft.ApiManagement service/authorizationServers 2023-03-01-preview

Bicep 资源定义

资源格式

属性值

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

ARM 模板资源定义

资源格式

属性值

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

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

资源格式

属性值

service/authorizationServers

AuthorizationServerContractProperties

TokenBodyParameterContract

其他资源