Compartilhar via


Recurso Microsoft.CustomProvidersProviders

Definição de recurso do Bicep

O tipo de recurso resourceProviders pode ser implantado em:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte 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' = {
  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'
      }
    ]
  }
}

Valores de propriedade

resourceProviders

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

Limite de caracteres: 3-64

Caracteres válidos:
Não é possível usar:
%&\\?/ ou caracteres de controle

Não pode terminar com ponto ou espaço.
local Localização do recurso cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties O manifesto do provedor de recursos personalizado CustomRPManifestProperties

CustomRPManifestProperties

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

CustomRPActionRouteDefinition

Nome Descrição Valor
endpoint O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado solicitará 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}') cadeia de caracteres (obrigatório)
name O nome da definição de 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)
routingType Os tipos de roteamento com suporte para solicitações de ação. 'Proxy'

CustomRPResourceTypeRouteDefinition

Nome Descrição Valor
endpoint O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado solicitará 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}') cadeia de caracteres (obrigatório)
name O nome da definição de 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)
routingType Os tipos de roteamento com suporte para solicitações de recursos. 'Proxy'
'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. cadeia de caracteres (obrigatório)
Validationtype O tipo de validação a ser executado em uma solicitação correspondente. 'Swagger'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Estender recursos existentes do Azure com provedores personalizados

Implantar no Azure
Este exemplo detalhará como estender os recursos existentes do Azure e Resource Manager modelos para adicionar cargas de trabalho personalizadas.
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 a carga de trabalho para um provedor de recursos personalizado em uma implantação de modelo.
Criar um recurso personalizado para modelos com provedores personalizados

Implantar no Azure
Este exemplo mostra como adicionar recursos personalizados a modelos de Resource Manager usando provedores personalizados e aplicativos lógicos.

Definição de recurso de modelo do ARM

O tipo de recurso resourceProviders pode ser implantado em:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte 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",
  "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"
      }
    ]
  }
}

Valores de propriedade

resourceProviders

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.CustomProviders/resourceProviders'
apiVersion A versão da API de recursos '2018-09-01-preview'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 64

Caracteres válidos:
Não é possível usar:
%&\\?/ ou caracteres de controle

Não pode terminar com ponto ou espaço.
local Localização do recurso cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
properties O manifesto do provedor de recursos personalizado CustomRPManifestProperties

CustomRPManifestProperties

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

CustomRPActionRouteDefinition

Nome Descrição Valor
endpoint O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado solicitará 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}') cadeia de caracteres (obrigatório)
name O nome da definição de 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)
routingType Os tipos de roteamento com suporte para solicitações de ação. 'Proxy'

CustomRPResourceTypeRouteDefinition

Nome Descrição Valor
endpoint O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado solicitará 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}') cadeia de caracteres (obrigatório)
name O nome da definição de 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)
routingType Os tipos de roteamento com suporte para solicitações de recursos. 'Proxy'
'Proxy,Cache'

CustomRPValidations

Nome Descrição Valor
especificação Um link para a especificação de validação. A especificação deve ser hospedada em raw.githubusercontent.com. cadeia de caracteres (obrigatório)
Validationtype O tipo de validação a ser executado em uma solicitação correspondente. 'Swagger'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
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 Resource Manager modelos a serem adicionados em cargas de trabalho personalizadas.
Criar um aplicativo de funções e chamá-lo usando um recurso personalizado

Implantar no Azure
Este modelo cria o aplicativo de funções usado como a carga de trabalho para um provedor de recursos personalizado em uma implantação de modelo.
Criar um recurso personalizado para modelos com provedores personalizados

Implantar no Azure
Este exemplo mostra como adicionar recursos personalizados a modelos de Resource Manager usando provedores personalizados e aplicativos lógicos.

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

O tipo de recurso resourceProviders pode ser implantado em:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte 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"
  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"
        }
      ]
    }
  })
}

Valores de propriedade

resourceProviders

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 3 a 64

Caracteres válidos:
Não é possível usar:
%&\\?/ ou caracteres de controle

Não pode terminar com ponto ou espaço.
local Localização do recurso cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas.
properties O manifesto do provedor de recursos personalizado CustomRPManifestProperties

CustomRPManifestProperties

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

CustomRPActionRouteDefinition

Nome Descrição Valor
endpoint O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado solicitará 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}') cadeia de caracteres (obrigatório)
name O nome da definição de 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)
routingType Os tipos de roteamento com suporte para solicitações de ação. "Proxy"

CustomRPResourceTypeRouteDefinition

Nome Descrição Valor
endpoint O URI do ponto de extremidade de definição de rota para o qual o provedor de recursos personalizado solicitará 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}') cadeia de caracteres (obrigatório)
name O nome da definição de 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)
routingType Os tipos de roteamento com suporte para solicitações de recursos. "Proxy"
"Proxy, Cache"

CustomRPValidations

Nome Descrição Valor
especificação Um link para a especificação de validação. A especificação deve ser hospedada em raw.githubusercontent.com. cadeia de caracteres (obrigatório)
Validationtype O tipo de validação a ser executado em uma solicitação correspondente. "Swagger"