Udostępnij za pośrednictwem

Połączenia Microsoft.Web

  • Artykuł

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' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    api: {
      brandColor: 'string'
      description: 'string'
      displayName: 'string'
      iconUri: 'string'
      id: 'string'
      name: 'string'
      swagger: any(Azure.Bicep.Types.Concrete.AnyType)
      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

ApiConnectionDefinitionProperties

Nazwa Opis Wartość
Api ApiReference
changedTime Sygnatura czasowa ostatniej zmiany połączenia struna
createdTime Sygnatura czasowa tworzenia połączenia struna
customParameterValues Słownik niestandardowych wartości parametrów ApiConnectionDefinitionPropertiesCustomParameterValues
displayName Nazwa wyświetlana struna
nonSecretParameterValues Słownik wartości parametrów niezabezpieczonych ApiConnectionDefinitionPropertiesNonSecretParameterValues
parameterValues Słownik wartości parametrów ApiConnectionDefinitionPropertiesParameterValues
Statusy Stan połączenia ConnectionStatusDefinition[]
testLinks Linki do testowania połączenia interfejsu API ApiConnectionTestLink[]

ApiConnectionDefinitionPropertiesCustomParameterValues

Nazwa Opis Wartość

ApiConnectionDefinitionPropertiesNonSecretParameterValues

Nazwa Opis Wartość

ApiConnectionDefinitionPropertiesParameterValues

Nazwa Opis Wartość
Nazwa Opis Wartość
metoda HTTP, metoda struna
identyfikator requestUri Identyfikator URI żądania testu struna

ApiReference

Nazwa Opis Wartość
brandColor Kolor marki struna
opis Niestandardowy opis interfejsu API struna
displayName Nazwa wyświetlana struna
iconUri Identyfikator URI ikony struna
id Identyfikator odwołania do zasobu struna
nazwa Nazwa interfejsu API struna
Puszyć Reprezentacja JSON struktury Swagger dowolny
typ Typ odwołania do zasobu struna

ConnectionError

Nazwa Opis Wartość
etag Zasób ETag struna
lokalizacja Lokalizacja zasobu struna
Właściwości ConnectionErrorProperties
Tagi Tagi zasobów TagsDictionary

ConnectionErrorProperties

Nazwa Opis Wartość
kod Kod stanu struna
Komunikat Opis stanu struna

ConnectionStatusDefinition

Nazwa Opis Wartość
błąd Błąd połączenia ConnectionError
stan Stan bramy struna
cel Element docelowy błędu struna

Microsoft.Web/connections

Nazwa Opis Wartość
etag Zasób ETag struna
lokalizacja Lokalizacja zasobu struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości ApiConnectionDefinitionProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

TagsDictionary

Nazwa Opis Wartość

TagsDictionary

Nazwa Opis Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Azure Logic Apps — as2 wysyłanie odbierania 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.
kopiowanie plików FTP do aplikacji logiki obiektów blob platformy Azure 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.
pobieranie kluczy dostępu usługi Azure Storage w szablonie usługi ARM 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.

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

ApiConnectionDefinitionProperties

Nazwa Opis Wartość
Api ApiReference
changedTime Sygnatura czasowa ostatniej zmiany połączenia struna
createdTime Sygnatura czasowa tworzenia połączenia struna
customParameterValues Słownik niestandardowych wartości parametrów ApiConnectionDefinitionPropertiesCustomParameterValues
displayName Nazwa wyświetlana struna
nonSecretParameterValues Słownik wartości parametrów niezabezpieczonych ApiConnectionDefinitionPropertiesNonSecretParameterValues
parameterValues Słownik wartości parametrów ApiConnectionDefinitionPropertiesParameterValues
Statusy Stan połączenia ConnectionStatusDefinition[]
testLinks Linki do testowania połączenia interfejsu API ApiConnectionTestLink[]

ApiConnectionDefinitionPropertiesCustomParameterValues

Nazwa Opis Wartość

ApiConnectionDefinitionPropertiesNonSecretParameterValues

Nazwa Opis Wartość

ApiConnectionDefinitionPropertiesParameterValues

Nazwa Opis Wartość
Nazwa Opis Wartość
metoda HTTP, metoda struna
identyfikator requestUri Identyfikator URI żądania testu struna

ApiReference

Nazwa Opis Wartość
brandColor Kolor marki struna
opis Niestandardowy opis interfejsu API struna
displayName Nazwa wyświetlana struna
iconUri Identyfikator URI ikony struna
id Identyfikator odwołania do zasobu struna
nazwa Nazwa interfejsu API struna
Puszyć Reprezentacja JSON struktury Swagger dowolny
typ Typ odwołania do zasobu struna

ConnectionError

Nazwa Opis Wartość
etag Zasób ETag struna
lokalizacja Lokalizacja zasobu struna
Właściwości ConnectionErrorProperties
Tagi Tagi zasobów TagsDictionary

ConnectionErrorProperties

Nazwa Opis Wartość
kod Kod stanu struna
Komunikat Opis stanu struna

ConnectionStatusDefinition

Nazwa Opis Wartość
błąd Błąd połączenia ConnectionError
stan Stan bramy struna
cel Element docelowy błędu struna

Microsoft.Web/connections

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2016-06-01'
etag Zasób ETag struna
lokalizacja Lokalizacja zasobu struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości ApiConnectionDefinitionProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Web/connections"

TagsDictionary

Nazwa Opis Wartość

TagsDictionary

Nazwa Opis Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Alert do kolejki przy użyciu aplikacji logiki

wdrażanie w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 który pokazuje, jak możemy skorelować komunikaty za pośrednictwem usługi Logic Apps przy użyciu usługi Azure Service Bus
aplikacji logiki do wiadomości e-mail ze szczegółowymi raportami kopii zapasowych

wdrażanie w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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 w usłudze Azure		 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:

  • grupy zasobów

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"
  etag = "string"
  location = "string"
  body = jsonencode({
    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

ApiConnectionDefinitionProperties

Nazwa Opis Wartość
Api ApiReference
changedTime Sygnatura czasowa ostatniej zmiany połączenia struna
createdTime Sygnatura czasowa tworzenia połączenia struna
customParameterValues Słownik niestandardowych wartości parametrów ApiConnectionDefinitionPropertiesCustomParameterValues
displayName Nazwa wyświetlana struna
nonSecretParameterValues Słownik wartości parametrów niezabezpieczonych ApiConnectionDefinitionPropertiesNonSecretParameterValues
parameterValues Słownik wartości parametrów ApiConnectionDefinitionPropertiesParameterValues
Statusy Stan połączenia ConnectionStatusDefinition[]
testLinks Linki do testowania połączenia interfejsu API ApiConnectionTestLink[]

ApiConnectionDefinitionPropertiesCustomParameterValues

Nazwa Opis Wartość

ApiConnectionDefinitionPropertiesNonSecretParameterValues

Nazwa Opis Wartość

ApiConnectionDefinitionPropertiesParameterValues

Nazwa Opis Wartość
Nazwa Opis Wartość
metoda HTTP, metoda struna
identyfikator requestUri Identyfikator URI żądania testu struna

ApiReference

Nazwa Opis Wartość
brandColor Kolor marki struna
opis Niestandardowy opis interfejsu API struna
displayName Nazwa wyświetlana struna
iconUri Identyfikator URI ikony struna
id Identyfikator odwołania do zasobu struna
nazwa Nazwa interfejsu API struna
Puszyć Reprezentacja JSON struktury Swagger dowolny
typ Typ odwołania do zasobu struna

ConnectionError

Nazwa Opis Wartość
etag Zasób ETag struna
lokalizacja Lokalizacja zasobu struna
Właściwości ConnectionErrorProperties
Tagi Tagi zasobów TagsDictionary

ConnectionErrorProperties

Nazwa Opis Wartość
kod Kod stanu struna
Komunikat Opis stanu struna

ConnectionStatusDefinition

Nazwa Opis Wartość
błąd Błąd połączenia ConnectionError
stan Stan bramy struna
cel Element docelowy błędu struna

Microsoft.Web/connections

Nazwa Opis Wartość
etag Zasób ETag struna
lokalizacja Lokalizacja zasobu struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości ApiConnectionDefinitionProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Web/connections@2016-06-01"

TagsDictionary

Nazwa Opis Wartość

TagsDictionary

Nazwa Opis Wartość