Conexões Microsoft.Web

Definição de recurso do Bicep

O tipo de recurso de conexões 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.Web/connections, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.Web/connections@2016-06-01' = {
  scope: resourceSymbolicName or scope
  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/connections

ApiConnectionDefinitionProperties

ApiConnectionDefinitionPropertiesCustomParameterValues

ApiConnectionDefinitionPropertiesNonSecretParameterValues

ApiConnectionDefinitionPropertiesParameterValues

ApiConnectionTestLink

ApiReference

Erro de conexão

ConnectionErrorProperties

ConnectionStatusDefinition

TagsDicionário

TagsDicionário

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Definição de recurso de modelo do ARM

O tipo de recurso de conexões 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.Web/connections, adicione o JSON a seguir ao 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/connections

ApiConnectionDefinitionProperties

ApiConnectionDefinitionPropertiesCustomParameterValues

ApiConnectionDefinitionPropertiesNonSecretParameterValues

ApiConnectionDefinitionPropertiesParameterValues

ApiConnectionTestLink

ApiReference

Erro de conexão

ConnectionErrorProperties

ConnectionStatusDefinition

TagsDicionário

TagsDicionário

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
Alerta para fila com o aplicativo lógico	Esse modelo permite que você crie um aplicativo lógico que tenha um webhook. Quando o aplicativo lógico for disparado, ele adicionará a carga que você passar para uma fila do Armazenamento do Azure que você especificar. Você pode adicionar esse webhook a um Alerta do Azure e, sempre que o Alerta for acionado, você obterá esse item na fila.
alerta de para o Slack com o aplicativo lógico	Esse modelo permite que você crie um aplicativo lógico que tenha um webhook a ser usado a partir de um Alerta do Azure. Quando o Alerta for disparado, ele postará uma mensagem em um canal de slack que você especificar. Você precisa ter uma conta slack para usar esse modelo.
Alerta para mensagem de texto com o aplicativo lógico	Esse modelo permite que você crie um aplicativo lógico que tenha um webhook a ser usado a partir de um Alerta do Azure. Quando o Alerta for disparado, ele enviará uma mensagem de texto com os detalhes do alerta. Ele usa o serviço de redução de URL go.gl para incluir um link para o portal para ver o recurso.
Aplicativos Lógicos do Azure – as2 enviar	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 recebimento de envio as2 síncrono. O modelo também cria aplicativos lógicos entre a Fabrikam Finance e a Contoso, que demonstram o recebimento de envio assíncrono do AS2.
Aplicativos Lógicos do Azure – replicação de recuperação de desastre 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 primário. Cada ação do Aplicativo Lógico aponta para uma conta de integração de site secundária.
copiar arquivos FTP para o aplicativo lógico de Blob do Azure	Esse modelo permite que você crie um aplicativo lógico dispara em arquivos em um servidor FTP e os copia para um contêiner de Blobs do Azure. Você pode adicionar gatilhos ou ações adicionais para personalizá-lo às suas necessidades.
correlacionar mensagens em aplicativos lógicos usando do Barramento de Serviço	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 de Gerenciamento de Direitos	Esse modelo cria um aplicativo lógico simples com todas as configurações de política de autorização, o serviço agora é conivente para criar tíquetes e esquema para gatilho http que é necessário pela API de extensão personalizada do Gerenciamento de Direitos.
Aplicativo Lógico para enviar por email 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 email.
Aplicativo Lógico para enviar relatórios por email sobre trabalhos de backup e restauração	Criar um aplicativo lógico para enviar relatórios sobre seus trabalhos de backup e restauração por email
Aplicativo Lógico para enviar relatórios por email sobre de otimização de custo de backup	Esse 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 email.
Aplicativo Lógico para enviar relatórios por email em 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
Aplicativo Lógico para enviar relatórios por email sobre políticas de backup	Criar um aplicativo lógico para enviar relatórios sobre suas políticas de backup por email
Aplicativo Lógico para enviar relatórios por email sobre a adesão à política de backup	Criar um Aplicativo Lógico para enviar relatórios sobre a conformidade da política de backup de suas instâncias de backup por email
Aplicativo Lógico para enviar relatórios por email sobre o de cobrança do Backup do Azure	Esse modelo implanta um Aplicativo Lógico que envia relatórios periódicos sobre parâmetros de cobrança de backup de chave (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 email.
aplicativo lógico para enviar relatórios de resumo por email sobre backups	Crie um Aplicativo Lógico para enviar relatórios resumidos sobre seus backups por email.
Recuperar chaves de acesso do Armazenamento do Azure no modelo do 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 é usada em um Aplicativo Lógico como um gatilho de sondagem para alterações de blob.
executar um procedimento armazenado do SQL em um agendamento por meio de um aplicativo lógico	Esse modelo permite que você crie um Aplicativo Lógico que executará um procedimento armazenado do SQL no agendamento. Todos os argumentos para o procedimento podem ser colocados na seção do corpo do modelo.
Enviar email com o aplicativo lógico	Esse modelo permite que você crie um aplicativo lógico que envia um email. Você pode adicionar gatilhos ou ações adicionais para personalizá-lo às suas necessidades.

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

O tipo de recurso de conexões 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.Web/connections, adicione o Terraform a seguir 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/connections

ApiConnectionDefinitionProperties

ApiConnectionDefinitionPropertiesCustomParameterValues

ApiConnectionDefinitionPropertiesNonSecretParameterValues

ApiConnectionDefinitionPropertiesParameterValues

ApiConnectionTestLink

ApiReference

Erro de conexão

ConnectionErrorProperties

ConnectionStatusDefinition

TagsDicionário

TagsDicionário

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação da Conexão de API.

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    = ["*"]
}