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

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

Bicep 资源定义

service/authorizationProviders/authorizations 资源类型可以通过针对以下操作进行部署:

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

资源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders/authorizations@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authorizationType: 'OAuth2'
    error: {
      code: 'string'
      message: 'string'
    }
    oauth2grantType: 'string'
    parameters: {
      {customized property}: 'string'
    }
    status: 'string'
  }
}

属性值

service/authorizationProviders/authorizations

名称 说明
name 资源名称

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

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

AuthorizationContractProperties

名称 说明
authorizationType 授权类型选项 “OAuth2”
error 授权错误详细信息。 AuthorizationError
oauth2grantType OAuth2 授权类型选项 “AuthorizationCode”
“ClientCredentials”
parameters 授权参数 AuthorizationContractPropertiesParameters
status 授权的状态 字符串

AuthorizationError

名称 说明
code 错误代码 字符串
message 错误消息 字符串

AuthorizationContractPropertiesParameters

名称 说明
{customized property} 字符串

ARM 模板资源定义

service/authorizationProviders/authorizations 资源类型可以通过针对以下操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "authorizationType": "OAuth2",
    "error": {
      "code": "string",
      "message": "string"
    },
    "oauth2grantType": "string",
    "parameters": {
      "{customized property}": "string"
    },
    "status": "string"
  }
}

属性值

service/authorizationProviders/authorizations

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

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

AuthorizationContractProperties

名称 说明
authorizationType 授权类型选项 “OAuth2”
error 授权错误详细信息。 AuthorizationError
oauth2grantType OAuth2 授权类型选项 “AuthorizationCode”
“ClientCredentials”
parameters 授权参数 AuthorizationContractPropertiesParameters
status 授权的状态 字符串

AuthorizationError

名称 说明
code 错误代码 字符串
message 错误消息 字符串

AuthorizationContractPropertiesParameters

名称 说明
{customized property} 字符串

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

service/authorizationProviders/authorizations 资源类型可以通过针对以下操作进行部署:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders/authorizations@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authorizationType = "OAuth2"
      error = {
        code = "string"
        message = "string"
      }
      oauth2grantType = "string"
      parameters = {
        {customized property} = "string"
      }
      status = "string"
    }
  })
}

属性值

service/authorizationProviders/authorizations

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

AuthorizationContractProperties

名称 说明
authorizationType 授权类型选项 “OAuth2”
error 授权错误详细信息。 AuthorizationError
oauth2grantType OAuth2 授权类型选项 “AuthorizationCode”
“ClientCredentials”
parameters 授权参数 AuthorizationContractPropertiesParameters
status 授权的状态 字符串

AuthorizationError

名称 说明
code 错误代码 字符串
message 错误消息 字符串

AuthorizationContractPropertiesParameters

名称 说明
{customized property} 字符串