Definição de recursos do bíceps
O tipo de recurso de conexões pode ser implantado com operações que visam:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Exemplos de uso
Exemplos de início rápido do Azure
Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.
| Arquivo Bicep |
Descrição |
|
Aplicativos Lógicos do Azure - AS2 Send Receive |
Cria contas de integração para dois parceiros, Contoso e Fabrikam, incluindo os artefatos para parceiros e contratos. O modelo também cria aplicativos lógicos entre a Fabrikam Sales e a Contoso para demonstrar o AS2 Send Receive síncrono. O modelo também cria aplicativos lógicos entre a Fabrikam Finance e a Contoso, que demonstram o AS2 Send Receive assíncrono. |
|
Copiar arquivos FTP para o aplicativo lógico de Blob do Azure |
Este modelo permite criar um acionador de aplicativo lógico em arquivos em um servidor FTP e copia-os para um contêiner de Blob do Azure. Você pode adicionar gatilhos ou ações adicionais para personalizá-lo de acordo com suas necessidades. |
|
Recuperar chaves de acesso do Armazenamento do Azure no modelo ARM |
Esse modelo criará uma conta de armazenamento, após a qual criará uma conexão de API recuperando dinamicamente a chave primária da conta de armazenamento. A conexão de API é então usada em um aplicativo lógico como uma sondagem de gatilho para alterações de blob. |
Para criar um recurso Microsoft.Web/connections, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Web/connections@2016-06-01' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
api: {
brandColor: 'string'
description: 'string'
displayName: 'string'
iconUri: 'string'
id: 'string'
name: 'string'
swagger: any(...)
type: 'string'
}
changedTime: 'string'
createdTime: 'string'
customParameterValues: {
{customized property}: 'string'
}
displayName: 'string'
nonSecretParameterValues: {
{customized property}: 'string'
}
parameterValues: {
{customized property}: 'string'
}
statuses: [
{
error: {
etag: 'string'
location: 'string'
properties: {
code: 'string'
message: 'string'
}
tags: {
{customized property}: 'string'
}
}
status: 'string'
target: 'string'
}
]
testLinks: [
{
method: 'string'
requestUri: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
Microsoft.Web/conexões
| Designação |
Descrição |
Valor |
| etag |
Recurso ETag |
cadeia (de caracteres) |
| localização |
Localização do recurso |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| propriedades |
|
ApiConnectionDefinitionProperties |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. Consulte Tags em modelos |
ApiConnectionDefinitionProperties
ApiConnectionDefinitionPropertiesCustomParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionDefinitionPropertiesNonSecretParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionDefinitionPropertiesParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionTestLink
| Designação |
Descrição |
Valor |
| método |
Método HTTP |
cadeia (de caracteres) |
| URI de pedido |
URI de solicitação de link de teste |
cadeia (de caracteres) |
ApiReference
| Designação |
Descrição |
Valor |
| marcaCor |
Cor da marca |
cadeia (de caracteres) |
| Descrição |
A descrição personalizada da API |
cadeia (de caracteres) |
| nome de exibição |
O nome para exibição |
cadeia (de caracteres) |
| iconUri |
O ícone URI |
cadeia (de caracteres) |
| ID |
ID de referência do recurso |
cadeia (de caracteres) |
| Designação |
O nome da API |
cadeia (de caracteres) |
| Gingado |
A representação JSON do swagger |
qualquer |
| tipo |
Tipo de referência de recurso |
cadeia (de caracteres) |
ConnectionError
| Designação |
Descrição |
Valor |
| etag |
Recurso ETag |
cadeia (de caracteres) |
| localização |
Localização do recurso |
cadeia (de caracteres) |
| propriedades |
|
ConnectionErrorProperties |
| Etiquetas |
Tags de recursos |
TagsDicionário: |
ConnectionErrorProperties
| Designação |
Descrição |
Valor |
| código |
Código do estatuto |
cadeia (de caracteres) |
| mensagem |
Descrição do estado |
cadeia (de caracteres) |
ConnectionStatusDefinition
| Designação |
Descrição |
Valor |
| erro |
Erro de conexão |
ConnectionError |
| estado |
O status do gateway |
cadeia (de caracteres) |
| destino |
Alvo do erro |
cadeia (de caracteres) |
| Designação |
Descrição |
Valor |
| Designação |
Descrição |
Valor |
Definição de recurso de modelo ARM
O tipo de recurso de conexões pode ser implantado com operações que visam:
Exemplos de uso
Modelos de início rápido do Azure
Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.
| Modelo |
Descrição |
Alerta para fila com o aplicativo lógico
|
Este modelo permite que você crie um aplicativo lógico que tenha um webhook. Quando o aplicativo lógico é acionado, ele adiciona a carga que você passa para uma fila de Armazenamento do Azure que você especificar. Você pode adicionar esse webhook a um Alerta do Azure e, sempre que o Alerta for acionado, você receberá esse item na fila. |
Alerta para o Slack com o aplicativo Logic
|
Este modelo permite que você crie um aplicativo lógico que tenha um webhook para ser usado a partir de um Alerta do Azure. Quando o Alerta for acionado, ele publicará uma mensagem em um canal de folga que você especificar. Você precisa ter uma conta folgada para usar esse modelo. |
Alerta para mensagem de texto com o aplicativo Logic
|
Este modelo permite que você crie um aplicativo lógico que tenha um webhook para ser usado a partir de um Alerta do Azure. Quando o Alerta for acionado, ele enviará uma mensagem de texto com os detalhes do alerta. Ele usa o go.gl serviço de encurtamento de URL para incluir um link para o portal para ver o recurso. |
Aplicativos Lógicos do Azure - AS2 Send Receive
|
Cria contas de integração para dois parceiros, Contoso e Fabrikam, incluindo os artefatos para parceiros e contratos. O modelo também cria aplicativos lógicos entre a Fabrikam Sales e a Contoso para demonstrar o AS2 Send Receive síncrono. O modelo também cria aplicativos lógicos entre a Fabrikam Finance e a Contoso, que demonstram o AS2 Send Receive assíncrono. |
Aplicativos Lógicos do Azure - de replicação de recuperação de desastres B2B
|
Cria aplicativos lógicos de replicação para MIC AS2, números de controle X12 gerados e recebidos. O gatilho de cada aplicativo lógico aponta para uma conta de integração de site principal. A ação de cada aplicativo lógico aponta para uma conta de integração de site secundária. |
Byod-Upload-Logic-App
|
Este modelo prevê uma configuração básica de Logic App e armazenamento de blobs para carregar ficheiros a partir do armazenamento de blobs via BYOD. |
Copiar arquivos FTP para o aplicativo lógico de Blob do Azure
|
Este modelo permite criar um acionador de aplicativo lógico em arquivos em um servidor FTP e copia-os para um contêiner de Blob do Azure. Você pode adicionar gatilhos ou ações adicionais para personalizá-lo de acordo com suas necessidades. |
Correlacionar mensagens em aplicativos lógicos usando o Service Bus
|
que mostra como podemos correlacionar mensagens em Aplicativos Lógicos usando o Barramento de Serviço do Azure |
Implantar um aplicativo lógico de exemplo, para usar como extensões personalizadas do Gerenciamento de Direitos
|
Este modelo cria um aplicativo lógico simples com todas as configurações de política de autorização, serviço agora connetion para criar tíquetes e esquema para gatilho http que é necessário para a API de extensão personalizada do Entitlement Management. |
Logic App para enviar por e-mail relatórios de backup detalhados
|
Crie um Aplicativo Lógico para enviar relatórios sobre instâncias de backup, uso, trabalhos, políticas, adesão à política e oportunidades de otimização por e-mail. |
Logic App para enviar por e-mail relatórios sobre tarefas de backup e restauração
|
Crie um aplicativo lógico para enviar relatórios sobre seus trabalhos de backup e restauração por e-mail |
Logic App para enviar relatórios por e-mail sobre a otimização de custos de backup
|
Este modelo implanta um Aplicativo Lógico que envia relatórios periódicos sobre recursos de backup inativos, possíveis otimizações de agendamento de backup e possíveis otimizações de retenção de backup para um conjunto especificado de endereços de e-mail. |
Logic App para enviar relatórios por e-mail sobre instâncias de backup
|
Criar um Aplicativo Lógico para enviar relatórios sobre instâncias de backup protegidas usando o Backup do Azure por email |
Logic App para enviar relatórios por e-mail sobre políticas de backup
|
Crie um aplicativo lógico para enviar relatórios sobre suas políticas de backup por e-mail |
Logic App para enviar relatórios por e-mail sobre a adesão à política de backup
|
Crie um aplicativo lógico para enviar relatórios sobre a adesão à política de backup de suas instâncias de backup por e-mail |
Logic App para enviar relatórios por email sobre seu de cobrança do Backup do Azure
|
Este modelo implanta um Aplicativo Lógico que envia relatórios periódicos sobre os principais parâmetros de faturamento de backup (instâncias protegidas e armazenamento em nuvem de backup consumido) em um nível de entidade de cobrança, para um conjunto especificado de endereços de e-mail. |
Logic App para enviar por e-mail relatórios resumidos sobre backups
|
Crie um aplicativo lógico para enviar relatórios resumidos sobre seus backups por e-mail. |
Recuperar chaves de acesso do Armazenamento do Azure no modelo ARM
|
Esse modelo criará uma conta de armazenamento, após a qual criará uma conexão de API recuperando dinamicamente a chave primária da conta de armazenamento. A conexão de API é então usada em um aplicativo lógico como uma sondagem de gatilho para alterações de blob. |
Execute um procedimento armazenado SQL em um agendamento por meio de um aplicativo lógico
|
Este modelo permite que você crie um Aplicativo Lógico que executará um procedimento armazenado SQL na programação. Quaisquer argumentos para o procedimento podem ser colocados na seção do corpo do modelo. |
Enviar e-mail com o aplicativo Logic
|
Este modelo permite que você crie um aplicativo lógico que envia um e-mail. Você pode adicionar gatilhos ou ações adicionais para personalizá-lo de acordo com suas necessidades. |
Para criar um recurso Microsoft.Web/connections, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Web/connections",
"apiVersion": "2016-06-01",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"api": {
"brandColor": "string",
"description": "string",
"displayName": "string",
"iconUri": "string",
"id": "string",
"name": "string",
"swagger": {},
"type": "string"
},
"changedTime": "string",
"createdTime": "string",
"customParameterValues": {
"{customized property}": "string"
},
"displayName": "string",
"nonSecretParameterValues": {
"{customized property}": "string"
},
"parameterValues": {
"{customized property}": "string"
},
"statuses": [
{
"error": {
"etag": "string",
"location": "string",
"properties": {
"code": "string",
"message": "string"
},
"tags": {
"{customized property}": "string"
}
},
"status": "string",
"target": "string"
}
],
"testLinks": [
{
"method": "string",
"requestUri": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
Microsoft.Web/conexões
| Designação |
Descrição |
Valor |
| Versão da API |
A versão api |
'2016-06-01' |
| etag |
Recurso ETag |
cadeia (de caracteres) |
| localização |
Localização do recurso |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| propriedades |
|
ApiConnectionDefinitionProperties |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. Consulte Tags em modelos |
| tipo |
O tipo de recurso |
'Microsoft.Web/conexões' |
ApiConnectionDefinitionProperties
ApiConnectionDefinitionPropertiesCustomParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionDefinitionPropertiesNonSecretParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionDefinitionPropertiesParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionTestLink
| Designação |
Descrição |
Valor |
| método |
Método HTTP |
cadeia (de caracteres) |
| URI de pedido |
URI de solicitação de link de teste |
cadeia (de caracteres) |
ApiReference
| Designação |
Descrição |
Valor |
| marcaCor |
Cor da marca |
cadeia (de caracteres) |
| Descrição |
A descrição personalizada da API |
cadeia (de caracteres) |
| nome de exibição |
O nome para exibição |
cadeia (de caracteres) |
| iconUri |
O ícone URI |
cadeia (de caracteres) |
| ID |
ID de referência do recurso |
cadeia (de caracteres) |
| Designação |
O nome da API |
cadeia (de caracteres) |
| Gingado |
A representação JSON do swagger |
qualquer |
| tipo |
Tipo de referência de recurso |
cadeia (de caracteres) |
ConnectionError
| Designação |
Descrição |
Valor |
| etag |
Recurso ETag |
cadeia (de caracteres) |
| localização |
Localização do recurso |
cadeia (de caracteres) |
| propriedades |
|
ConnectionErrorProperties |
| Etiquetas |
Tags de recursos |
TagsDicionário: |
ConnectionErrorProperties
| Designação |
Descrição |
Valor |
| código |
Código do estatuto |
cadeia (de caracteres) |
| mensagem |
Descrição do estado |
cadeia (de caracteres) |
ConnectionStatusDefinition
| Designação |
Descrição |
Valor |
| erro |
Erro de conexão |
ConnectionError |
| estado |
O status do gateway |
cadeia (de caracteres) |
| destino |
Alvo do erro |
cadeia (de caracteres) |
| Designação |
Descrição |
Valor |
| Designação |
Descrição |
Valor |
O tipo de recurso de conexões pode ser implantado com operações que visam:
-
Grupos de recursos Para uma lista das propriedades alteradas em cada versão da API, veja registo de alterações.
Exemplos de uso
Um exemplo básico de implantação do API Connection.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
provider "azurerm" {
features {
}
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "eastus"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "workflows" {
type = "Microsoft.Logic/workflows@2019-05-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
identity = {
type = "None"
userAssignedIdentities = null
}
properties = {
definition = {
"$schema" = "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#"
contentVersion = "1.0.0.0"
}
state = "Enabled"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "namespaces" {
type = "Microsoft.ServiceBus/namespaces@2022-10-01-preview"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
identity = {
type = "None"
userAssignedIdentities = null
}
properties = {
disableLocalAuth = false
minimumTlsVersion = "1.2"
premiumMessagingPartitions = 0
publicNetworkAccess = "Enabled"
}
sku = {
capacity = 0
name = "Basic"
tier = "Basic"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
data "azurerm_managed_api" "test" {
name = "servicebus"
location = var.location
depends_on = [azapi_resource.workflows, azapi_resource.namespaces]
}
resource "azapi_resource" "connection" {
type = "Microsoft.Web/connections@2016-06-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
api = {
id = data.azurerm_managed_api.test.id
}
displayName = "Service Bus"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Para criar um recurso Microsoft.Web/connections, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/connections@2016-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
api = {
brandColor = "string"
description = "string"
displayName = "string"
iconUri = "string"
id = "string"
name = "string"
swagger = ?
type = "string"
}
changedTime = "string"
createdTime = "string"
customParameterValues = {
{customized property} = "string"
}
displayName = "string"
nonSecretParameterValues = {
{customized property} = "string"
}
parameterValues = {
{customized property} = "string"
}
statuses = [
{
error = {
etag = "string"
location = "string"
properties = {
code = "string"
message = "string"
}
tags = {
{customized property} = "string"
}
}
status = "string"
target = "string"
}
]
testLinks = [
{
method = "string"
requestUri = "string"
}
]
}
}
}
Valores de propriedade
Microsoft.Web/conexões
| Designação |
Descrição |
Valor |
| etag |
Recurso ETag |
cadeia (de caracteres) |
| localização |
Localização do recurso |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| propriedades |
|
ApiConnectionDefinitionProperties |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. |
| tipo |
O tipo de recurso |
"Microsoft.Web/connections@2016-06-01" |
ApiConnectionDefinitionProperties
ApiConnectionDefinitionPropertiesCustomParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionDefinitionPropertiesNonSecretParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionDefinitionPropertiesParameterValues
| Designação |
Descrição |
Valor |
ApiConnectionTestLink
| Designação |
Descrição |
Valor |
| método |
Método HTTP |
cadeia (de caracteres) |
| URI de pedido |
URI de solicitação de link de teste |
cadeia (de caracteres) |
ApiReference
| Designação |
Descrição |
Valor |
| marcaCor |
Cor da marca |
cadeia (de caracteres) |
| Descrição |
A descrição personalizada da API |
cadeia (de caracteres) |
| nome de exibição |
O nome para exibição |
cadeia (de caracteres) |
| iconUri |
O ícone URI |
cadeia (de caracteres) |
| ID |
ID de referência do recurso |
cadeia (de caracteres) |
| Designação |
O nome da API |
cadeia (de caracteres) |
| Gingado |
A representação JSON do swagger |
qualquer |
| tipo |
Tipo de referência de recurso |
cadeia (de caracteres) |
ConnectionError
| Designação |
Descrição |
Valor |
| etag |
Recurso ETag |
cadeia (de caracteres) |
| localização |
Localização do recurso |
cadeia (de caracteres) |
| propriedades |
|
ConnectionErrorProperties |
| Etiquetas |
Tags de recursos |
TagsDicionário: |
ConnectionErrorProperties
| Designação |
Descrição |
Valor |
| código |
Código do estatuto |
cadeia (de caracteres) |
| mensagem |
Descrição do estado |
cadeia (de caracteres) |
ConnectionStatusDefinition
| Designação |
Descrição |
Valor |
| erro |
Erro de conexão |
ConnectionError |
| estado |
O status do gateway |
cadeia (de caracteres) |
| destino |
Alvo do erro |
cadeia (de caracteres) |
| Designação |
Descrição |
Valor |
| Designação |
Descrição |
Valor |