Compartilhar via


Microsoft.CustomProviders resourceProviders

Definição de recurso do Bicep

O tipo de recurso resourceProviders pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.CustomProviders/resourceProviders, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.CustomProviders/resourceProviders@2018-09-01-preview' = {
  scope: resourceSymbolicName or scope
  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'
  }
}

Valores da propriedade

Microsoft.CustomProviders/resourceProviders

Nome Descrição Valor
local Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 64 (obrigatório)
Propriedades O manifesto do provedor de recursos personalizado CustomRPManifestProperties
escopo Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

CustomRPActionRouteDefinition

Nome Descrição Valor
ponto de extremidade O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}') corda

Restrições:
Padrão = ^https://.+ (obrigatório)
nome O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') cadeia de caracteres (obrigatório)
tipo de roteamento Os tipos de roteamento com suporte para solicitações de ação. 'Procuração'

CustomRPManifestProperties

Nome Descrição Valor
Ações Uma lista de ações que o provedor de recursos personalizado implementa. CustomRPActionRouteDefinition []
tipos de recursos Uma lista de tipos de recursos que o provedor de recursos personalizado implementa. CustomRPResourceTypeRouteDefinition []
Validações Uma lista de validações a serem executadas nas solicitações do provedor de recursos personalizado. customRPValidations[]

CustomRPResourceTypeRouteDefinition

Nome Descrição Valor
ponto de extremidade O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}') corda

Restrições:
Padrão = ^https://.+ (obrigatório)
nome O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') cadeia de caracteres (obrigatório)
tipo de roteamento Os tipos de roteamento com suporte para solicitações de recursos. 'Procuração'
'Proxy,Cache'

CustomRPValidations

Nome Descrição Valor
especificação Um link para a especificação de validação. A especificação deve ser hospedada no raw.githubusercontent.com. corda

Restrições:
Padrão = ^https://raw.githubusercontent.com/.+ (obrigatório)
tipoDeValidação O tipo de validação a ser executado em uma solicitação correspondente. 'Arrogância'

Tags de recursos

Nome Descrição Valor

Definição de recurso de modelo do ARM

O tipo de recurso resourceProviders pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.CustomProviders/resourceProviders, adicione o JSON a seguir ao modelo.

{
  "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"
  }
}

Valores da propriedade

Microsoft.CustomProviders/resourceProviders

Nome Descrição Valor
apiVersion A versão da API '2018-09-01-preview'
local Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 64 (obrigatório)
Propriedades O manifesto do provedor de recursos personalizado CustomRPManifestProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.CustomProviders/resourceProviders'

CustomRPActionRouteDefinition

Nome Descrição Valor
ponto de extremidade O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}') corda

Restrições:
Padrão = ^https://.+ (obrigatório)
nome O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') cadeia de caracteres (obrigatório)
tipo de roteamento Os tipos de roteamento com suporte para solicitações de ação. 'Procuração'

CustomRPManifestProperties

Nome Descrição Valor
Ações Uma lista de ações que o provedor de recursos personalizado implementa. CustomRPActionRouteDefinition []
tipos de recursos Uma lista de tipos de recursos que o provedor de recursos personalizado implementa. CustomRPResourceTypeRouteDefinition []
Validações Uma lista de validações a serem executadas nas solicitações do provedor de recursos personalizado. customRPValidations[]

CustomRPResourceTypeRouteDefinition

Nome Descrição Valor
ponto de extremidade O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}') corda

Restrições:
Padrão = ^https://.+ (obrigatório)
nome O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') cadeia de caracteres (obrigatório)
tipo de roteamento Os tipos de roteamento com suporte para solicitações de recursos. 'Procuração'
'Proxy,Cache'

CustomRPValidations

Nome Descrição Valor
especificação Um link para a especificação de validação. A especificação deve ser hospedada no raw.githubusercontent.com. corda

Restrições:
Padrão = ^https://raw.githubusercontent.com/.+ (obrigatório)
tipoDeValidação O tipo de validação a ser executado em uma solicitação correspondente. 'Arrogância'

Tags de recursos

Nome Descrição Valor

Exemplos de uso

Modelos de início rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
criar um recurso personalizado para modelos com provedores personalizados

Implantar no Azure
Este exemplo mostra como adicionar recursos personalizados aos Modelos do Resource Manager usando provedores personalizados e aplicativos lógicos.
Criar um aplicativo de funções e chamá-lo usando um recurso personalizado

Implantar no Azure
Esse modelo cria o aplicativo de funções usado como carga de trabalho para um provedor de recursos personalizado em uma implantação de modelo.
estender recursos existentes do Azure com provedores personalizados

Implantar no Azure
Este exemplo entrará em detalhes sobre como estender os recursos existentes do Azure e modelos do Resource Manager para adicionar cargas de trabalho personalizadas.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso resourceProviders pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.CustomProviders/resourceProviders, adicione o Terraform a seguir ao modelo.

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

Valores da propriedade

Microsoft.CustomProviders/resourceProviders

Nome Descrição Valor
local Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 64 (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades O manifesto do provedor de recursos personalizado CustomRPManifestProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"

CustomRPActionRouteDefinition

Nome Descrição Valor
ponto de extremidade O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}') corda

Restrições:
Padrão = ^https://.+ (obrigatório)
nome O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') cadeia de caracteres (obrigatório)
tipo de roteamento Os tipos de roteamento com suporte para solicitações de ação. 'Procuração'

CustomRPManifestProperties

Nome Descrição Valor
Ações Uma lista de ações que o provedor de recursos personalizado implementa. CustomRPActionRouteDefinition []
tipos de recursos Uma lista de tipos de recursos que o provedor de recursos personalizado implementa. CustomRPResourceTypeRouteDefinition []
Validações Uma lista de validações a serem executadas nas solicitações do provedor de recursos personalizado. customRPValidations[]

CustomRPResourceTypeRouteDefinition

Nome Descrição Valor
ponto de extremidade O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado será solicitado por proxy. Isso pode estar na forma de um URI simples (por exemplo, 'https://testendpoint/') ou pode especificar para rotear por meio de um caminho (por exemplo, 'https://testendpoint/{requestPath}') corda

Restrições:
Padrão = ^https://.+ (obrigatório)
nome O nome da definição da rota. Isso se torna o nome da extensão do ARM (por exemplo, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') cadeia de caracteres (obrigatório)
tipo de roteamento Os tipos de roteamento com suporte para solicitações de recursos. 'Procuração'
'Proxy,Cache'

CustomRPValidations

Nome Descrição Valor
especificação Um link para a especificação de validação. A especificação deve ser hospedada no raw.githubusercontent.com. corda

Restrições:
Padrão = ^https://raw.githubusercontent.com/.+ (obrigatório)
tipoDeValidação O tipo de validação a ser executado em uma solicitação correspondente. 'Arrogância'

Tags de recursos

Nome Descrição Valor

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Provedor Personalizado do Azure.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "resourceProvider" {
  type      = "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      resourceTypes = [
        {
          endpoint    = "https://example.com/"
          name        = "dEf1"
          routingType = "Proxy"
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}