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

Microsoft.CustomProviders resourceProviders

项目
07/20/2023

Bicep 资源定义

resourceProviders 资源类型可以部署到：

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

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

资源格式

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

resource symbolicname 'Microsoft.CustomProviders/resourceProviders@2018-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'Proxy'
      }
    ]
    resourceTypes: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'string'
      }
    ]
    validations: [
      {
        specification: 'string'
        validationType: 'Swagger'
      }
    ]
  }
}

属性值

resourceProviders

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：3-64 有效字符：不得使用： `%&\\?/` 或控制字符不得以句点或空格结尾。
location	资源位置	字符串 (必需)
标记	资源标记	标记名称和值的字典。请参阅模板中的标记
properties	自定义资源提供程序的清单	CustomRPManifestProperties

CustomRPManifestProperties

名称	说明	值
actions	自定义资源提供程序实现的操作列表。	CustomRPActionRouteDefinition[]
resourceTypes	自定义资源提供程序实现的资源类型的列表。	CustomRPResourceTypeRouteDefinition[]
validations	要对自定义资源提供程序的请求运行的验证列表。	CustomRPValidations[]

CustomRPActionRouteDefinition

名称	说明	值
endpoint	自定义资源提供程序将向其代理请求的路由定义终结点 URI。这可以是平面 URI (例如“”https://testendpoint/) ，也可以指定通过路径 (例如“”https://testendpoint/{requestPath})	字符串 (必需)
name	路由定义的名称。这将成为 ARM 扩展的名称 (例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')	字符串 (必需)
routingType	操作请求支持的路由类型。	“Proxy”

CustomRPResourceTypeRouteDefinition

名称	说明	值
endpoint	自定义资源提供程序将向其代理请求的路由定义终结点 URI。这可以是平面 URI (例如“”https://testendpoint/) ，也可以指定通过路径 (例如“”https://testendpoint/{requestPath})	字符串 (必需)
name	路由定义的名称。这将成为 ARM 扩展的名称 (例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')	字符串 (必需)
routingType	资源请求支持的路由类型。	“Proxy” “Proxy，Cache”

CustomRPValidations

名称	说明	值
specification	验证规范的链接。规范必须托管在 raw.githubusercontent.com 上。	字符串 (必需)
validationType	要针对匹配请求运行的验证类型。	“Swagger”

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用自定义提供程序扩展现有 Azure 资源	此示例将详细介绍如何扩展现有 Azure 资源和资源管理器模板以添加到自定义工作负荷中。
创建函数应用并使用自定义资源调用它	此模板创建用作模板部署中自定义资源提供程序的工作负载的函数应用。
使用自定义提供程序为模板创建自定义资源	此示例演示如何使用自定义提供程序和逻辑应用将自定义资源添加到资源管理器模板。

ARM 模板资源定义

resourceProviders 资源类型可部署到：

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

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

资源格式

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

{
  "type": "Microsoft.CustomProviders/resourceProviders",
  "apiVersion": "2018-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "Proxy"
      }
    ],
    "resourceTypes": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "string"
      }
    ],
    "validations": [
      {
        "specification": "string",
        "validationType": "Swagger"
      }
    ]
  }
}

属性值

resourceProviders

名称	说明	Value
type	资源类型	'Microsoft.CustomProviders/resourceProviders'
apiVersion	资源 API 版本	“2018-09-01-preview”
name	资源名称	字符串 (必需) 字符限制：3-64 有效字符：不得使用： `%&\\?/` 或控制字符不得以句点或空格结尾。
location	资源位置	字符串 (必需)
标记	资源标记	标记名称和值的字典。请参阅模板中的标记
properties	自定义资源提供程序的清单	CustomRPManifestProperties

CustomRPManifestProperties

名称	说明	值
actions	自定义资源提供程序实现的操作列表。	CustomRPActionRouteDefinition[]
resourceTypes	自定义资源提供程序实现的资源类型的列表。	CustomRPResourceTypeRouteDefinition[]
validations	要对自定义资源提供程序的请求运行的验证列表。	CustomRPValidations[]

CustomRPActionRouteDefinition

名称	说明	值
endpoint	自定义资源提供程序将请求代理到的路由定义终结点 URI。这可以是平面 URI (例如“”https://testendpoint/) ，也可以指定通过路径 (路由，例如“”https://testendpoint/{requestPath})	字符串 (必需)
name	路由定义的名称。这将成为 ARM 扩展 (的名称，例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')	字符串 (必需)
routingType	操作请求支持的路由类型。	'Proxy'

CustomRPResourceTypeRouteDefinition

名称	说明	值
endpoint	自定义资源提供程序将请求代理到的路由定义终结点 URI。这可以是平面 URI (例如“”https://testendpoint/) ，也可以指定通过路径 (路由，例如“”https://testendpoint/{requestPath})	字符串 (必需)
name	路由定义的名称。这将成为 ARM 扩展 (的名称，例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')	字符串 (必需)
routingType	资源请求支持的路由类型。	'Proxy' 'Proxy，Cache'

CustomRPValidations

名称	说明	值
specification	指向验证规范的链接。规范必须托管在 raw.githubusercontent.com 上。	字符串 (必需)
validationType	要针对匹配请求运行的验证类型。	“Swagger”

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
使用自定义提供程序扩展现有 Azure 资源	此示例将详细介绍如何扩展现有 Azure 资源，以及如何资源管理器模板来添加自定义工作负载。
创建函数应用并使用自定义资源调用它	此模板创建用作模板部署中自定义资源提供程序的工作负载的函数应用。
使用自定义提供程序为模板创建自定义资源	此示例演示如何使用自定义提供程序和逻辑应用将自定义资源添加到资源管理器模板。

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

resourceProviders 资源类型可以部署到：

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          endpoint = "string"
          name = "string"
          routingType = "Proxy"
        }
      ]
      resourceTypes = [
        {
          endpoint = "string"
          name = "string"
          routingType = "string"
        }
      ]
      validations = [
        {
          specification = "string"
          validationType = "Swagger"
        }
      ]
    }
  })
}

属性值

resourceProviders

名称	说明	Value
type	资源类型	“Microsoft.CustomProviders/resourceProviders@2018-09-01-preview”
name	资源名称	字符串 (必需) 字符限制：3-64 有效字符：不得使用： `%&\\?/` 或控制字符不得以句点或空格结尾。
location	资源位置	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记	标记名称和值的字典。
properties	自定义资源提供程序的清单	CustomRPManifestProperties

CustomRPManifestProperties

名称	说明	值
actions	自定义资源提供程序实现的操作列表。	CustomRPActionRouteDefinition[]
resourceTypes	自定义资源提供程序实现的资源类型的列表。	CustomRPResourceTypeRouteDefinition[]
validations	要对自定义资源提供程序的请求运行的验证列表。	CustomRPValidations[]

CustomRPActionRouteDefinition

名称	说明	值
endpoint	自定义资源提供程序将向其代理请求的路由定义终结点 URI。这可以是平面 URI (例如“”https://testendpoint/) ，也可以指定通过路径 (例如“”https://testendpoint/{requestPath})	字符串 (必需)
name	路由定义的名称。这将成为 ARM 扩展的名称 (例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')	字符串 (必需)
routingType	操作请求支持的路由类型。	“Proxy”

CustomRPResourceTypeRouteDefinition

名称	说明	值
endpoint	自定义资源提供程序将向其代理请求的路由定义终结点 URI。这可以是平面 URI (例如“”https://testendpoint/) ，也可以指定通过路径 (例如“”https://testendpoint/{requestPath})	字符串 (必需)
name	路由定义的名称。这将成为 ARM 扩展的名称 (例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}')	字符串 (必需)
routingType	资源请求支持的路由类型。	“Proxy” “Proxy，Cache”

CustomRPValidations

名称	说明	值
specification	验证规范的链接。规范必须托管在 raw.githubusercontent.com 上。	字符串 (必需)
validationType	要针对匹配请求运行的验证类型。	“Swagger”

通过

Microsoft.CustomProviders resourceProviders

Bicep 资源定义

资源格式

属性值

resourceProviders

CustomRPManifestProperties

CustomRPActionRouteDefinition

CustomRPResourceTypeRouteDefinition

CustomRPValidations

快速入门模板

ARM 模板资源定义

资源格式

属性值

resourceProviders

CustomRPManifestProperties

CustomRPActionRouteDefinition

CustomRPResourceTypeRouteDefinition

CustomRPValidations

快速入门模板

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

资源格式

属性值

resourceProviders

CustomRPManifestProperties

CustomRPActionRouteDefinition

CustomRPResourceTypeRouteDefinition

CustomRPValidations

反馈

其他资源