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

Microsoft.CustomProviders resourceProviders

Bicep 资源定义

可以使用目标操作部署 resourceProviders 资源类型:

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

资源格式

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

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

属性值

CustomRPActionRouteDefinition

名字 描述 价值
端点 自定义资源提供程序将向其代理请求的路由定义终结点 URI。 这可以采用平面 URI(例如“https://testendpoint/”)的形式,也可以指定通过路径路由(例如“https://testendpoint/{requestPath}”) 字符串

约束:
模式 = ^https://.+ (必需)
名字 路由定义的名称。 这将成为 ARM 扩展的名称(例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') string (必需)
routingType 操作请求支持的路由类型。 “Proxy”

CustomRPManifestProperties

名字 描述 价值
行动 自定义资源提供程序实现的操作列表。 CustomRPActionRouteDefinition[]
resourceTypes 自定义资源提供程序实现的资源类型的列表。 CustomRPResourceTypeRouteDefinition[]
验证 要针对自定义资源提供程序的请求运行的验证列表。 CustomRPValidations[]

CustomRPResourceTypeRouteDefinition

名字 描述 价值
端点 自定义资源提供程序将向其代理请求的路由定义终结点 URI。 这可以采用平面 URI(例如“https://testendpoint/”)的形式,也可以指定通过路径路由(例如“https://testendpoint/{requestPath}”) 字符串

约束:
模式 = ^https://.+ (必需)
名字 路由定义的名称。 这将成为 ARM 扩展的名称(例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') string (必需)
routingType 资源请求支持的路由类型。 “Proxy”
“Proxy,Cache”

CustomRPValidations

名字 描述 价值
规范 指向验证规范的链接。 规范必须托管在 raw.githubusercontent.com 上。 字符串

约束:
模式 = ^https://raw.githubusercontent.com/.+ (必需)
validationType 要针对匹配请求运行的验证类型。 “Swagger”

Microsoft.CustomProviders/resourceProviders

名字 描述 价值
位置 资源位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 64 (必需)
性能 自定义资源提供程序的清单 CustomRPManifestProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字 描述 价值

ARM 模板资源定义

可以使用目标操作部署 resourceProviders 资源类型:

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

资源格式

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

{
  "type": "Microsoft.CustomProviders/resourceProviders",
  "apiVersion": "2018-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "string"
      }
    ],
    "resourceTypes": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "string"
      }
    ],
    "validations": [
      {
        "specification": "string",
        "validationType": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

CustomRPActionRouteDefinition

名字 描述 价值
端点 自定义资源提供程序将向其代理请求的路由定义终结点 URI。 这可以采用平面 URI(例如“https://testendpoint/”)的形式,也可以指定通过路径路由(例如“https://testendpoint/{requestPath}”) 字符串

约束:
模式 = ^https://.+ (必需)
名字 路由定义的名称。 这将成为 ARM 扩展的名称(例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') string (必需)
routingType 操作请求支持的路由类型。 “Proxy”

CustomRPManifestProperties

名字 描述 价值
行动 自定义资源提供程序实现的操作列表。 CustomRPActionRouteDefinition[]
resourceTypes 自定义资源提供程序实现的资源类型的列表。 CustomRPResourceTypeRouteDefinition[]
验证 要针对自定义资源提供程序的请求运行的验证列表。 CustomRPValidations[]

CustomRPResourceTypeRouteDefinition

名字 描述 价值
端点 自定义资源提供程序将向其代理请求的路由定义终结点 URI。 这可以采用平面 URI(例如“https://testendpoint/”)的形式,也可以指定通过路径路由(例如“https://testendpoint/{requestPath}”) 字符串

约束:
模式 = ^https://.+ (必需)
名字 路由定义的名称。 这将成为 ARM 扩展的名称(例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') string (必需)
routingType 资源请求支持的路由类型。 “Proxy”
“Proxy,Cache”

CustomRPValidations

名字 描述 价值
规范 指向验证规范的链接。 规范必须托管在 raw.githubusercontent.com 上。 字符串

约束:
模式 = ^https://raw.githubusercontent.com/.+ (必需)
validationType 要针对匹配请求运行的验证类型。 “Swagger”

Microsoft.CustomProviders/resourceProviders

名字 描述 价值
apiVersion API 版本 '2018-09-01-preview'
位置 资源位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 64 (必需)
性能 自定义资源提供程序的清单 CustomRPManifestProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.CustomProviders/resourceProviders”

ResourceTags

名字 描述 价值

快速入门模板

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

模板 描述
使用自定义提供程序为模板创建自定义资源

部署到 Azure
此示例演示如何使用自定义提供程序和逻辑应用将自定义资源添加到资源管理器模板。
创建函数应用并使用自定义资源 调用它

部署到 Azure
此模板创建用作模板部署中自定义资源提供程序的工作负荷的函数应用。
使用自定义提供程序扩展现有 Azure 资源

部署到 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"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          endpoint = "string"
          name = "string"
          routingType = "string"
        }
      ]
      resourceTypes = [
        {
          endpoint = "string"
          name = "string"
          routingType = "string"
        }
      ]
      validations = [
        {
          specification = "string"
          validationType = "string"
        }
      ]
    }
  })
}

属性值

CustomRPActionRouteDefinition

名字 描述 价值
端点 自定义资源提供程序将向其代理请求的路由定义终结点 URI。 这可以采用平面 URI(例如“https://testendpoint/”)的形式,也可以指定通过路径路由(例如“https://testendpoint/{requestPath}”) 字符串

约束:
模式 = ^https://.+ (必需)
名字 路由定义的名称。 这将成为 ARM 扩展的名称(例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') string (必需)
routingType 操作请求支持的路由类型。 “Proxy”

CustomRPManifestProperties

名字 描述 价值
行动 自定义资源提供程序实现的操作列表。 CustomRPActionRouteDefinition[]
resourceTypes 自定义资源提供程序实现的资源类型的列表。 CustomRPResourceTypeRouteDefinition[]
验证 要针对自定义资源提供程序的请求运行的验证列表。 CustomRPValidations[]

CustomRPResourceTypeRouteDefinition

名字 描述 价值
端点 自定义资源提供程序将向其代理请求的路由定义终结点 URI。 这可以采用平面 URI(例如“https://testendpoint/”)的形式,也可以指定通过路径路由(例如“https://testendpoint/{requestPath}”) 字符串

约束:
模式 = ^https://.+ (必需)
名字 路由定义的名称。 这将成为 ARM 扩展的名称(例如'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') string (必需)
routingType 资源请求支持的路由类型。 “Proxy”
“Proxy,Cache”

CustomRPValidations

名字 描述 价值
规范 指向验证规范的链接。 规范必须托管在 raw.githubusercontent.com 上。 字符串

约束:
模式 = ^https://raw.githubusercontent.com/.+ (必需)
validationType 要针对匹配请求运行的验证类型。 “Swagger”

Microsoft.CustomProviders/resourceProviders

名字 描述 价值
位置 资源位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 64 (必需)
性能 自定义资源提供程序的清单 CustomRPManifestProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.CustomProviders/resourceProviders@2018-09-01-preview”

ResourceTags

名字 描述 价值