你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement service/authorizationProviders 2023-05-01-preview
Bicep 资源定义
可以使用目标操作部署服务/authorizationProviders 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/authorizationProviders 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
identityProvider: 'string'
oauth2: {
grantTypes: {
authorizationCode: {
{customized property}: 'string'
}
clientCredentials: {
{customized property}: 'string'
}
}
redirectUrl: 'string'
}
}
}
属性值
AuthorizationProviderContractProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| displayName | 授权提供程序名称。 长度必须为 1 到 300 个字符。 | 字符串 约束： 最小长度 = 1 最大长度 = 300 |
| identityProvider | 标识提供者名称。 长度必须为 1 到 300 个字符。 | 字符串 |
| oauth2 | OAuth2 设置 | AuthorizationProviderOAuth2Settings |
AuthorizationProviderOAuth2GrantTypes
| 名字 | 描述 | 价值 |
|---|---|---|
| authorizationCode | OAuth2 授权代码授予参数 | AuthorizationProviderOAuth2GrantTypesAuthorizationCode |
| clientCredentials | OAuth2 客户端凭据授予参数 | AuthorizationProviderOAuth2GrantTypesClientCredentials |
AuthorizationProviderOAuth2GrantTypesAuthorizationCode
| 名字 | 描述 | 价值 |
|---|
AuthorizationProviderOAuth2GrantTypesClientCredentials
| 名字 | 描述 | 价值 |
|---|
AuthorizationProviderOAuth2Settings
| 名字 | 描述 | 价值 |
|---|---|---|
| grantTypes | OAuth2 设置 | AuthorizationProviderOAuth2GrantTypes |
| redirectUrl | 要设置在 OAuth 应用程序中的重定向 URL。 | 字符串 |
Microsoft.ApiManagement/service/authorizationProviders
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 256 模式 = ^[^*#&+:<>?]+$ （必需） |
| 父母 | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。 |
类型资源的符号名称：服务 |
| 性能 | 授权提供程序协定的属性。 | AuthorizationProviderContractProperties |
ARM 模板资源定义
可以使用目标操作部署服务/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"
}
}
}
属性值
AuthorizationProviderContractProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| displayName | 授权提供程序名称。 长度必须为 1 到 300 个字符。 | 字符串 约束： 最小长度 = 1 最大长度 = 300 |
| identityProvider | 标识提供者名称。 长度必须为 1 到 300 个字符。 | 字符串 |
| oauth2 | OAuth2 设置 | AuthorizationProviderOAuth2Settings |
AuthorizationProviderOAuth2GrantTypes
| 名字 | 描述 | 价值 |
|---|---|---|
| authorizationCode | OAuth2 授权代码授予参数 | AuthorizationProviderOAuth2GrantTypesAuthorizationCode |
| clientCredentials | OAuth2 客户端凭据授予参数 | AuthorizationProviderOAuth2GrantTypesClientCredentials |
AuthorizationProviderOAuth2GrantTypesAuthorizationCode
| 名字 | 描述 | 价值 |
|---|
AuthorizationProviderOAuth2GrantTypesClientCredentials
| 名字 | 描述 | 价值 |
|---|
AuthorizationProviderOAuth2Settings
| 名字 | 描述 | 价值 |
|---|---|---|
| grantTypes | OAuth2 设置 | AuthorizationProviderOAuth2GrantTypes |
| redirectUrl | 要设置在 OAuth 应用程序中的重定向 URL。 | 字符串 |
Microsoft.ApiManagement/service/authorizationProviders
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2023-05-01-preview' |
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 256 模式 = ^[^*#&+:<>?]+$ （必需） |
| 性能 | 授权提供程序协定的属性。 | AuthorizationProviderContractProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/authorizationProviders” |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署服务/authorizationProviders 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/authorizationProviders 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
identityProvider = "string"
oauth2 = {
grantTypes = {
authorizationCode = {
{customized property} = "string"
}
clientCredentials = {
{customized property} = "string"
}
}
redirectUrl = "string"
}
}
})
}
属性值
AuthorizationProviderContractProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| displayName | 授权提供程序名称。 长度必须为 1 到 300 个字符。 | 字符串 约束： 最小长度 = 1 最大长度 = 300 |
| identityProvider | 标识提供者名称。 长度必须为 1 到 300 个字符。 | 字符串 |
| oauth2 | OAuth2 设置 | AuthorizationProviderOAuth2Settings |
AuthorizationProviderOAuth2GrantTypes
| 名字 | 描述 | 价值 |
|---|---|---|
| authorizationCode | OAuth2 授权代码授予参数 | AuthorizationProviderOAuth2GrantTypesAuthorizationCode |
| clientCredentials | OAuth2 客户端凭据授予参数 | AuthorizationProviderOAuth2GrantTypesClientCredentials |
AuthorizationProviderOAuth2GrantTypesAuthorizationCode
| 名字 | 描述 | 价值 |
|---|
AuthorizationProviderOAuth2GrantTypesClientCredentials
| 名字 | 描述 | 价值 |
|---|
AuthorizationProviderOAuth2Settings
| 名字 | 描述 | 价值 |
|---|---|---|
| grantTypes | OAuth2 设置 | AuthorizationProviderOAuth2GrantTypes |
| redirectUrl | 要设置在 OAuth 应用程序中的重定向 URL。 | 字符串 |
Microsoft.ApiManagement/service/authorizationProviders
| 名字 | 描述 | 价值 |
|---|---|---|
| 名字 | 资源名称 | 字符串 约束： 最小长度 = 1 最大长度 = 256 模式 = ^[^*#&+:<>?]+$ （必需） |
| parent_id | 此资源的父资源的 ID。 | 类型资源的 ID：服务 |
| 性能 | 授权提供程序协定的属性。 | AuthorizationProviderContractProperties |
| 类型 | 资源类型 | “Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview” |