通过

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

Microsoft.ApiManagement 服务/authorizationServers 2018-01-01

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2018-01-01' = {
  parent: resourceSymbolicName
  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'
  }
}

属性值

AuthorizationServerContractProperties

名字 描述 价值
authorizationEndpoint OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2。 string （必需）
authorizationMethods 授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。 包含任一项的字符串数组：
“DELETE”
“GET”
“HEAD”
“OPTIONS”
“PATCH”
“POST”
“PUT”
“TRACE”
bearerTokenSendingMethods 指定将访问令牌传递给 API 的机制。 包含任一项的字符串数组：
“authorizationHeader”
“query”
clientAuthenticationMethod 此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定正文时，客户端凭据和其他参数在 application/x-www-form-urlencoded 格式的请求正文中传递。 包含任一项的字符串数组：
“Basic”
“Body”
clientId 向此授权服务器注册的客户端或应用 ID。 string （必需）
clientRegistrationEndpoint 对执行此授权服务器的客户端或应用注册的页面的可选引用。 包含所引用实体的绝对 URL。 string （必需）
clientSecret 向此授权服务器注册的客户端或应用机密。 字符串
defaultScope 默认情况下将请求的访问令牌范围。 可以在 API 级别重写。 应以包含空格分隔值的字符串的形式提供。 字符串
描述 授权服务器的说明。 可以包含 HTML 格式标记。 字符串
displayName 用户友好的授权服务器名称。 字符串

约束：
最小长度 = 1
最大长度 = 50 （必需）
grantTypes 客户端用来请求访问令牌的授权形式。 包含任一项的字符串数组：
“authorizationCode”
“clientCredentials”
“implicit”
“resourceOwnerPassword”（必需）
resourceOwnerPassword 当此授权服务器支持资源所有者密码授予类型时，可以选择指定。 默认资源所有者密码。 字符串
resourceOwnerUsername 当此授权服务器支持资源所有者密码授予类型时，可以选择指定。 默认资源所有者用户名。 字符串
supportState 如果为 true，授权服务器将包含授权请求到其响应的状态参数。 客户端可以使用状态参数提高协议安全性。 bool
tokenBodyParameters 此授权服务器的令牌终结点所需的附加参数，这些参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name”： “name value”， “value”： “a value”}。 TokenBodyParameterContract[]
tokenEndpoint OAuth 令牌终结点。 包含所引用实体的绝对 URI。 字符串

Microsoft.ApiManagement/service/authorizationServers

名字 描述 价值
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 80
模式 = (^[\w]+$)|(^[\w][\w\-]+[\w]$) （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：服务
性能 外部 OAuth 授权服务器协定的属性。 AuthorizationServerContractProperties

TokenBodyParameterContract

名字 描述 价值
名字 body 参数名称。 string （必需）
价值 body 参数值。 string （必需）

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2018-01-01",
  "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"
  }
}

属性值

AuthorizationServerContractProperties

名字 描述 价值
authorizationEndpoint OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2。 string （必需）
authorizationMethods 授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。 包含任一项的字符串数组：
“DELETE”
“GET”
“HEAD”
“OPTIONS”
“PATCH”
“POST”
“PUT”
“TRACE”
bearerTokenSendingMethods 指定将访问令牌传递给 API 的机制。 包含任一项的字符串数组：
“authorizationHeader”
“query”
clientAuthenticationMethod 此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定正文时，客户端凭据和其他参数在 application/x-www-form-urlencoded 格式的请求正文中传递。 包含任一项的字符串数组：
“Basic”
“Body”
clientId 向此授权服务器注册的客户端或应用 ID。 string （必需）
clientRegistrationEndpoint 对执行此授权服务器的客户端或应用注册的页面的可选引用。 包含所引用实体的绝对 URL。 string （必需）
clientSecret 向此授权服务器注册的客户端或应用机密。 字符串
defaultScope 默认情况下将请求的访问令牌范围。 可以在 API 级别重写。 应以包含空格分隔值的字符串的形式提供。 字符串
描述 授权服务器的说明。 可以包含 HTML 格式标记。 字符串
displayName 用户友好的授权服务器名称。 字符串

约束：
最小长度 = 1
最大长度 = 50 （必需）
grantTypes 客户端用来请求访问令牌的授权形式。 包含任一项的字符串数组：
“authorizationCode”
“clientCredentials”
“implicit”
“resourceOwnerPassword”（必需）
resourceOwnerPassword 当此授权服务器支持资源所有者密码授予类型时，可以选择指定。 默认资源所有者密码。 字符串
resourceOwnerUsername 当此授权服务器支持资源所有者密码授予类型时，可以选择指定。 默认资源所有者用户名。 字符串
supportState 如果为 true，授权服务器将包含授权请求到其响应的状态参数。 客户端可以使用状态参数提高协议安全性。 bool
tokenBodyParameters 此授权服务器的令牌终结点所需的附加参数，这些参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name”： “name value”， “value”： “a value”}。 TokenBodyParameterContract[]
tokenEndpoint OAuth 令牌终结点。 包含所引用实体的绝对 URI。 字符串

Microsoft.ApiManagement/service/authorizationServers

名字 描述 价值
apiVersion API 版本 '2018-01-01'
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 80
模式 = (^[\w]+$)|(^[\w][\w\-]+[\w]$) （必需）
性能 外部 OAuth 授权服务器协定的属性。 AuthorizationServerContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/authorizationServers”

TokenBodyParameterContract

名字 描述 价值
名字 body 参数名称。 string （必需）
价值 body 参数值。 string （必需）

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2018-01-01"
  name = "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"
    }
  })
}

属性值

AuthorizationServerContractProperties

名字 描述 价值
authorizationEndpoint OAuth 授权终结点。 请参阅 http://tools.ietf.org/html/rfc6749#section-3.2。 string （必需）
authorizationMethods 授权终结点支持的 HTTP 谓词。 GET 必须始终存在。 POST 是可选的。 包含任一项的字符串数组：
“DELETE”
“GET”
“HEAD”
“OPTIONS”
“PATCH”
“POST”
“PUT”
“TRACE”
bearerTokenSendingMethods 指定将访问令牌传递给 API 的机制。 包含任一项的字符串数组：
“authorizationHeader”
“query”
clientAuthenticationMethod 此授权服务器的令牌终结点支持的身份验证方法。 可能的值为 Basic 和/或 Body。 指定正文时，客户端凭据和其他参数在 application/x-www-form-urlencoded 格式的请求正文中传递。 包含任一项的字符串数组：
“Basic”
“Body”
clientId 向此授权服务器注册的客户端或应用 ID。 string （必需）
clientRegistrationEndpoint 对执行此授权服务器的客户端或应用注册的页面的可选引用。 包含所引用实体的绝对 URL。 string （必需）
clientSecret 向此授权服务器注册的客户端或应用机密。 字符串
defaultScope 默认情况下将请求的访问令牌范围。 可以在 API 级别重写。 应以包含空格分隔值的字符串的形式提供。 字符串
描述 授权服务器的说明。 可以包含 HTML 格式标记。 字符串
displayName 用户友好的授权服务器名称。 字符串

约束：
最小长度 = 1
最大长度 = 50 （必需）
grantTypes 客户端用来请求访问令牌的授权形式。 包含任一项的字符串数组：
“authorizationCode”
“clientCredentials”
“implicit”
“resourceOwnerPassword”（必需）
resourceOwnerPassword 当此授权服务器支持资源所有者密码授予类型时，可以选择指定。 默认资源所有者密码。 字符串
resourceOwnerUsername 当此授权服务器支持资源所有者密码授予类型时，可以选择指定。 默认资源所有者用户名。 字符串
supportState 如果为 true，授权服务器将包含授权请求到其响应的状态参数。 客户端可以使用状态参数提高协议安全性。 bool
tokenBodyParameters 此授权服务器的令牌终结点所需的附加参数，这些参数表示为具有名称和值字符串属性的 JSON 对象数组，即 {“name”： “name value”， “value”： “a value”}。 TokenBodyParameterContract[]
tokenEndpoint OAuth 令牌终结点。 包含所引用实体的绝对 URI。 字符串

Microsoft.ApiManagement/service/authorizationServers

名字 描述 价值
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 80
模式 = (^[\w]+$)|(^[\w][\w\-]+[\w]$) （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：服务
性能 外部 OAuth 授权服务器协定的属性。 AuthorizationServerContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/authorizationServers@2018-01-01”

TokenBodyParameterContract

名字 描述 价值
名字 body 参数名称。 string （必需）
价值 body 参数值。 string （必需）