Połączenia Microsoft.Web

Definicja zasobu Bicep

Typ zasobu połączeń można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Web/connections, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Wartości właściwości

Microsoft.Web/connections

Właściwości ApiConnectionDefinitionProperties

ApiConnectionDefinitionPropertiesCustomParameterValues

ApiConnectionDefinitionPropertiesNonSecretParameterValues

ApiConnectionDefinitionPropertiesParameterValues

ApiConnectionTestLink

Odniesienie do interfejsu ApiReference

Błąd połączenia

ConnectionErrorProperties

ConnectionStatusDefinition

Słownik tagów

Słownik tagów

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Definicja zasobu szablonu usługi ARM

Typ zasobu połączeń można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Web/connections, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.Web/connections

Właściwości ApiConnectionDefinitionProperties

ApiConnectionDefinitionPropertiesCustomParameterValues

ApiConnectionDefinitionPropertiesNonSecretParameterValues

ApiConnectionDefinitionPropertiesParameterValues

ApiConnectionTestLink

Odniesienie do interfejsu ApiReference

Błąd połączenia

ConnectionErrorProperties

ConnectionStatusDefinition

Słownik tagów

Słownik tagów

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon	Opis
Alert do kolejki przy użyciu aplikacji logiki wdrażanie	Ten szablon umożliwia utworzenie aplikacji logiki z elementem webhook. Po wyzwoleniu aplikacji logiki zostanie dodany ładunek przekazywany do określonej kolejki usługi Azure Storage. Możesz dodać ten element webhook do alertu platformy Azure, a następnie za każdym razem, gdy alert zostanie wyzwolony, otrzymasz ten element w kolejce.
alert do usługi Slack z aplikacją logiki wdrażanie	Ten szablon umożliwia utworzenie aplikacji logiki, która ma element webhook do użycia z poziomu alertu platformy Azure. Po wyzwoleniu alertu zostanie wyświetlony komunikat do określonego kanału usługi Slack. Aby użyć tego szablonu, musisz mieć konto usługi Slack.
alert do wiadomości SMS z aplikacją logiki wdrażanie	Ten szablon umożliwia utworzenie aplikacji logiki, która ma element webhook do użycia z poziomu alertu platformy Azure. Po wyzwoleniu alertu zostanie wysłana wiadomość SMS ze szczegółami alertu. Używa ona go.gl usługi skracania adresu URL, aby dołączyć link do portalu, aby wyświetlić zasób.
Azure Logic Apps — as2 wysyłanie odbierania wdrażanie	Tworzy konta integracji dla dwóch partnerów, Contoso i Fabrikam, w tym artefakty dla partnerów i umów. Szablon tworzy również aplikacje logiki między firmą Fabrikam Sales i Firmą Contoso w celu zademonstrowania synchronicznego odbierania wysyłania AS2. Szablon tworzy również aplikacje logiki między firmami Fabrikam Finance i Contoso, które pokazują asynchroniczne odbieranie asynchronicznych wiadomości AS2.
Azure Logic Apps — replikacja odzyskiwania po awarii B2B wdrażanie	Tworzy replikację usługi Logic Apps for AS2 MIC, wygenerowanych i odebranych numerów kontrolnych X12. Wyzwalacz każdej aplikacji logiki wskazuje konto integracji lokacji głównej. Każda akcja aplikacji logiki wskazuje konto integracji lokacji dodatkowej.
kopiowanie plików FTP do aplikacji logiki obiektów blob platformy Azure wdrażanie	Ten szablon umożliwia tworzenie wyzwalaczy aplikacji logiki na plikach na serwerze FTP i kopiowanie ich do kontenera obiektów blob platformy Azure. Możesz dodać dodatkowe wyzwalacze lub akcje, aby dostosować je do własnych potrzeb.
korelowanie komunikatów za pośrednictwem usługi Logic Apps przy użyciu usługi Service Bus wdrażanie	który pokazuje, jak możemy skorelować komunikaty za pośrednictwem usługi Logic Apps przy użyciu usługi Azure Service Bus
Wdrażanie przykładowej aplikacji logiki do użycia jako niestandardowe rozszerzenia zarządzania upoważnieniami wdrażanie	Ten szablon tworzy prostą aplikację logiki ze wszystkimi ustawieniami zasad autoryzacji. Usługa teraz tworzy bilety i schemat wyzwalacza http, który jest wymagany przez niestandardowy interfejs API rozszerzenia zarządzania upoważnieniami.
aplikacji logiki do wiadomości e-mail ze szczegółowymi raportami kopii zapasowych wdrażanie	Utwórz aplikację logiki, aby wysyłać raporty dotyczące wystąpień kopii zapasowych, użycia, zadań, zasad, przestrzegania zasad i możliwości optymalizacji za pośrednictwem poczty e-mail.
aplikacja logiki wysyła do wiadomości e-mail raporty dotyczące zadań tworzenia kopii zapasowych i przywracania wdrażanie	Tworzenie aplikacji logiki do wysyłania raportów dotyczących zadań tworzenia kopii zapasowej i przywracania za pośrednictwem poczty e-mail
aplikacja logiki do wiadomości e-mail z raportami na temat optymalizacji kosztów tworzenia kopii zapasowych wdrażanie	Ten szablon wdraża aplikację logiki, która wysyła okresowe raporty dotyczące nieaktywnych zasobów kopii zapasowych, możliwych optymalizacji harmonogramu tworzenia kopii zapasowych i możliwych optymalizacji przechowywania kopii zapasowych do określonego zestawu adresów e-mail.
aplikacji logiki do poczty e-mail w raportach dotyczących wystąpień kopii zapasowych wdrażanie	Tworzenie aplikacji logiki do wysyłania raportów dotyczących wystąpień kopii zapasowych chronionych przy użyciu usługi Azure Backup za pośrednictwem poczty e-mail
aplikacji logiki do wiadomości e-mail z raportami dotyczącymi zasad tworzenia kopii zapasowych wdrażanie	Tworzenie aplikacji logiki do wysyłania raportów dotyczących zasad tworzenia kopii zapasowych za pośrednictwem poczty e-mail
aplikacja logiki do wiadomości e-mail z raportami na temat przestrzegania zasad kopii zapasowych wdrażanie	Tworzenie aplikacji logiki w celu wysyłania raportów dotyczących przestrzegania zasad kopii zapasowych wystąpień kopii zapasowych za pośrednictwem poczty e-mail
aplikacji logiki do obsługi poczty e-mail w raportach dotyczących rozliczeń usługi Azure Backup wdrażanie	Ten szablon wdraża aplikację logiki, która wysyła okresowe raporty dotyczące kluczowych parametrów rozliczeń kopii zapasowych (chronione wystąpienia i używany magazyn kopii zapasowych w chmurze) na poziomie jednostki rozliczeniowej do określonego zestawu adresów e-mail.
aplikacji logiki do wiadomości e-mail z podsumowaniem raportów dotyczących kopii zapasowych wdrażanie	Utwórz aplikację logiki, aby wysyłać raporty podsumowania kopii zapasowych za pośrednictwem poczty e-mail.
pobieranie kluczy dostępu usługi Azure Storage w szablonie usługi ARM wdrażanie	Ten szablon utworzy konto magazynu, po którym utworzy połączenie interfejsu API, dynamicznie pobierając klucz podstawowy konta magazynu. Połączenie interfejsu API jest następnie używane w aplikacji logiki jako wyzwalacz sondowania pod kątem zmian obiektów blob.
uruchamianie procedury składowanej SQL zgodnie z harmonogramem za pośrednictwem aplikacji logiki wdrażanie	Ten szablon umożliwia utworzenie aplikacji logiki, która będzie uruchamiać procedurę składowaną SQL zgodnie z harmonogramem. Wszelkie argumenty procedury można umieścić w sekcji treści szablonu.
Wysyłanie wiadomości e-mail przy użyciu aplikacji logiki wdrażanie	Ten szablon umożliwia utworzenie aplikacji logiki, która wysyła wiadomość e-mail. Możesz dodać dodatkowe wyzwalacze lub akcje, aby dostosować je do własnych potrzeb.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu połączeń można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Web/connections, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

Microsoft.Web/connections

Właściwości ApiConnectionDefinitionProperties

ApiConnectionDefinitionPropertiesCustomParameterValues

ApiConnectionDefinitionPropertiesNonSecretParameterValues

ApiConnectionDefinitionPropertiesParameterValues

ApiConnectionTestLink

Odniesienie do interfejsu ApiReference

Błąd połączenia

ConnectionErrorProperties

ConnectionStatusDefinition

Słownik tagów

Słownik tagów

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrożenia połączenia 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    = ["*"]
}